將應用程式連線至 Cloud Storage for Firebase 模擬器

將應用程式連線至 Cloud Storage for Firebase 模擬器之前,請務必瞭解整體 Firebase Local Emulator Suite 工作流程,並安裝及設定 Local Emulator Suite,然後查看其 CLI 指令

選擇 Firebase 專案

Firebase Local Emulator Suite 會模擬單一 Firebase 專案的產品。

如要選取要使用的專案,請先啟動模擬器,然後在工作目錄中執行 firebase use。或者,您也可以將 --project 標記傳遞至每個模擬器指令。

Local Emulator Suite 支援模擬實際 Firebase 專案和示範專案。

專案類型 功能 搭配模擬器使用
Real

您建立及設定的 Firebase 專案 (很可能透過 Firebase 控制台) 才是實際專案。

實際專案具有即時資源,例如資料庫執行個體、儲存空間值區、函式,或是您為該 Firebase 專案設定的任何其他資源。

使用實際的 Firebase 專案時,您可以為任何或所有支援的產品執行模擬器。

對於您未模擬的任何產品,應用程式和程式碼都會與實際資源 (資料庫執行個體、儲存空間 bucket、函式等) 互動。

示範

示範 Firebase 專案沒有實際 Firebase 設定,也沒有即時資源。這些專案通常透過程式碼研究室或其他教學課程存取。

示範專案的專案 ID 前置字串為 demo-

使用 Firebase 示範專案時,應用程式和程式碼只會與模擬器互動。如果應用程式嘗試與未執行模擬器的資源互動,該程式碼就會失敗。

建議您盡可能使用範例專案。包括以下優點:

  • 設定更簡單,因為您不必建立 Firebase 專案,就能執行模擬器
  • 安全性更高,因為如果程式碼意外叫用非模擬 (正式版) 資源,就不會發生資料變更、用量和帳單問題
  • 離線支援功能更完善,因為您不需要存取網際網路即可下載 SDK 設定。

檢測應用程式,與模擬器通訊

Android、Apple 平台和 Web SDK

請按照下列方式設定應用程式內設定或測試類別,與 Cloud Storage for Firebase 模擬器互動。

Kotlin
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val storage = Firebase.storage
storage.useEmulator("10.0.2.2", 9199)
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseStorage storage = FirebaseStorage.getInstance();
storage.useEmulator("10.0.2.2", 9199);
Swift
Storage.storage().useEmulator(withHost: "127.0.0.1", port: 9199)

Web

const { getStorage, connectStorageEmulator } = require("firebase/storage");

const storage = getStorage();
if (location.hostname === "localhost") {
  // Point to the Storage emulator running on localhost.
  connectStorageEmulator(storage, "127.0.0.1", 9199);
} 

Web

var storage = firebase.storage();
if (location.hostname === "localhost") {
  // Point to the Storage emulator running on localhost.
  storage.useEmulator("127.0.0.1", 9199);
} 

如要使用模擬器測試Cloud Storage for Firebase 事件觸發的 Cloud Functions,不需要額外設定。Cloud Storage for FirebaseCloud Functions模擬器同時執行時,會自動搭配運作。

Admin SDK

設定 FIREBASE_STORAGE_EMULATOR_HOST 環境變數後,Firebase Admin SDK 會自動連線至 Cloud Storage for Firebase 模擬器:

export FIREBASE_STORAGE_EMULATOR_HOST="127.0.0.1:9199"

請注意,Cloud Functions 模擬器會自動偵測 Cloud Storage for Firebase 模擬器,因此在測試 Cloud FunctionsCloud Storage for Firebase 模擬器之間的整合時,可以略過這個步驟。系統會在 Cloud Storage for Firebase 中自動為 Admin SDK 設定環境變數。

如要讓 Admin SDK 程式碼連線至在其他環境中執行的共用模擬器,您需要指定使用 Firebase CLI 設定的相同專案 ID。您可以將專案 ID 直接傳遞至 initializeApp,或設定 GCLOUD_PROJECT 環境變數。

Node.js Admin SDK
admin.initializeApp({ projectId: "your-project-id" });
環境變數
export GCLOUD_PROJECT="your-project-id"

匯入及匯出資料

資料庫和 Cloud Storage for Firebase 模擬器可讓您從執行中的模擬器執行個體匯出資料。定義要在單元測試或持續整合工作流程中使用的基準資料集,然後匯出資料集,與團隊共用。

firebase emulators:export ./dir

在測試中,啟動模擬器時,請匯入基準資料。

firebase emulators:start --import=./dir

您可以指示模擬器在關機時匯出資料,方法是指定匯出路徑,或直接使用傳遞至 --import 旗標的路徑。

firebase emulators:start --import=./dir --export-on-exit

這些資料匯入和匯出選項也適用於 firebase emulators:exec 指令。詳情請參閱模擬器指令參考資料

Cloud Storage for Firebase模擬器與正式版有何不同

就 Firebase API 介面而言,Cloud Storage for Firebase模擬器與正式版幾乎完全一致,因此非常適合用來測試用戶端應用程式。所有 Firebase 指令都應適用於一般 Firebase SDK (網頁、Android 和 Apple 平台)。

伺服器端應用程式的測試有其限制。Firebase Admin SDK 會使用 Google Cloud API 介面,但這個 API 並非所有端點都會模擬。一般來說,凡是可透過用戶端 SDK 執行的作業 (上傳或刪除檔案、取得及設定中繼資料),也都會實作以供 Admin SDK 使用,但超出此範圍的作業則不會。以下列出重要排除項目。

與 Google Cloud Storage 的差異

Cloud Storage for Firebase產品 (包括 Storage 模擬器) 提供 Google Cloud Storage (GCS) 功能的子集,著重於儲存物件,非常適合開發 Firebase 應用程式。Cloud Storage for Firebase 與 GCS 的差異如下:

  • Cloud Storage for Firebase 目前不支援用於建立、列出、取得或刪除儲存空間 bucket 的 Bucket API。
  • Google Cloud Storage Objects API 支援下列方法:copydeletegetinsertlistpatchrewriteupdate

Cloud IAM

Firebase 模擬器套件不會嘗試複製或遵守任何 IAM 相關的執行行為。模擬器會遵守提供的 Firebase 安全性規則,但在通常會使用 IAM 的情況下 (例如設定 Cloud Functions 叫用服務帳戶,進而設定權限),模擬器無法設定,會使用開發人員電腦上全域可用的帳戶,類似於直接執行本機指令碼。

Pub/Sub 通知

Cloud Storage for Firebase 模擬器不會與 Cloud Pub/Sub 模擬器整合,因此不支援為儲存空間物件變更建立管道/通知。建議您直接使用 Cloud Functions 儲存空間觸發條件。

bucket 層級中繼資料

Cloud Storage for Firebase 模擬器不支援任何值區層級的設定,包括儲存空間類別、值區層級的 CORS 設定、標籤或保留政策。Firebase 預計會逐步改善這項支援。

後續步驟

  • 如需一系列精選影片和詳細使用說明範例,請觀看 Firebase 模擬器訓練播放清單
  • 由於觸發函式是與 Cloud Storage for Firebase 整合的典型做法,請參閱「在本機執行函式」一文,進一步瞭解 Cloud Functions for Firebase 模擬器。