在 Flutter 中建立 Cloud Storage 參考資料

檔案會儲存在 Cloud Storage bucket。這個 bucket 中的檔案會以階層結構呈現，就像本機硬碟上的檔案系統，或 Firebase 即時資料庫中的資料。建立檔案參照後，應用程式就能存取該檔案。這些參照可用於上傳或下載資料、取得或更新中繼資料，或刪除檔案。參照可以指向特定檔案，也可以指向階層中較高層級的節點。

如果您使用過 Firebase 即時資料庫，應該對這些路徑非常熟悉。不過，檔案資料會儲存在 Cloud Storage，而非 即時資料庫。

可建立參照

建立參照，即可上傳、下載或刪除檔案，或取得/更新檔案的中繼資料。參照可以視為指向雲端檔案的指標。參照相當輕量，因此您可以視需要建立任意數量的參照。此外，您也可以重複使用這些函式來執行多項作業。

使用 FirebaseStorage 單例模式執行個體建立參照，並呼叫其 ref() 方法。

final storageRef = FirebaseStorage.instance.ref();

接著，您可以使用現有參照上的 child() 方法，建立樹狀結構中較低位置的參照，例如 "images/space.jpg"。

// Create a child reference
// imagesRef now points to "images"
final imagesRef = storageRef.child("images");

// Child references can also take paths
// spaceRef now points to "images/space.jpg
// imagesRef still points to "images"
final spaceRef = storageRef.child("images/space.jpg");

您也可以使用 parent 和 root 屬性，在檔案階層中向上瀏覽。parent 會向上瀏覽一個層級，而 root 則會一路向上瀏覽至頂層。

// parent allows us to move our reference to a parent node
// imagesRef2 now points to 'images'
final imagesRef2 = spaceRef.parent;

// root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
final rootRef = spaceRef.root;

child()、parent 和 root 都是參照，因此可以多次鏈結在一起。但存取 root.parent 會導致 null。

// References can be chained together multiple times
// earthRef points to 'images/earth.jpg'
final earthRef = spaceRef.parent?.child("earth.jpg");

// nullRef is null, since the parent of root is null
final nullRef = spaceRef.root.parent;

參考屬性

您可以使用 fullPath、name 和 bucket 屬性檢查參照，進一步瞭解參照指向的檔案。這些屬性會取得檔案的完整路徑、名稱和 bucket。

// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
spaceRef.fullPath;

// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
spaceRef.name;

// Reference's bucket is the name of the storage bucket that the files are stored in
spaceRef.bucket;

參考檔案限制

參照路徑和名稱可包含任何有效的 Unicode 字元序列，但須遵守特定限制，包括：

  1. 以 UTF-8 編碼時，reference.fullPath 的總長度必須介於 1 至 1024 個位元組之間。
  2. 不含回車字元或換行字元。
  3. 請避免使用 #、[、]、* 或 ?，因為這些字元不適用於 Firebase 即時資料庫或 gsutil 等其他工具。

完整範例

// Points to the root reference
final storageRef = FirebaseStorage.instance.ref();

// Points to "images"
Reference? imagesRef = storageRef.child("images");

// Points to "images/space.jpg"
// Note that you can use variables to create child values
final fileName = "space.jpg";
final spaceRef = imagesRef.child(fileName);

// File path is "images/space.jpg"
final path = spaceRef.fullPath;

// File name is "space.jpg"
final name = spaceRef.name;

// Points to "images"
imagesRef = spaceRef.parent;

接著，我們來瞭解如何將檔案上傳至 Cloud Storage。