本文介紹C#運行時實現函數執行個體生命週期回調的方法。
背景資訊
當您實現並配置函數執行個體生命週期回調後,Function Compute將在相關執行個體生命週期事件發生時調用對應的回調程式。函數執行個體生命週期涉及Initializer、PreStop和PreFreeze三種回調,C#運行時已支援此三種回調。更多資訊,請參見函數執行個體生命週期。
函數執行個體生命週期回調程式與正常調用請求計費規則一致,但其執行日誌只能在函數日誌、執行個體日誌或進階日誌中查詢,調用請求列表不會展示回調程式日誌。具體操作,請參見查看執行個體生命週期回呼函數日誌。
回調方法簽名
初始化回調程式(Initializer回調)
在函數執行個體啟動成功之後,運行請求處理常式(Handler)之前執行。Function Compute保證在一個執行個體生命週期內,成功且只成功執行一次Initializer回調。如果您的Initializer回調第一次執行失敗,那麼此次函數調用直接返回失敗,下次調用時,會再建立一個函數執行個體執行Initializer回調。
預凍結回調程式(PreFreeze回調)
在函數執行個體凍結前執行。
預停止回調程式(PreStop回調)
在函數執行個體銷毀前執行。
C#的Initializer回調、PreFreeze回調和PreStop回調方法簽名相同,均只有一個Context輸入參數,沒有返回參數。定義如下。
public void FunctionName(IFcContext context);您也可以將回調方法設定為靜態方法,定義如下。
public static void FunctionName(IFcContext context);簡單樣本:流式事件請求處理常式
以下範例程式碼展示一個簡單的包含Initializer回調、PreFreeze回調和PreStop回調的程式。
using System;
using System.IO;
using System.Threading.Tasks;
using Aliyun.Serverless.Core;
using Microsoft.Extensions.Logging;
namespace Example
{
public class Hello
{
public void Initialize(IFcContext context)
{
IFcLogger logger = context.Logger;
logger.LogInformation("Initialize start");
logger.LogInformation("Handle initializer: {0}", context.RequestId);
logger.LogInformation("Initialize end");
}
public void PreStop(IFcContext context)
{
IFcLogger logger = context.Logger;
logger.LogInformation("PreStop start");
logger.LogInformation("Handle PreStop: {0}", context.RequestId);
logger.LogInformation("PreStop end");
}
public void PreFreeze(IFcContext context)
{
IFcLogger logger = context.Logger;
logger.LogInformation("PreFreeze start");
logger.LogInformation("Handle PreFreeze: {0}", context.RequestId);
logger.LogInformation("PreFreeze end");
}
public async Task<Stream> StreamHandler(Stream input, IFcContext context)
{
IFcLogger logger = context.Logger;
logger.LogInformation("Handle request: {0}", context.RequestId);
MemoryStream copy = new MemoryStream();
await input.CopyToAsync(copy);
copy.Seek(0, SeekOrigin.Begin);
return copy;
}
static void Main(string[] args){}
}
}配置生命週期回呼函數
通過控制台配置
在Function Compute控制台的函數配置中設定生命週期回調,具體操作,請參見函數執行個體生命週期。回調方法的格式和請求處理常式的格式相同,為程式集名稱::命名空間.類名::方法名。更多資訊,請參見請求處理常式(Handler)。
樣本如下。
Initializer回調程式:
HelloFcApp::Example.Hello::InitializePreFreeze回調程式:
HelloFcApp::Example.Hello::PreFreezePreStop回調程式:
HelloFcApp::Example.Hello::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
name: hello-world # 專案名稱
access: default # 密鑰別名
vars: # 全域變數
region: cn-shanghai # 地區
service:
name: fc-example
description: 'fc example by serverless devs'
services:
helloworld: # 業務名稱/模組名稱
component: fc
actions: # 自訂執行邏輯
pre-deploy: # 在deploy之前運行
- run: mvn package # 要啟動並執行命令列
path: ./ # 命令列啟動並執行路徑
props: # 組件的屬性值
region: ${vars.region}
service: ${vars.service}
function:
name: dotnet-lifecycle-hook-demo
description: 'fc example by serverless devs'
runtime: dotnetcore3.1
codeUri: ./target
handler: example.App::handleRequest
memorySize: 128
timeout: 60
initializer: HelloFcApp::Example.Hello::Initialize
initializationTimeout: 30
instanceLifecycleConfig:
preStop:
Handler: HelloFcApp::Example.Hello::PreStop
Timeout: 30
preFreeze:
Handler: HelloFcApp::Example.Hello::PreFreeze
Timeout: 30關於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*****