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