配置回呼函數對函數執行個體生命週期關鍵點進行精細化控制 - Function Compute

本文介紹C#運行時實現函數執行個體生命週期回調的方法。

背景資訊

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

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

回調方法簽名

初始化回調程式（Initializer回調）
在函數執行個體啟動成功之後，運行請求處理常式（Handler）之前執行。Function Compute保證在一個執行個體生命週期內，成功且只成功執行一次Initializer回調。如果您的Initializer回調第一次執行失敗，那麼此次函數調用直接返回失敗，下次調用時，會再建立一個函數執行個體執行initializer回調。
預停止回調程式（PreStop回調）
在函數執行個體銷毀前執行。

C#的Initializer回調和PreStop回調方法簽名相同，均只有一個Context輸入參數，沒有返回參數。定義如下。

public void FunctionName(IFcContext context);

您也可以將回調方法設定為靜態方法，定義如下。

public static void FunctionName(IFcContext context);

簡單樣本：流式事件請求處理常式

以下範例程式碼展示一個簡單的包含Initializer回調和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 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::Initialize
PreStop回調程式：HelloFcApp::Example.Hello::PreStop

通過Serverless Devs配置

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

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

具體樣本如下所示。

# ------------------------------------
#   官方手冊: https://manual.serverless-devs.com/user-guide/aliyun/#fc3
#   常見小貼士: https://manual.serverless-devs.com/user-guide/tips/
#   有問題快來DingTalk群問一下吧：33947367
# ------------------------------------
edition: 3.0.0
name: hello-world-app
access: "default"

vars: # 全域變數
  region: "cn-hangzhou"

resources:
  hello_world:
    component: fc3 
    actions:       
      pre-${regex('deploy|local')}: 
        - run: dotnet publish -c Release -o ./target
          path: ./HelloWorldApp
    props:
      region: ${vars.region}              
      functionName: "start-dotnetcore-p6jp"
      description: 'hello world by serverless devs'
      runtime: "dotnetcore3.1"
      code: ./HelloWorldApp/target/
      handler: HelloWorldApp::Example.Hello::StreamHandler
      memorySize: 128
      timeout: 10
      instanceLifecycleConfig:      # 擴充函數
        initializer:                # initializer函數
          handler: HelloFcApp::Example.Hello::Initialize
          timeout: 60     
        preStop:                    # PreStop函數
          handler: HelloFcApp::Example.Hello::PreStop  # 函數入口
          timeout: 60               # 逾時時間    
      # triggers:
      #   - triggerName: httpTrigger # 觸發器名稱
      #     triggerType: http # 觸發器類型
      #     description: 'xxxx'
      #     qualifier: LATEST # 觸發服務的版本
      #     triggerConfig:
      #       authType: anonymous # 鑒權類型，可選值：anonymous、function
      #       disableURLInternet: false # 是否禁用公網存取 URL
      #       methods: # HTTP 觸發器支援的存取方法，可選值：GET、POST、PUT、DELETE、HEAD
      #         - GET
      #         - POST

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

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

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

登入Function Compute控制台，在左側導覽列，單擊函數。
在頂部功能表列，選擇地區，然後在函數頁面，單擊目標函數。

在函數詳情頁面，選擇測試頁簽，單擊測試函數，然後選擇日誌 > 函數日誌。

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

2024-03-04 17:57:28FC Initialize Start RequestId: 1-65e59b07-1520da26-bf73bbb91b69
2024-03-04 17:57:282024-03-04 09:57:28.192 1-65e59b07-1520da26-bf73bbb91b69 [info] initializer
2024-03-04 17:57:28FC Initialize End RequestId: 1-65e59b07-1520da26-bf73bbb91b69
2024-03-04 17:57:28FC Invoke Start RequestId: 1-65e59b07-1520da26-bf73bbb91b69
2024-03-04 17:57:28FC Invoke End RequestId: 1-65e59b07-1520da26-bf73bbb91b69

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

2024-03-04 18:33:26FC PreStop Start RequestId: 93c93603-9fbe-4576-9458-193c8b213031
2024-03-04 18:33:262024-03-04 10:33:26.077 93c93603-9fbe-4576-9458-193c8b213031 [info] preStop
2024-03-04 18:33:26FC PreStop End RequestId: 93c93603-9fbe-4576-9458-193c8b213031