使用 Cloud Storage for C++ 建立 Cloud Storage 參考資料

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

如果您已使用過 Firebase 即時資料庫,應該不太熟悉這些路徑。不過,檔案資料儲存在 Cloud Storage 中,而「不是」儲存在即時資料庫中。

可建立參照

建立參照以上傳、下載或刪除檔案,或是取得或更新其中繼資料。參照可以視為雲端中檔案的指標,參照簡單,因此您可以視需要建立任意數量的參照。這些作業也能重複用於多項作業。

呼叫 GetReferenceFromUrl() 方法並傳入 gs://<your-cloud-storage-bucket> 格式的網址,即可從 Firebase 應用程式的 storage 服務建立參照。您可以在 Firebase 主控台的「Storage」區段找到此網址。

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

您也可以使用 ParentRoot 方法前往檔案階層。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();

ChildParentRoot 可以多次鏈結,因為各自會傳回參照。例外狀況是 RootParent,也就是無效的 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_pathnamebucket 方法檢查參照,進一步瞭解指向的檔案。這些方法會取得檔案的完整路徑、名稱和值區。

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

參考檔案的限制

參照路徑和名稱可包含任何序列的有效 Unicode 字元,但系統會設下某些限制:

  1. 使用 UTF-8 編碼時,reference.fullPath 的總長度必須介於 1 到 1024 個位元組之間。
  2. 不得使用回車或換行字元。
  3. 避免使用 #[]*?,因為這些工具並不適合與 Firebase 即時資料庫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。