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

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

背景資訊

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

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

回調方法簽名

Initializer回調簽名

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

說明

當Initializer回調程式執行逾時或失敗時，服務端始終返回HTTP 200狀態代碼，必須通過回應標頭X-Fc-Error-Type:InitializationError或響應體中的errorMessage欄位判斷是否因初始化失敗導致錯誤。

Initializer回調只有一個context輸入參數，使用方法同請求處理常式（Handler）。

使用Initializer回調需要繼承FunctionInitializer介面，並實現該介面的initialize方法，介面定義如下。

package com.aliyun.fc.runtime;

import java.io.IOException;

/**
 * This is the interface for the initialization operation
 */
public interface FunctionInitializer {

    /**
     * The interface to handle a function compute initialize request
     *
     * @param context The function compute initialize environment context object.
     * @throws IOException IOException during I/O handling
     */
    void initialize(Context context) throws IOException;
}

PreStop回調簽名

預停止回調程式（PreStop回調）在函數執行個體銷毀前執行，使用PreStop回調需要繼承PreStopHandler介面，並實現該介面的preStop方法，介面定義如下。

package com.aliyun.fc.runtime;

import java.io.IOException;

/**
 * This is the interface for the preStop operation
 */
public interface PreStopHandler {

    /**
     * The interface to handle a function compute preStop request
     *
     * @param context The function compute preStop environment context object.
     * @throws IOException IOException during I/O handling
     */
    void preStop(Context context) throws IOException;
}

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

package example;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import com.aliyun.fc.runtime.Context;
import com.aliyun.fc.runtime.StreamRequestHandler;
import com.aliyun.fc.runtime.FunctionInitializer;
import com.aliyun.fc.runtime.PreStopHandler;

public class App implements StreamRequestHandler, FunctionInitializer, PreStopHandler {
    @Override
    public void initialize(Context context) throws IOException {
        context.getLogger().info("initialize start ...");
    }

    @Override
    public void handleRequest(
            InputStream inputStream, OutputStream outputStream, Context context) throws IOException {
        context.getLogger().info("handlerRequest ...");
        outputStream.write(new String("hello world\n").getBytes());
    }

    @Override
    public void preStop(Context context) throws IOException {
        context.getLogger().info("preStop start ...");
    }
}

說明

InputStream是流式的，OutputStream不支援流式返回資料。

配置生命週期回呼函數

通過控制台配置

在Function Compute控制台的FC函數配置 > 執行個體配置中設定生命週期回調，回調格式為[包名].[類名]::[方法名]。

Initializer回調程式：設定為example.App::initialize，表示實現example包中App.java檔案裡的initialize方法。
PreStop回調程式：設定為example.App::preStop，表示實現example包中App.java檔案裡的preStop方法。

通過Serverless Devs配置

如果使用Serverless Devs工具，需要在s.yaml設定檔中添加Initializer 回調程式和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: mvn package -DskipTests
          path: ./
    props:
      region: ${vars.region}              
      functionName: "start-java-1xqf"
      description: 'hello world by serverless devs'
      runtime: "java8"
      code: ./target/HelloFCJava-1.0-SNAPSHOT-jar-with-dependencies.jar
      handler: example.App::handleRequest
      memorySize: 128
      timeout: 10
      instanceLifecycleConfig:      # 擴充函數
        initializer:                # initializer函數
          handler: example.App::initialize
          timeout: 60     
        preStop:                    # PreStop函數
          handler: example.App::preStop  # 函數入口
          timeout: 60               # 逾時時間

關於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

樣本程式

java11-mysql：Function Compute提供的Initializer回調和PreStop回調的樣本程式。
該樣本為您展示了如何使用Java運行時的Initializer回調從環境變數中擷取資料庫配置並建立MySQL串連，以及如何使用PreStop回調負責關閉MySQL串連。