函數執行個體生命週期回調方法 - Function Compute

本文介紹Node.js如何?並應用函數執行個體生命週期回調方法。

背景資訊

當您實現並配置函數執行個體生命週期回調後，Function Compute將在相關執行個體生命週期事件發生時調用對應的回調程式。當前，Node.js運行時支援Initializer、PreFreeze和PreStop三種函數執行個體生命週期回調。更多資訊，請參見函數執行個體生命週期回調。

函數執行個體生命週期回調程式與正常調用請求計費規則一致，但其執行日誌只能在函數日誌、執行個體日誌或進階日誌中查詢，調用請求列表不會展示回調程式日誌。具體操作，請參見查看執行個體生命週期回呼函數日誌。

Initializer回調

初始化回調程式（Initializer回調）在函數執行個體啟動成功之後，運行請求處理常式（Handler）之前執行。Function Compute保證在一個執行個體生命週期內，成功且最多成功執行一次Initializer回調。例如，您的Initializer回調第一次執行失敗後系統會重試，直到成功為止，然後再執行您的請求處理常式。

Initializer回調只有一個context輸入參數，使用方法和事件請求處理常式一樣。

一個最簡單的Initializer回調如下所示。

exports.initialize = function(context, callback) {
  console.log('initializer');
  callback(null, "");
};

initialize是Initializer回調方法名，需要與您在Function Compute控制台配置的Initializer 回調程式一致。例如，您為函數配置的Initializer 回調程式為index.initialize，那麼Function Compute在配置Initializer屬性後會去載入index.js中定義的initialize方法。

方法簽名

輸入參數只有context，為您的FC函數調用提供在調用時的運行上下文資訊。
無傳回值。

PreFreeze回調

預凍結回調程式（PreFreeze回調）在函數執行個體凍結前執行，方法簽名同Initializer回調。

一個最簡單的PreFreeze程式如下所示。

module.exports.preFreeze = function(context, callback) {
  console.log('preFreeze');
  callback(null, "");
};

PreStop回調

預停止回調程式（PreStop回調）在函數執行個體銷毀前執行，方法簽名同Initializer回調。

一個最簡單的preStop程式如下所示。

module.exports.preStop = function(context, callback){
  console.log('preStop');
  callback(null, "");
}

配置生命週期回呼函數

通過控制台配置

您可以在Function Compute控制台的FC函數配置中，配置Initializer 回調程式、PreFreeze 回調程式和PreStop 回調程式。具體操作步驟，請參見函數執行個體生命週期。回調格式為[檔案名稱.方法名]，例如：

Initializer 回調程式設定為index.initialize，表示index.js檔案中的initialize方法。
PreFreeze 回調程式設定為index.preFreeze，表示index.js檔案中的preFreeze方法。
PreStop 回調程式設定為index.preStop，表示index.js檔案中的preStop方法。

通過Serverless Devs工具配置

如果使用Serverless Devs工具，需要在s.yaml設定檔中添加Initializer 回調程式、PreFreeze 回調程式和PreStop 回調程式。

Initializer回調配置
在function配置下添加initializer和initializationTimeout兩個欄位。
PreFreeze回調配置
在function配置下添加instanceLifecycleConfig.preFreeze欄位，包括handler和timeout兩個欄位。
PreStop回調配置
在function配置下添加instanceLifecycleConfig.preStop欄位，包括handler和timeout兩個欄位。

具體的樣本如下所示。

edition: 1.0.0          #  命令列YAML規範版本，遵循語義化版本（Semantic Versioning）規範
name: hello-world       #  專案名稱
access: default         #  密鑰別名

services:
  fc-deploy-test: # 模組名稱
    component: devsapp/fc  # 組件名稱
    props:                 # 組件的屬性值
      region: cn-hangzhou   # 地區
      service:             # 服務配置
        name: fc-deploy-service    # service名稱
        description: dem component # Service的簡短描述
      function:                       # 函數配置
        name: fc-base-service         # function名稱
        description: 'this is test'   # function的簡短描述
        codeUri: './code'             # 代碼位置
        handler: 'index.handler'      # function執行的入口，具體格式和語言相關
        memorySize: 128               # function的記憶體規格
        runtime: nodejs14             # 運行時
        timeout: 60                   # function啟動並執行逾時時間
        initializationTimeout: 20     # 初始化方法逾時時間
        initializer: index.initialize # 初始化方法
        instanceLifecycleConfig:      # 擴充函數
          preFreeze:              # PreFreeze 函數
            handler: index.preFreeze  # 函數入口
            timeout: 60              # 逾時時間  
          preStop:                    # PreStop 函數
            handler: index.preStop    # 函數入口
            timeout: 60               # 逾時時間

關於Serverless Devs的YAML配置規範，請參見Serverless Devs常用命令。

查看執行個體生命週期回呼函數日誌

您可以通過函數日誌功能查看回呼函數日誌。

登入Function Compute控制台，在左側導覽列，單擊服務及函數。
在頂部功能表列，選擇地區，然後在服務列表頁面，單擊目標服務。
在函數管理頁面，單擊目標函數名稱，然後在函數詳情頁面，單擊測試函數頁簽。

在測試函數頁簽，單擊測試函數，然後選擇調用日誌 > 函數日誌。

在函數日誌頁簽，您可以查看函數的調用日誌、Initializer回調日誌和PreFreeze回調日誌，樣本如下。

2022-10-09 19:26:17 FunctionCompute dotnetcore3.1 runtime inited.
2022-10-09 19:26:17 FC Initialize Start RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Initialize start
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Handle initializer: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Initialize end
2022-10-09 19:26:17 FC Initialize End RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 FC Invoke Start RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Handle request: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 FC Invoke End RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 FC PreFreeze Start RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] PreFreeze start
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] Handle PreFreeze: 793ad2f1-9826-4d9a-90d9-5bf39e******
2022-10-09 19:26:17 2022-10-09 19:26:17 793ad2f1-9826-4d9a-90d9-5bf39e****** [INFO] PreFreeze end
2022-10-09 19:26:17 FC PreFreeze End RequestId: 793ad2f1-9826-4d9a-90d9-5bf39e******

因為每個函數執行個體會緩衝一段時間，不會馬上銷毀，因此不能立即查看PreStop回調日誌。如需快速觸發PreStop回調，可更新函數配置或者函數代碼。更新完成後，再次查看函數日誌，您可以查看PreStop回調日誌。樣本如下。

2022-10-09 19:32:17 FC PreStop Start RequestId: 03be685c-378b-4736-8b08-a67c1d*****
2022-10-09 19:32:17 2022-10-09 19:32:17 03be685c-378b-4736-8b08-a67c1d***** [INFO] PreStop start
2022-10-09 19:32:17 2022-10-09 19:32:17 03be685c-378b-4736-8b08-a67c1d***** [INFO] Handle PreStop: 03be685c-378b-4736-8b08-a67c1d*****
2022-10-09 19:32:17 2022-10-09 19:32:17 03be685c-378b-4736-8b08-a67c1d***** [INFO] PreStop end
2022-10-09 19:32:17 FC PreStop End RequestId: 03be685c-378b-4736-8b08-a67c1d*****

樣本程式

Function Compute為您提供了使用Initializer回調和PreStop回調的MySQL樣本程式。在本樣本中，Initializer回呼函數用於從環境變數中擷取MySQL資料庫配置，建立MySQL串連並測試連通性，PreStop回呼函數負責關閉MySQL串連。

詳細資料，請參見nodejs14-mysql。