當您實現並配置函數執行個體生命週期回調後,Function Compute將在相關執行個體生命週期事件發生時調用對應的回調程式。當前,Node.js運行時支援Initializer和PreStop函數執行個體生命週期回調。
注意事項
函數執行個體生命週期回調程式與正常調用請求計費規則一致,但其執行日誌只能在函數日誌、即時日誌或進階日誌中查詢,調用請求列表不會展示回調程式日誌。具體操作,請參見查看執行個體生命週期回呼函數日誌。
Initializer回調
初始化回調程式(Initializer回調)在函數執行個體啟動成功之後,運行請求處理常式(Handler)之前執行。Function Compute保證在一個執行個體生命週期內,成功且最多成功執行一次Initializer回調。例如,您的Initializer回調第一次執行失敗後系統會重試,直到成功為止,然後再執行您的請求處理常式。
Initializer回調只有一個context輸入參數,一個最簡單的Initializer回調如下所示。
ES模組
此樣本僅支援運行在Node.js 18及以上版本的運行時環境。
export const initialize = async (context) => {
console.log('initializer');
return "";
}
CommonJS模組
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函數調用提供在調用時的運行上下文資訊。無傳回值,需要在代碼中主動調用return或callback來結束函數。
PreStop回調
預停止回調程式(PreStop回調)在函數執行個體銷毀前執行,方法簽名同Initializer回調。
一個最簡單的preStop程式如下所示。
ES模組
此樣本僅支援運行在Node.js 18及以上版本的運行時環境。
export const preStop = async (context) => {
console.log('preStop');
return "";
}
CommonJS模組
module.exports.preStop = function(context, callback){
console.log('preStop');
callback(null, "");
}
配置生命週期回呼函數
通過控制台配置
您可以在Function Compute控制台的FC函數配置中,配置Initializer 回調程式和PreStop 回調程式。具體操作步驟,請參見配置執行個體生命週期。回調格式為[檔案名稱.方法名]
,例如:
Initializer 回調程式設定為
index.initialize
,表示index.js
檔案中的initialize
方法。PreStop 回調程式設定為
index.preStop
,表示index.js
檔案中的preStop
方法。
通過Serverless Devs工具配置
如果使用Serverless Devs工具,需要在s.yaml
設定檔中添加Initializer 回調程式和PreStop 回調程式。
Initializer回調配置
在props配置下添加instanceLifecycleConfig.initializer欄位,包括handler和timeout兩個欄位。
PreStop回調配置
在props配置下添加instanceLifecycleConfig.preStop欄位,包括handler和timeout兩個欄位。
具體的樣本如下所示。
edition: 3.0.0
name: hello-world-app
access: default # 密鑰別名
resources:
hello_world:
component: fc3 # 組件名稱,Serverless Devs 工具本身類似於一種遊戲機,不具備具體的業務能力,組件類似於遊戲卡,使用者通過向遊戲機中插入不同的遊戲卡實現不同的功能,即通過使用不同的組件實現不同的具體業務能力
# actions: # 自訂執行邏輯,關於actions 的使用,可以參考:https://docs.serverless-devs.com/serverless-devs/yaml#%E8%A1%8C%E4%B8%BA%E6%8F%8F%E8%BF%B0actions
props:
region: cn-hangzhou # 關於變數的使用方法,可以參考:https://docs.serverless-devs.com/serverless-devs/yaml#%E5%8F%98%E9%87%8F%E8%B5%8B%E5%80%BC
functionName: nodejs-fc-hooks
description: "Node.js lifecycle hooks by serverless devs"
runtime: nodejs20
code: ./code
handler: index.handler
memorySize: 128
timeout: 30
instanceLifecycleConfig:
preStop:
handler: index.preStop
timeout: 3
initializer:
handler: index.initialize
timeout: 3
internetAccess: true
logConfig: auto
關於Serverless Devs的YAML配置規範,請參見Serverless Devs常用命令。
查看執行個體生命週期回呼函數日誌
您可以通過函數日誌功能查看回呼函數日誌。
登入Function Compute控制台,在左側導覽列,單擊函數。
在頂部功能表列,選擇地區,然後在函數頁面,單擊目標函數。
在函數詳情頁面,選擇測試頁簽,單擊測試函數,然後選擇 。
在函數日誌頁簽,您可以查看函數的調用日誌和Initializer回調日誌,樣本如下。
2023-09-06 11:18:10FC Initialize Start RequestId: 1-64f7ef72-64caf1ff0046194d9a26bbd7 2023-09-06 11:18:10load code for handler:index.initialize 2023-09-06 11:18:102023-09-06 11:18:10 1-64f7ef72-64caf1ff0046194d9a26bbd7 [verbose] initializer 2023-09-06 11:18:10FC Initialize End RequestId: 1-64f7ef72-64caf1ff0046194d9a26bbd7 2023-09-06 11:18:10FC Invoke Start RequestId: 1-64f7ef72-64caf1ff0046194d9a26bbd7 2023-09-06 11:18:10load code for handler:index.handler 2023-09-06 11:18:10FC Invoke End RequestId: 1-64f7ef72-64caf1ff0046194d9a26bbd7
因為每個函數執行個體會緩衝一段時間,不會馬上銷毀,因此不能立即查看PreStop回調日誌。如需快速觸發PreStop回調,可更新函數配置或者函數代碼。更新完成後,再次查看函數日誌,您可以查看PreStop回調日誌。樣本如下。
2023-09-06 11:08:10FC PreStop Start RequestId: 944bca62-b209-47a1-9e48-2723647bce0a 2023-09-06 11:08:10load code for handler:index.preStop 2023-09-06 11:08:102023-09-06 11:08:10 944bca62-b209-47a1-9e48-2723647bce0a [verbose] preStop 2023-09-06 11:08:10FC PreStop End RequestId: 944bca62-b209-47a1-9e48-2723647bce0a
樣本程式
Function Compute為您提供了使用Initializer回調和PreStop回調的MySQL樣本程式。在本樣本中,Initializer回呼函數用於從環境變數中擷取MySQL資料庫配置,建立MySQL串連並測試連通性,PreStop回呼函數負責關閉MySQL串連。
詳細資料,請參見nodejs14-mysql。
相關文檔
更多關於函數執行個體生命週期回調方法的說明,請參見配置執行個體生命週期。