檔案會儲存在 Cloud Storage 值區中。這個值區中的檔案會以階層結構呈現,就像本機硬碟上的檔案系統,或 Firebase Realtime Database 中的資料一樣。建立檔案參照後,應用程式就能取得檔案存取權。這些參照可用於上傳或下載資料、取得或更新中繼資料,或刪除檔案。參照可以指向特定檔案,也可以指向階層中較高層級的節點。
如果您曾使用 Firebase Realtime Database,這些路徑應該會讓您覺得很熟悉。不過,您的檔案資料會儲存在 Cloud Storage 中,而非 Realtime Database。
可建立參照
建立參照,以便上傳、下載或刪除檔案,或取得或更新檔案中繼資料。您可以將參照視為指向雲端檔案的指標。參照項目的大小較小,因此您可以視需要建立多個參照項目。這些函式也可用於多項作業。
您可以透過呼叫 GetReferenceFromUrl()
方法,並傳入 gs://<your-cloud-storage-bucket>
表單的網址,從 Firebase 應用程式上的 Firebase.Storage.FirebaseStorage
服務建立參照。您可以在 Firebase 控制台的「儲存空間」部分找到這個網址。
// Get a reference to the storage service, using the default Firebase App FirebaseStorage storage = FirebaseStorage.DefaultInstance; // Create a storage reference from our storage service StorageReference storageRef = storage.GetReferenceFromUrl("gs://<your-cloud-storage-bucket>");
您可以使用現有參照的 child
方法,建立樹狀結構中較低位置的參照,例如 'images/space.jpg'
。
// Create a child reference // imagesRef now points to "images" StorageReference imagesRef = storageRef.Child("images"); // Child references can also take paths delimited by '/' such as: // "images/space.jpg". StorageReference spaceRef = imagesRef.Child("space.jpg"); // spaceRef now points to "images/space.jpg" // imagesRef still points to "images" // This is equivalent to creating the full referenced StorageReference spaceRefFull = storage.GetReferenceFromUrl( "gs://<your-cloud-storage-bucket>/images/space.jpg");
使用參照導覽
您也可以使用 Parent
和 Root
方法,在檔案階層中向上瀏覽。Parent
會向上一層瀏覽,而 Root
會一直瀏覽到頂端。
// Parent allows us to move to the parent of a reference // imagesRef now points to 'images' StorageReference imagesRef = spaceRef.Parent; // Root allows us to move all the way back to the top of our bucket // rootRef now points to the root StorageReference rootRef = spaceRef.Root;
Child
、Parent
和 Root
可以連結多次,因為每個都會傳回參照。例外狀況是 Root
的 Parent
,這是無效的 StorageReference
。
// References can be chained together multiple times // earthRef points to "images/earth.jpg" StorageReference earthRef = spaceRef.Parent.Child("earth.jpg"); // nullRef is null since the parent of root is an invalid StorageReference StorageReference nullRef = spaceRef.Root.Parent;
參考方法
您可以使用 Path
、Name
和 Bucket
屬性檢查參照項目,進一步瞭解參照項目所指向的檔案。這些屬性會取得檔案的完整路徑、名稱和值區。
// Reference's path is: "images/space.jpg" // This is analogous to a file path on disk string path = spaceRef.Path; // Reference's name is the last segment of the full path: "space.jpg" // This is analogous to the file name string name = spaceRef.Name; // Reference's bucket is the name of the storage bucket where files are stored string bucket = spaceRef.Bucket;
參考資料限制
參照路徑和名稱可包含任何有效的 Unicode 字元序列,但有以下限制:
- 以 UTF-8 編碼時,
reference.Path
的總長度必須介於 1 到 1024 個位元組之間。 - 不得使用回車或換行字元。
- 請避免使用
#
、[
、]
、*
或?
,因為這些工具無法與其他工具 (例如 Firebase Realtime Database 或 gsutil) 搭配使用。
完整範例
FirebaseStorage storage = FirebaseStorage.DefaultInstance; // Points to the root reference StorageReference storageRef = storage.GetReferenceFromUrl("gs://<your-bucket-name>"); // Points to "images" StorageReference imagesRef = storageRef.Child("images"); // Points to "images/space.jpg" // Note that you can use variables to create child values string filename = "space.jpg"; StorageReference spaceRef = imagesRef.Child(filename); // File path is "images/space.jpg" string path = spaceRef.Path; // File name is "space.jpg" string name = spaceRef.Name; // Points to "images" StorageReference imagesRef = spaceRef.Parent;
後續步驟
接下來,我們將說明如何上傳檔案至 Cloud Storage。