在本機執行函式

Firebase CLI 包含 Cloud Functions 模擬器，可模擬下列函式類型：

• HTTPS 函式
• 可呼叫的函式
• 工作佇列函式
• 由 Firebase Authentication、Realtime Database、Cloud Firestore、Cloud Storage、支援的 Firebase 快訊和 Cloud Pub/Sub 觸發的背景函式。

您可以在本機環境中執行函式，以便在正式部署前進行測試。

安裝 Firebase CLI

如要使用 Cloud Functions 模擬器，請先安裝 Firebase CLI：

npm install -g firebase-tools

如要使用本機模擬器，您的 Cloud Functions 必須依附下列項目：

• firebase-admin 8.0.0 以上版本。
• firebase-functions 3.0.0 以上版本。

設定管理員憑證 (選用)

如果您希望函式測試能透過 Firebase Admin SDK 與 Google API 或其他 Firebase API 互動，可能需要設定管理員憑證。

• Cloud Firestore 和 Realtime Database 觸發事件已具備足夠的憑證，因此不需要額外設定。
• 所有其他 API (包括 Authentication 和 FCM 等 Firebase API，或 Cloud Translation 或 Cloud Speech 等 Google API) 都需要執行本節所述的設定步驟。無論您使用的是 Cloud Functions 殼層還是 firebase emulators:start，這項規則都適用。

如要為模擬函式設定管理員憑證，請按照下列步驟操作：

1. 開啟 Google Cloud 主控台的「Service Accounts」窗格。
2. 確認已選取 App Engine 預設服務帳戶，然後使用右側的選項選單選取「Create key」。
3. 系統提示時，請選取「JSON」做為金鑰類型，然後按一下「建立」。

4. 將 Google 的預設憑證指向下載的金鑰：

   Unix

   export GOOGLE_APPLICATION_CREDENTIALS="path/to/key.json"
   firebase emulators:start
   

   Windows

   set GOOGLE_APPLICATION_CREDENTIALS=path\to\key.json
   firebase emulators:start
   

完成這些步驟後，您的函式測試就能使用 Admin SDK 存取 Firebase 和 Google API。舉例來說，在測試 Authentication 觸發事件時，模擬函式可以呼叫 admin.auth().getUserByEmail(email)。

設定函式設定 (選用)

如果您使用自訂函式設定變數，請先在本機環境中執行下列指令，取得自訂設定 (請在 functions 目錄中執行此指令)：

firebase functions:config:get > .runtimeconfig.json
# If using Windows PowerShell, replace the above with:
# firebase functions:config:get | ac .runtimeconfig.json

執行模擬器套件

注意： 模擬器會自動重新載入您在有效工作階段中所做的程式碼變更。如果程式碼需要轉譯 (TypeScript、React)，請務必先執行轉譯，再執行模擬器。您可以使用 tsc -w 等指令，在監控模式下執行轉譯器，以便在儲存時自動轉譯及重新載入程式碼。

如要執行 Cloud Functions 模擬器，請使用 emulators:start 指令：

firebase emulators:start

emulators:start 指令會根據您使用 firebase init 在本機專案中初始化的產品，啟動 Cloud Functions、Cloud Firestore、即時資料庫和 Firebase 代管的模擬器。如要啟動特定模擬器，請使用 --only 標記：

firebase emulators:start --only functions

如果您想在模擬器啟動後執行測試套件或測試指令碼，請使用 emulators:exec 指令：

firebase emulators:exec "./my-test.sh"

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

如要讓應用程式與模擬器互動，您可能需要進行一些額外的設定。

檢測可呼叫的函式

如果原型和測試活動涉及可叫用的後端函式，請按照以下方式設定與 Cloud Functions 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 functions = Firebase.functions
functions.useEmulator("10.0.2.2", 5001)
MainActivity.kt

Java

// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFunctions functions = FirebaseFunctions.getInstance();
functions.useEmulator("10.0.2.2", 5001);
MainActivity.java

Swift

Functions.functions().useEmulator(withHost: "localhost", port: 5001)
ViewController.swift

Web

import { getApp } from "firebase/app";
import { getFunctions, connectFunctionsEmulator } from "firebase/functions";

const functions = getFunctions(getApp());
connectFunctionsEmulator(functions, "127.0.0.1", 5001);
fb_functions_emulator_connect.js

Web

進一步瞭解可樹狀圖分割的模組化 Web API，以及相較於命名空間 API 的優點。

firebase.functions().useEmulator("127.0.0.1", 5001);
emulator-suite.js

注意： 僅限 Android。Android 網路安全性設定政策可能會影響程式碼與 Cloud Functions 模擬器的互動方式，後者會透過未加密的 HTTP 在本機提供資料。自 Android 9 (API 級別 28) 開始，系統會預設停用明文通訊功能。您可以設定 network_security_config.xml 檔案，將 Cloud Functions 模擬器加入白名單，以便在本機上進行開發。請參閱相關的 Android 開發人員說明文件。

