了解 2023 年 Google I/O 大会上介绍的 Firebase 亮点。了解详情

本頁面由 Cloud Translation API 翻譯而成。

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

如要開始使用 Cloud Functions，請試著參加本教學課程第一步是完成必要的設定工作，並完成建立、測試及部署兩個相關函式：

「新增訊息」函式，提供接受文字值的網址，並寫入至 Cloud Firestore
「提升大寫」在 Cloud Firestore 寫入及轉換時觸發的函式請將文字轉換為大寫

我們為這項解決方案選擇了 Cloud Firestore 和 HTTP 觸發的 JavaScript 函式這是因為這些背景觸發條件可經由完整測試透過 Firebase 本機模擬器套件。這個工具組也支援即時資料庫 PubSub、Auth 和 HTTP 可呼叫觸發條件。其他類型的背景觸發條件例如遠端設定、TestLab 和 Analytics 觸發條件使用工具組進行交互測試加以說明。

本教學課程的下列各節將詳細說明建構步驟、測試及部署範例如果您只想執行程式碼並加以檢查跳至「查看完整程式碼範例」。

建立 Firebase 專案

在 Firebase 控制台，按一下「新增專案」。
- 如要將 Firebase 資源新增至現有的 Google Cloud 專案，請輸入或從下拉式選單中選取專案
- 如要建立新專案，請輸入所需專案名稱。您也可以選擇編輯顯示在專案名稱下方的專案 ID。
  
  Firebase 會為您的 Firebase 專案產生專屬 ID 建立起關係如要編輯這個專案 ID，您必須立即執行這項作業，因為 Firebase 為專案。前往瞭解 Firebase 專案，以便：瞭解 Firebase 如何使用專案 ID。
如果出現提示訊息，請詳閱並接受 Firebase 條款。
點選「繼續」。

(選用) 為專案設定 Google Analytics，，使用下列任一 Firebase 產品來獲得最佳體驗：

選取現有項目 Google Analytics 帳戶或建立新帳戶

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

按一下「建立專案」。如果使用「新增 Firebase」，或現有 Google Cloud 專案

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，請再次執行相同的指令。

許多情況下，新功能和錯誤修正都會僅適用於最新版本的 Firebase CLI 和 firebase-functions SDK。建議您經常使用下列指令來更新 Firebase CLI 和 SDK 請在 Firebase 專案的 functions 資料夾中：

npm install firebase-functions@latest firebase-admin@latest --save
npm install -g firebase-tools

初始化您的專案

初始化 Cloud Functions 的 Firebase SDK 時，會建立空白專案包含依附元件和最少的程式碼範例編寫函式的 TypeScript 或 JavaScript。為了便於教學課程中，您也需要初始化 Cloud Firestore。

如要初始化專案：

執行 firebase login 透過瀏覽器登入並驗證 Firebase CLI
前往 Firebase 專案目錄。
執行 firebase init firestore。在本教學課程中，您可以接受預設值並在系統提示時輸入 Firestore 規則和索引檔案的值如果沒用過這項專案中的 Cloud Firestore 必須按照開始使用 Cloud Firestore。
執行 firebase init functions。 CLI 會提示您選擇現有項目或是初始化並命名新的程式碼集。才剛開始只需在預設位置僅保留一個程式碼集即可；隨著實作範圍擴大要在程式碼集中整理函式。
CLI 提供兩種語言支援選項：
- JavaScript
- TypeScript 請參閱「使用 TypeScript 編寫函式」一文瞭解詳情
在本教學課程中，請選取「JavaScript」。
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"}。這會指定讓您快速編寫及部署函式你可以選取其他支援的版本。

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

完成設定工作後，您可以：開啟來源目錄，並開始新增程式碼，方法如後續章節。在本範例中，您的專案必須匯入使用節點 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();index.js

這些程式碼會載入 firebase-functions 和 firebase-admin 模組，初始化可進行 Cloud Firestore 變更的 admin 應用程式執行個體。凡是提供 Admin SDK 支援服務的國家/地區適用於 FCM、驗證和 Firebase 即時資料庫以強大的 Cloud Functions 整合 Firebase。

