開始使用:編寫、測試及部署第一個函式


如要開始使用 Cloud Functions,請試著逐步進行本教學課程,一開始先完成必要的設定工作,並逐步建立、測試及部署兩個相關函式:

  • 「新增訊息」函式會公開接受文字值的網址,並將其寫入 Cloud Firestore。
  • 一個「Make 大寫」函式,在 Cloud Firestore 上觸發寫入作業並將文字轉換為大寫。

我們這次針對這個範例選擇了 Cloud Firestore 和 HTTP 觸發的 JavaScript 函式,一部分是因為這些背景觸發條件可以透過 Firebase 本機模擬器套件完整測試。這個工具集也支援即時資料庫、PubSub、驗證和 HTTP 可呼叫觸發條件。其他類型的背景觸發條件 (例如遠端設定、TestLab 和 Analytics (分析) 觸發條件) 都可以使用本頁未提及的工具集進行互動式測試

本教學課程的下列各節詳細說明建構、測試及部署範例的必要步驟。如果您只想執行程式碼檢查,請前往「 查看完整程式碼範例」。

建立 Firebase 專案

  1. Firebase 控制台,按一下「新增專案」

    • 如要在「現有的」Google Cloud 專案中新增 Firebase 資源,請輸入專案名稱,或從下拉式選單中選取該專案。

    • 輸入所需專案名稱,即可建立新專案。您也可以視需要編輯專案名稱下方的專案 ID。

  2. 出現提示訊息時,請詳閱並接受《Firebase 條款》。

  3. 點選「繼續」

  4. (選擇性步驟) 為專案設定 Google Analytics (分析),讓您使用下列任一 Firebase 產品享有最佳體驗:

    請選取現有的 Google Analytics (分析) 帳戶或建立新帳戶。

    如果您建立新帳戶,請選取 Analytics (分析) 報表位置,然後接受專案的資料共用設定和 Google Analytics (分析) 條款。

  5. 按一下「建立專案」。如果您使用現有的 Google Cloud 專案,請按一下「新增 Firebase」

Firebase 會自動為 Firebase 專案佈建資源。程序完成後,系統會將您導向 Firebase 控制台中 Firebase 專案的總覽頁面。

設定 Node.js 和 Firebase CLI

您需要 Node.js 環境才能寫入函式,另外也需要 Firebase CLI 才能將函式部署至 Cloud Functions 執行階段。如要安裝 Node.js 和 npm,建議您使用 Node 版本管理員

安裝 Node.js 與 npm 後,請透過您偏好的方法安裝 Firebase CLI。如要透過 npm 安裝 CLI,請使用:

npm install -g firebase-tools

這會安裝全球可用的 Firebase 指令。如果指令執行失敗,您可能需要變更 npm 權限。如要更新至最新版 firebase-tools,請重新執行相同的指令。

初始化您的專案

初始化 Cloud Functions 適用的 Firebase SDK 時,您會建立一個包含依附元件和一些最小程式碼範例的空白專案,並選擇 TypeScript 或 JavaScript 來建立函式。為配合本教學課程,您還需要初始化 Cloud Firestore。

如要初始化專案:

  1. 執行 firebase login,透過瀏覽器登入並驗證 Firebase CLI。
  2. 前往 Firebase 專案目錄。
  3. 執行 firebase init firestore。 在本教學課程中,您可以在系統提示輸入 Firestore 規則和索引檔案時接受預設值。如果您尚未在這項專案中使用 Cloud Firestore,也必須按照「開始使用 Cloud Firestore」中的說明,選取 Firestore 的啟動模式和位置。
  4. 執行 firebase init functions。 CLI 會提示您選擇現有程式碼集或初始化,並為新程式碼集命名。當您剛開始使用時,在預設位置只使用單一程式碼集就夠了;之後隨著實作的增加,您可以考慮在程式碼集中整理函式
  5. CLI 提供兩種語言支援選項:

    在本教學課程中,請選取「JavaScript」

  6. CLI 可讓您選擇透過 npm 安裝依附元件。如果您想以其他方式管理依附元件,可以放心拒絕。不過,如果拒絕,就需要在模擬或部署函式之前執行 npm install

成功完成這些指令後,您的專案結構將如下所示:

