開始在 Android 上使用 Cloud Storage

Cloud Storage for Firebase 可讓您上傳及分享使用者原創內容，例如圖片和影片，讓您在應用程式中建立多媒體內容。您的資料會儲存在 Google Cloud Storage 值區中，這是具備高可用性和全球備援機制的 EB 等級物件儲存空間解決方案。Cloud Storage for Firebase 可讓您直接透過行動裝置和網頁瀏覽器安全上傳這些檔案，輕鬆處理網路不穩定的問題。

事前準備

  1. 如果您尚未完成，請務必閱讀 Android 應用程式入門指南。包括：

    • 建立 Firebase 專案。

    • 將 Android 應用程式註冊至專案，並在應用程式中新增 Firebase 依附元件、Google 服務外掛程式和 Firebase 設定檔案 (google-services.json)，將應用程式連結至 Firebase。

  2. 請確認您的 Firebase 專案採用即付即用 Blaze 定價方案。如果您是 Firebase 和 Google Cloud 的新手，請確認您是否符合領取 $300 美元抵免額的資格。

建立預設 Cloud Storage 值區

  1. 在 Firebase 控制台的導覽窗格中，選取「儲存空間」。

    如果專案尚未採用即付即用 Blaze 定價方案，系統會提示您升級專案。

  2. 按一下「開始使用」。

  3. 選取預設值區的位置。

  4. 為預設值區設定 Firebase Security Rules。開發期間，建議您設定公開存取權規則。

  5. 按一下「完成」。

您現在可以在 Firebase 主控台的 Cloud Storage「Files」分頁中查看 bucket。預設值區名稱格式為 PROJECT_ID.firebasestorage.app。

設定公開存取權

Cloud Storage for Firebase 提供宣告式規則語言，可讓您定義資料的結構、索引方式，以及資料可讀取及寫入的時機。根據預設，Cloud Storage 的讀取和寫入權限受到限制，因此只有經過驗證的使用者才能讀取或寫入資料。如要開始使用，無須設定 Authentication，您可以設定公開存取權規則。

這會讓 Cloud Storage 對所有人開放，甚至是未使用您應用程式的使用者，因此請務必在設定驗證時再次限制 Cloud Storage。

在應用程式中加入 Cloud Storage SDK

在模組 (應用程式層級) Gradle 檔案 (通常為 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle) 中，加入 Android 的 Cloud Storage 程式庫依附元件。建議您使用 Firebase Android BoM 來控制程式庫版本。

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.6.0"))

    // Add the dependency for the Cloud Storage library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-storage")
}

只要使用 Firebase Android BoM，應用程式就會一律使用相容的 Firebase Android 程式庫版本。

(替代做法)  不使用 BoM 新增 Firebase 程式庫依附元件

如果您選擇不使用 Firebase BoM，則必須在依附元件行中指定每個 Firebase 程式庫版本。

請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您使用 BoM 來管理程式庫版本，確保所有版本皆相容。

dependencies {
    // Add the dependency for the Cloud Storage library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-storage:21.0.1")
}
想找 Kotlin 專屬的程式庫模組嗎？自 2023 年 10 月 (Firebase BoM 32.5.0)起，Kotlin 和 Java 開發人員皆可依賴主要程式庫模組 (詳情請參閱這項計畫的常見問題)。

在應用程式中設定 Cloud Storage

  1. 請確認應用程式程式碼集中的 Firebase 設定檔 (google-services.json) 已更新為預設 Cloud Storage 值區的名稱。

    1. 取得更新後的設定檔。

    2. 使用這個下載的設定檔，取代應用程式模組 (應用程式層級) 目錄中的現有 google-services.json 檔案。

      請確認應用程式中只有您最近下載的設定檔，且檔案名稱未附加額外的字元，例如 (2)。

  2. 建立 FirebaseStorage 例項，存取 Cloud Storage 值區：

    Kotlin+KTX 

    storage = Firebase.storage
    StorageActivity.kt
    // Alternatively, explicitly specify the bucket name URL.
// val storage = Firebase.storage("gs://BUCKET_NAME")

    Java 

    FirebaseStorage storage = FirebaseStorage.getInstance();
    StorageActivity.java
    // Alternatively, explicitly specify the bucket name URL.
// FirebaseStorage storage = FirebaseStorage.getInstance("gs://BUCKET_NAME");

您可以開始使用 Cloud Storage 了！

下一步？瞭解如何建立 Cloud Storage 參照。

進階設定

以下幾種用途需要額外設定：

如果您的使用者遍布全球，且希望將資料儲存在使用者附近的位置，第一種用途就非常適合。舉例來說，您可以在美國、歐洲和亞洲建立資料集，以便為這些地區的使用者儲存資料，藉此縮短延遲時間。

如果您有不同存取模式的資料，第二個用途就很實用。舉例來說，您可以設定多區域或區域值區，用來儲存相片或其他經常存取的內容，以及 Nearline 或 Coldline 值區，用來儲存使用者備份或其他不常存取的內容。

無論是哪種用途，您都應該使用多個 Cloud Storage 值區塊。

如果您要建構 Google 雲端硬碟這類應用程式，讓使用者可以登入多個帳戶 (例如個人帳戶和工作帳戶)，第三種用途就很實用。您可以使用自訂 Firebase 應用程式執行個體驗證每個額外帳戶。

使用多個 Cloud Storage 值區

如果您想使用本指南前述的預設值區以外的 Cloud Storage 值區，或是在單一應用程式中使用多個 Cloud Storage 值區，可以建立參照自訂值區的 FirebaseStorage 例項：

Kotlin+KTX 

// Get a non-default Storage bucket
val storage = Firebase.storage("gs://my-custom-bucket")
StorageActivity.kt

Java 

// Get a non-default Storage bucket
FirebaseStorage storage = FirebaseStorage.getInstance("gs://my-custom-bucket");
StorageActivity.java

使用匯入的值區

將現有的 Cloud Storage 值區匯入 Firebase 時，您必須授予 Firebase 使用 Google Cloud SDK 中的 gsutil 工具存取這些檔案的權限：

gsutil -m acl ch -r -u service-PROJECT_NUMBER@gcp-sa-firebasestorage.iam.gserviceaccount.com gs://BUCKET_NAME

您可以按照 Firebase 專案簡介中的說明，找出專案編號。

這項設定不會影響新建的值區，因為這些值區的預設存取控制項已設為允許 Firebase。這是暫時性措施，日後會自動執行。

使用自訂 Firebase 應用程式

如果您要使用自訂 FirebaseApp 建構較複雜的應用程式，可以建立 FirebaseStorage 例項，並透過該應用程式進行初始化：

Kotlin+KTX 

// Get the default bucket from a custom FirebaseApp
val storage = Firebase.storage(customApp!!)

// Get a non-default bucket from a custom FirebaseApp
val customStorage = Firebase.storage(customApp, "gs://my-custom-bucket")
StorageActivity.kt

Java 

// Get the default bucket from a custom FirebaseApp
FirebaseStorage storage = FirebaseStorage.getInstance(customApp);

// Get a non-default bucket from a custom FirebaseApp
FirebaseStorage customStorage = FirebaseStorage.getInstance(customApp, "gs://my-custom-bucket");
StorageActivity.java

後續步驟