為應用程式檢測 HTTPS 函式模擬功能

程式碼中的每個 HTTPS 函式都會透過以下網址格式，從本機模擬器提供：

http://$HOST:$PORT/$PROJECT/$REGION/$NAME

舉例來說，如果 helloWorld 函式使用預設主機通訊埠和區域，則會在以下位置提供：

https://localhost:5001/$PROJECT/us-central1/helloWorld

為應用程式進行檢測，以模擬工作佇列功能

模擬器會根據觸發事件定義自動設定模擬工作佇列，如果管理員 SDK 偵測到模擬器是透過 CLOUD_TASKS_EMULATOR_HOST 環境變數執行，就會將排入佇列的要求重新導向至模擬器。

請注意，實際工作環境中使用的調度系統比模擬器中實作的調度系統更複雜，因此您不應期望模擬行為能精確反映實際工作環境。模擬器中的參數會提供工作調度和重試頻率的上限。

為應用程式進行檢測，模擬背景觸發的函式

Cloud Functions 模擬器支援來自下列來源的背景觸發函式：

• Realtime Database 模擬器
• Cloud Firestore 模擬器
• Authentication 模擬器
• Pub/Sub 模擬器
• Firebase 快訊模擬器

如要觸發背景事件，請使用 Emulator Suite UI 修改後端資源，或是使用平台的 SDK 將應用程式或測試程式碼連結至模擬器。

測試擴充功能發出的自訂事件處理常式

如果您實作函式來處理 Cloud Functions 第 2 版的 Firebase Extensions 自訂事件，Cloud Functions 模擬器會與 Eventarc 模擬器配對，以支援 Eventarc 觸發條件。

如要測試事件擴充功能的自訂事件處理常式，您必須安裝 Cloud Functions 和 Eventarc 模擬器。

如果 Eventarc 模擬器正在執行，Cloud Functions 執行階段會將 EVENTARC_EMULATOR 環境變數設為目前程序中的 localhost:9299。設定 EVENTARC_EMULATOR 環境變數後，Firebase Admin SDK 會自動連線至 Eventarc 模擬器。您可以按照「設定 Local Emulator Suite」一節所述修改預設通訊埠。

環境變數設定正確後，Firebase Admin SDK 就會自動將事件傳送至 Eventarc 模擬器。接著，Eventarc 模擬器會回撥至 Cloud Functions 模擬器，觸發任何已註冊的處理常式。

您可以查看 Emulator Suite UI 中的「Functions」記錄，瞭解處理程序執行的詳細資料。

與其他服務的互動

模擬器套件包含多個模擬器，可用於測試跨產品互動。

Cloud Firestore

如果函式使用 Firebase Admin SDK 寫入 Cloud Firestore，這些寫入作業會傳送至 Cloud Firestore 模擬器 (如果有在執行的話)。如果這些寫入作業觸發其他函式，這些函式會在 Cloud Functions 模擬器中執行。

Cloud Storage

如果您有使用 Firebase Admin SDK (9.7.0 以上版本) 寫入 Cloud Storage 的函式，這些寫入作業會傳送至 Cloud Storage 模擬器 (如果有在執行的話)。如果這些寫入作業觸發其他函式，這些函式會在 Cloud Functions 模擬器中執行。

Firebase Authentication

如果您有使用 Firebase Admin SDK (9.3.0 以上版本) 寫入 Firebase Authentication 的函式，這些寫入作業會傳送至正在執行的 Auth 模擬器。如果這些寫入作業觸發其他函式，這些函式會在 Cloud Functions 模擬器中執行。

Firebase 託管

如果您使用 Cloud Functions 為 Firebase Hosting 產生動態內容，firebase emulators:start 會使用本機 HTTP 函式做為代管的 Proxy。

Firebase 快訊

在任何至少包含一個支援的 Firebase 警示觸發事件的專案中，模擬器 UI 都會包含「FireAlerts」分頁。如要模擬快訊觸發事件，請按照下列步驟操作：

1. 開啟「FireAlerts」分頁。這個分頁會顯示下拉式選單，其中填入與觸發事件相關聯的警示類型 (例如，如果您有 onNewFatalIssuePublished 觸發事件，系統就會顯示 crashlytics.newFatalIssue)。
2. 選取快訊類型。表單會自動填入預設值，您可以編輯這些值。您可以編輯事件的欄位 (警示事件的其他資訊會是推測值、模擬值或隨機產生的值)。
3. 選取「Send Alert」，即可將綜合快訊傳送至函式模擬器，並在 Firebase 主控台的「Alerts」(以及記錄中) 中查看記錄。

記錄

模擬器會將函式記錄檔串流至執行函式的終端機視窗。它會在函式內顯示 console.log()、console.info()、console.error() 和 console.warn() 陳述式的所有輸出內容。

後續步驟

如需 Firebase 模擬器套件完整範例，請參閱測試快速入門範例。