myproject
 +- .firebaserc    # Hidden file that helps you quickly switch between
 |                 # projects with `firebase use`
 |
 +- firebase.json  # Describes properties for your project
 |
 +- functions/     # Directory containing all your functions code
      |
      +- .eslintrc.json  # Optional file containing rules for JavaScript linting.
      |
      +- package.json  # npm package file describing your Cloud Functions code
      |
      +- index.js      # main source file for your Cloud Functions code
      |
      +- node_modules/ # directory where your dependencies (declared in
                       # package.json) are installed

在初始化期間建立的 package.json 檔案包含一個重要金鑰:"engines": {"node": "16"}。這會指定用於寫入及部署函式的 Node.js 版本。您可以選取其他支援的版本

匯入必要的模組並初始化應用程式

完成設定工作後,您可以開啟來源目錄,並按照以下各節所述的方式開始新增程式碼。在本範例中,您的專案必須使用節點 require 陳述式匯入 Cloud Functions 和 Admin SDK 模組。在 index.js 檔案中新增下列幾行內容:

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();

這些行會載入 firebase-functionsfirebase-admin 模組,並初始化 admin 應用程式執行個體,方便您從中變更 Cloud Firestore。在任何 Admin SDK 支援中,其適用於 FCM、驗證與 Firebase 即時資料庫,它提供了使用 Cloud Functions 整合 Firebase 的強大方法。

Firebase CLI 會在您初始化專案時,自動安裝 Cloud Functions 節點專用的 Firebase SDK 和 Firebase SDK。如要在專案中新增第三方程式庫,您可以修改 package.json 並執行 npm install。詳情請參閱「處理依附元件」。

新增 addMessage() 函式

針對 addMessage() 函式,在 index.js 中加入以下幾行程式碼:

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});

addMessage() 函式是 HTTP 端點。凡是對端點提出的要求,都會導致 ExpressJS 樣式的 RequestResponse 物件傳遞至 onRequest() 回呼。

HTTP 函式為同步性質 (與可呼叫的函式類似),因此您應盡快傳送回應,並使用 Cloud Firestore 延後工作。addMessage() HTTP 函式會將文字值傳遞至 HTTP 端點,並將該值插入至路徑 /messages/:documentId/original 下的資料庫。

新增 makeUppercase() 函式

針對 makeUppercase() 函式,在 index.js 中加入以下幾行程式碼:

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.log("Uppercasing", context.params.documentId, original);

    const uppercase = original.toUpperCase();

    // You must return a Promise when performing asynchronous tasks inside a Functions such as
    // writing to Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });

寫入 Cloud Firestore 時執行 makeUppercase() 函式。ref.set 函式會定義要監聽的文件。基於效能考量,請盡可能具體說明。

大括號 (例如 {documentId}) 四周是「參數」,可在回呼中公開其相符資料。

每當有新訊息時,Cloud Firestore 就會觸發 onCreate() 回呼。

Cloud Firestore 事件等事件導向函式是非同步的。回呼函式應傳回 null、物件或 Promise。如果您未傳回任何內容,函式就會逾時並表示錯誤,然後重試。請參閱「同步處理、非同步和 Promise」。

模擬函式執行作業

Firebase 本機模擬器套件可讓您在本機電腦上建構及測試應用程式,而不需部署至 Firebase 專案。強烈建議您在開發期間執行本機測試,其中一項原因是這項功能可降低編寫錯誤的風險,避免在實際工作環境中產生成本 (例如無限迴圈)。

如要模擬函式:

  1. 執行 firebase emulators:start,然後查看 Emulator Suite UI 網址的輸出內容。它預設為 localhost:4000,但可能託管於機器上的其他通訊埠。在瀏覽器中輸入該網址,開啟模擬器套件 UI。

  2. 檢查 firebase emulators:start 指令的輸出內容,以取得 HTTP 函式 addMessage() 的網址。這看起來與 http://localhost:5001/MY_PROJECT/us-central1/addMessage 類似,差別在於:

    1. 系統會將 MY_PROJECT 替換成您的專案 ID。
    2. 本機的通訊埠可能不同。
  3. 將查詢字串 ?text=uppercaseme 加到函式網址結尾。 如下所示:http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme。或者,您也可以將訊息「大寫」變更為自訂訊息。

  4. 在新分頁中開啟網址,即可建立新訊息。

  5. 在模擬器套件 UI 中查看函式的效果:

    1. 在「記錄檔」分頁中,您應該會看到新的記錄檔,指出 addMessage()makeUppercase() 函式已執行:

      i functions: Beginning execution of "addMessage"

      i functions: Beginning execution of "makeUppercase"

    2. 在「Firestore」分頁中,您應該會看到一份包含原始訊息的文件,以及訊息的大寫版本 (如果原本的格式為「大寫」,您會看到「UPPERCASEME」)。

