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

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

選擇 Firebase 專案

Firebase Local Emulator Suite 在單一 Firebase 專案中模擬產品。

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

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

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

真正的 Firebase 專案是指您建立及設定的專案 (最有可能是透過 Firebase 控制台)。

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

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

針對您並未模擬的任何產品,應用程式和程式碼將會與即時資源 (資料庫執行個體、儲存空間值區、函式等) 互動。

示範

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

示範專案的專案 ID 會加上 demo- 前置字串。

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

建議您盡可能使用示範專案。Meet 具備以下優點:

  • 設定更簡單,因為您可以不必建立 Firebase 專案,即可執行模擬器
  • 安全性更高,因為如果程式碼不小心叫用未模擬的 (實際) 資源,就不會發生資料變更、使用和帳單問題
  • 提供更完善的離線支援功能,因為您不需要連上網際網路即可下載 SDK 設定。

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

Android、Apple 平台和 Web SDK

設定應用程式內設定或測試類別,與 Cloud Storage for Firebase 模擬器互動,如下所示。

Kotlin+KTX
// 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 函式。當 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 模擬器與實際環境的差異

針對用戶端應用程式進行測試時,Cloud Storage for Firebase 模擬器在 Firebase API 介面方面幾乎與實際環境完全一致。所有 Firebase 指令都應可在一般 Firebase SDK (網頁、Android 和 Apple 平台) 之間運作。

伺服器端應用程式測試設有限制。Firebase Admin SDK 會使用 Google Cloud API 介面,而非這個 API 的所有端點。一般來說,只要是用戶端 SDK 可執行的操作 (上傳或刪除檔案、取得及設定中繼資料),也都能透過 Admin SDK 實作,但其他操作則無法。以下列出重要的排除條件。

與 Google Cloud Storage 的差異

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

  • Cloud Storage for Firebase 目前不支援 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 Storage 觸發條件。

值區層級中繼資料

Cloud Storage for Firebase 模擬器不支援任何值區層級設定,包括儲存空間類別、值區層級 CORS 設定、標籤或保留政策。Firebase 希望持續改善這項支援功能。

後續步驟