Node.js 執行階段

Cloud Run 函式會在環境中執行，該環境包含作業系統版本 (附有附加套件)、語言支援，以及支援和叫用函式的 Node.js Functions Framework 程式庫。這個環境由語言版本識別，稱為執行階段 ID。

函式準備

您可以直接從 Google Cloud 控制台準備函式，也可以在本機撰寫函式並上傳。如要準備本機電腦以進行 Node.js 開發作業，請參閱「設定 Node.js 開發環境」一文。

支援的 Node.js 執行階段和基本映像檔

執行階段 執行階段 ID 堆疊 執行階段基礎映像檔
Node.js 22 nodejs22
  • google-22 (預設)
  • google-22-full
    		•
  • google-22/nodejs22
  • google-22-full/nodejs22
    		•
    Node.js 20 nodejs20
  • google-22 (預設)
  • google-22-full
    		•
  • google-22/nodejs20
  • google-22-full/nodejs20
    		•
    Node.js 18 nodejs18
  • google-22 (預設)
  • google-22-full
    		•
  • google-22/nodejs18
  • google-22-full/nodejs18
    		•
    Node.js 16 nodejs16 google-18-full google-18-full/nodejs16
    Node.js 14 nodejs14 google-18-full google-18-full/nodejs14
    Node.js 12 nodejs12 google-18-full google-18-full/nodejs12
    Node.js 10 nodejs10 google-18-full google-18-full/nodejs10
    Node.js 8 nodejs8 已停用 已停用
    Node.js 6 nodejs6 已停用 已停用

    選取執行階段

    您可以在部署期間，為函式選取其中一個支援的 Node.js 執行階段。

    您可以使用 Google Cloud 控制台或 gcloud CLI 選取執行階段版本。按一下分頁標籤，瞭解如何使用自選工具：

    gcloud

    部署函式時，請使用 --base-image 旗標指定函式的 Node.js 基礎映像檔。例如：

    gcloud run deploy FUNCTION \
    --source . \
    --function FUNCTION_ENTRYPOINT \
    --base-image nodejs22

    取代：

    • 將 FUNCTION 改為您要部署的函式名稱。您可以完全省略這個參數，但這樣系統會提示您輸入名稱。

    • FUNCTION_ENTRYPOINT，並在原始碼中輸入函式的進入點。這是 Cloud Run 在函式執行時執行的程式碼。這個旗標的值必須是來源程式碼中存在的函式名稱或完整類別名稱。

    如需使用 gcloud CLI 部署函式的詳細操作說明，請參閱「在 Cloud Run 中部署函式」。

    主控台

    在 Google Cloud 控制台中建立或更新 Cloud Run 函式時，您可以選取執行階段版本。如需部署函式的詳細操作說明，請參閱「在 Cloud Run 中部署函式」。

    如要在建立函式時，透過 Google Cloud 控制台選取執行階段，請按照下列步驟操作：

    1. 前往 Google Cloud 控制台的 Cloud Run 頁面：

      前往 Cloud Run

    2. 按一下「編寫函式」。

    3. 在「Runtime」(執行階段) 清單中，選取 Node.js 執行階段版本。

    4. 按一下「建立」，然後等待 Cloud Run 使用預留位置修訂版本建立服務。

    5. 主控台會將您重新導向至「來源」分頁，您可以在這裡查看函式的原始碼。按一下「儲存並重新部署」。

    如需函式部署後更新執行階段版本的詳細操作說明，請參閱「重新部署新的原始碼」。

    原始碼結構

    如要讓 Cloud Run 函式找到函式的定義，原始碼必須遵循特定結構。詳情請參閱「編寫 Cloud Run functions」。

    指定依附元件

    您可在 package.json 檔案列出依附元件，以便為函式指定依附元件。詳情請參閱「在 Node.js 中指定依附元件」。

    NPM 建構指令碼

    根據預設，如果 Node.js 執行階段在 package.json 中偵測到 build 指令碼，就會執行 npm run build。如要在啟動應用程式前進一步控管建構步驟，請在 package.json 檔案中新增 gcp-build 指令碼，提供自訂建構步驟。

    如要避免建構作業執行 npm run build 指令碼，請採取下列任一做法：

    • 在 package.json 檔案中新增值為空白的 gcp-build 指令碼："gcp-build":""。

    • 將建構環境變數 GOOGLE_NODE_RUN_SCRIPTS 設為空字串，防止所有指令碼執行。

    非同步函式完成

    處理涉及回呼或 Promise 物件的非同步工作時，您必須明確告知執行階段函式已完成執行這些工作。您可以透過幾種不同方式執行此操作，如下列範例所示。重點是，程式碼必須等待非同步工作或 Promise 完成，才能傳回；否則，函式的非同步元件可能會在完成前終止。

    事件導向函式

    隱含回傳

      exports.implicitlyReturning = async (event, context) => {
    return await asyncFunctionThatReturnsAPromise();
  };

    明確傳回

      exports.explicitlyReturning = function (event, context) {
    return asyncFunctionThatReturnsAPromise();
  };

    HTTP 函式

    // OK: await-ing a Promise before sending an HTTP response
await Promise.resolve();

// WRONG: HTTP functions should send an
// HTTP response instead of returning.
return Promise.resolve();

// HTTP functions should signal termination by returning an HTTP response.
// This should not be done until all background tasks are complete.
res.send(200);
res.end();

// WRONG: this may not execute since an
// HTTP response has already been sent.
return Promise.resolve();

    使用中介軟體處理 HTTP 要求

    Node.js HTTP 函式提供與 ExpressJS 相容的 request 和 response 物件，可簡化耗時的 HTTP 要求。Cloud Run functions 會自動讀取要求主體，因此無論媒體類型為何，您一律會收到要求主體。這表示，在執行程式碼時，應將 HTTP 要求視為已完全讀取。使用 ExpressJS 應用程式的巢狀結構時應注意這一點；具體而言，預期不會讀取要求主體的中介軟體可能無法如預期運作。

    使用 ES 模組

    ECMAScript 模組 (ES 模組或 ESM) 是 TC39 標準，也是 Node 14 以上版本中未標記的功能，用於載入 JavaScript 模組。與 CommonJS 不同，ESM 提供非同步 API，用於載入模組。此外，這個版本也提供熱門的語法改良功能，可搭配 import 和 export 陳述式在 Cloud Run 函式中使用 (而非 require 陳述式)。

    如要在 Cloud Run 函式中使用 ESM，您必須在 package.json 中宣告 "type": "module"。

    {
  ...
  "type": "module",
  ...
}

    然後即可使用 import 和 export 陳述式。

    進一步瞭解如何使用 ES 模組。