將函式部署至實際工作環境

在模擬器中按照預期運作後,您可以繼續在實際工作環境中部署、測試及執行這些函式。請注意,如要部署至建議的 Node.js 14 執行階段環境,您的專案必須採用 Blaze 定價方案。請參閱 Cloud Functions 定價一文。

如要完成教學課程,請部署函式,然後執行 addMessage() 以觸發 makeUppercase()

  1. 執行下列指令來部署函式:

     firebase deploy --only functions
     

    執行這個指令後,Firebase CLI 會輸出所有 HTTP 函式端點的網址。終端機中應會顯示類似下列這一行文字:

    Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage
    

    這個網址包含您的專案 ID 和 HTTP 函式的區域。雖然現在並不需要擔心,但部分實際工作環境 HTTP 函式應指定位置,以盡可能減少網路延遲時間。

    如果遇到存取錯誤 (例如「無法授權存取專案」),請嘗試檢查專案別名

  2. 使用 CLI 的 addMessage() 網址輸出,新增文字查詢參數,並在瀏覽器中開啟:

    https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo
    

    這個函式會在儲存文字字串的資料庫位置執行瀏覽器,並將瀏覽器重新導向至 Firebase 控制台。這個寫入事件會觸發 makeUppercase(),以寫入字串的大寫版本。

部署及執行函式後,您可以在 Google Cloud 控制台中查看記錄檔。如需在開發或實際工作環境中刪除函式,請使用 Firebase CLI。

在實際工作環境中,建議您設定要執行的執行個體數量下限與上限,藉此最佳化功能效能並控製成本。如要進一步瞭解這些執行階段選項,請參閱「控制資源調度行為」一節。

查看完整程式碼範例

以下是含有 addMessage()makeUppercase() 函式的已完成 functions/index.js。這些函式可讓您將參數寫入 HTTP 端點,以便將值寫入 Cloud Firestore,然後用大寫字串中的所有字元進行轉換。

// The Cloud Functions for Firebase SDK to create Cloud Functions and set up triggers.
const functions = require('firebase-functions/v1');

// The Firebase Admin SDK to access Firestore.
const admin = require("firebase-admin");
admin.initializeApp();

// Take the text parameter passed to this HTTP endpoint and insert it into
// Firestore under the path /messages/:documentId/original
exports.addMessage = functions.https.onRequest(async (req, res) => {
  // Grab the text parameter.
  const original = req.query.text;
  // Push the new message into Firestore using the Firebase Admin SDK.
  const writeResult = await admin
    .firestore()
    .collection("messages")
    .add({ original: original });
  // Send back a message that we've successfully written the message
  res.json({ result: `Message with ID: ${writeResult.id} added.` });
});

// Listens for new messages added to /messages/:documentId/original and creates an
// uppercase version of the message to /messages/:documentId/uppercase
exports.makeUppercase = functions.firestore
  .document("/messages/{documentId}")
  .onCreate((snap, context) => {
    // Grab the current value of what was written to Firestore.
    const original = snap.data().original;

    // Access the parameter `{documentId}` with `context.params`
    functions.logger.log("Uppercasing", context.params.documentId, original);

    const uppercase = original.toUpperCase();

    // You must return a Promise when performing asynchronous tasks inside a Functions such as
    // writing to Firestore.
    // Setting an 'uppercase' field in Firestore document returns a Promise.
    return snap.ref.set({ uppercase }, { merge: true });
  });

後續步驟

在本說明文件中,您可以進一步瞭解如何為 Cloud Functions 管理函式,以及如何處理 Cloud Functions 支援的所有事件類型。

如要進一步瞭解 Cloud Functions,您也可以執行下列作業: