在 Flutter 中建立 Cloud Storage 參考資料

檔案會儲存在 Cloud Storage 值區中。這個值區中的檔案會以階層結構呈現,就像本機硬碟上的檔案系統,或 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");

您也可以使用 parentroot 屬性,在檔案階層中向上瀏覽。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()parentroot 可以連結多次,因為每個都是參照。但在 null 中存取 root.parent 結果。

// 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;

參照屬性

您可以使用 fullPathnamebucket 屬性檢查參照,以便進一步瞭解參照所指向的檔案。這些屬性會取得檔案的完整路徑、名稱和值區。

// 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。