檔案會儲存在 Cloud Storage bucket。這個 bucket 中的檔案會以階層結構呈現,就像本機硬碟上的檔案系統,或 Firebase Realtime Database 中的資料。建立檔案參照後,應用程式就能存取該檔案。這些參照可用於上傳或下載資料、取得或更新中繼資料,或刪除檔案。參照可以指向特定檔案,也可以指向階層中較高層級的節點。
如果您曾使用 Firebase Realtime Database,應該對這些路徑非常熟悉。不過,檔案資料會儲存在 Cloud Storage,而「不是」Realtime Database。
可建立參照
建立參照,即可上傳、下載或刪除檔案,或取得/更新檔案的中繼資料。參照可以視為指向雲端檔案的指標。參照相當輕量,因此您可以視需要建立多個參照。此外,這類物件可重複用於多項作業。
如要建立參照,請在 Firebase 應用程式上呼叫 Firebase.Storage.FirebaseStorage 服務的 GetReferenceFromUrl() 方法,並傳入 gs://<your-cloud-storage-bucket> 格式的網址。您可以在 Firebase 控制台的「Storage」(儲存空間) 專區找到這個網址。
// 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 字元序列,但須遵守特定限制,包括:
reference.Path的總長度必須介於 1 到 1024 個位元組之間 (採用 UTF-8 編碼)。- 不含回車字元或換行字元。
- 請避免使用
#、[、]、*或?,因為這些指令無法與 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。