Firebase CLI 會自動套用初始化時，安裝 Cloud Functions 節點適用的 Firebase 和 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.` });
});index.js

addMessage() 函式是 HTTP 端點。任何傳送至端點的要求 ExpressJS 樣式的結果要求和回應再傳送至 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 });
  });index.js

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

括號，例如 {documentId}，周圍是「參數」。萬用字元，在回呼中公開相符的資料。

Cloud Firestore 會觸發 onCreate() 回呼。

事件導向函式 (例如 Cloud Firestore 事件) 非同步顯示回呼函式應傳回 null、物件、或 Promise。如果您沒有傳回任何值，函式就會逾時、表示錯誤，以及重試。請參閱同步處理、非同步和 Promise。

模擬函式的執行作業

Firebase 本機模擬器套件可讓您在本機電腦上建構及測試應用程式，不必部署到 Firebase 專案強烈建議您在開發期間進行本機測試一部分，因為這樣可以降低編寫錯誤而失敗在正式環境中產生費用 (例如無限迴圈)。

如要模擬函式：

執行 firebase emulators:start 並檢查網址的輸出內容模擬器套件使用者介面預設值為 localhost:4000，但也可能由不同的主機代管的 IP 位址在瀏覽器中輸入該網址即可開啟模擬器套件 UI。
查看 firebase emulators:start 的輸出內容指令 HTTP 函式 addMessage()看起來會像這樣 http://localhost:5001/MY_PROJECT/us-central1/addMessage，但以下情況除外：
1. 系統會將 MY_PROJECT 替換為您的專案 ID。
2. 本機電腦上的通訊埠可能不同。
將查詢字串 ?text=uppercaseme 加到函式網址的結尾。如下所示： http://localhost:5001/MY_PROJECT/us-central1/addMessage?text=uppercaseme。您可以視需要變更訊息「大寫」自訂 IP 位址撰寫新的電子郵件訊息
在瀏覽器中開啟新分頁，建立新的訊息。
在模擬器套件 UI 中查看函式的效果：
1. 「記錄檔」分頁中應該會顯示新的記錄檔，說明函式「addMessage()」和「makeUppercase()」已執行：
  
  i functions: Beginning execution of "addMessage"
  
  i functions: Beginning execution of "makeUppercase"
2. 「Firestore」分頁中應會顯示一份含有原始檔案的文件訊息及大寫版本 (如果有的話) 您會看到「大寫」。

將函式部署至正式環境

所需函式在模擬器中正常運作後，即可繼續包括在正式環境中部署、測試及執行注意事項部署至建議的 Node.js 14 執行階段環境必須採用 Blaze 定價方案。詳情請見 Cloud Functions 定價。

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

執行下列指令來部署函式：
```
 firebase deploy --only functions
 
```
執行這個指令後，Firebase CLI 會輸出任何 HTTP 函式端點。終端機中應該會顯示類似下方的行：
```
Function URL (addMessage): https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage
```
該網址包含您的專案 ID 和 HTTP 區域函式。雖然您現在不需擔心函式應將位置指定為盡可能縮短網路延遲時間

如果發生存取錯誤，例如「無法授權存取「專案」請檢查您的專案別名。
使用 CLI 的 addMessage() 網址輸出，新增文字查詢參數。然後在瀏覽器中開啟：
```
https://us-central1-MY_PROJECT.cloudfunctions.net/addMessage?text=uppercasemetoo
```
函式會執行，並將瀏覽器重新導向至資料庫位置的 Firebase 控制台 (儲存文字字串的位置)。這個寫入事件觸發 makeUppercase()，寫入大寫寫入程序字串版本。

部署及執行函式後請在 Google Cloud 控制台中查看記錄檔。需要刪除函式請使用 Firebase CLI

在實際工作環境中，建議您最佳化函式效能和控管機制設定要執行的執行個體數量上下限。詳情請見控管資源調度行為進一步瞭解這些執行階段選項

查看完整程式碼範例

以下是包含函式的已完成 functions/index.js addMessage()和makeUppercase()。這些函式可讓您將參數加入 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 });
  });index.js

後續步驟

這份說明文件可協助您進一步瞭解如何為 Cloud Functions 管理函式以及如何來處理 Cloud Functions 支援的所有事件類型。

如要進一步瞭解 Cloud Functions 也可以進行下列操作：