本文介绍Java运行时实现函数实例生命周期回调的方法。

背景信息

当您实现并配置函数实例生命周期回调后,函数计算系统将在相关实例生命周期事件发生时调用对应的回调程序。函数实例生命周期涉及Initializer、PreStop和PreFreeze三种回调。Java运行时已支持三种回调方式。更多信息,请参见函数实例生命周期回调

回调方法签名

Initializer回调签名

初始化回调程序(Initializer回调)是在函数实例启动成功之后,运行请求处理程序(Handler)之前执行。函数计算保证在一个实例生命周期内,成功且只成功执行一次Initializer回调。例如您的Initializer回调第一次执行失败了,系统会重试,直到成功为止,然后再执行您的请求处理程序。因此,您在实现Initializer回调时,需要保证它被重复调用时的正确性。

Initializer回调只有一个context输入参数,使用方法同事件请求处理程序。

使用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;
}

PreFreeze回调签名

预冻结回调程序(PreFreeze回调)在函数实例冻结前执行,使用PreFreeze回调需要继承PreFreezeHandler接口,并实现该接口的preFreeze方法,接口定义如下。
package com.aliyun.fc.runtime;

import java.io.IOException;

/**
 * This is the interface for the preFreeze operation
 */
public interface PreFreezeHandler {

    /**
     * The interface to handle a function compute preFreeze request
     *
     * @param context The function compute preFreeze environment context object.
     * @throws IOException IOException during I/O handling
     */
    void preFreeze(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.PreFreezeHandler;
import com.aliyun.fc.runtime.PreStopHandler;

public class App implements StreamRequestHandler, FunctionInitializer, PreFreezeHandler, 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 preFreeze(Context context) throws IOException {
        context.getLogger().info("preFreeze start ...");
    }

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

配置生命周期回调函数

通过控制台配置

函数计算控制台FC函数配置中设置生命周期回调,回调格式为[包名].[类名]::[方法名]。示例如下:db_java_lifecycle
  • Initializer回调程序:设置为example.App::initialize,表示实现example包中App.java文件里的initialize方法。
  • PreFreeze回调程序:设置为example.App::preFreeze,表示实现example包中App.java文件里的preFreeze方法。
  • PreStop回调程序:设置为example.App::preStop,表示实现example包中App.java文件里的preStop方法。

通过Serverless Devs配置

如果使用Serverless Devs工具,需要在s.yaml配置文件中添加Initializer 回调程序PreFreeze 回调程序PreStop 回调程序
  • Initializer回调配置

    function配置下添加initializerinitializationTimeout两个字段。

  • PreFreeze回调配置

    function配置下添加instanceLifecycleConfig.preFreeze字段,包括handlertimeout两个字段。

  • PreStop回调配置

    function配置下添加instanceLifecycleConfig.preStop字段,包括handlertimeout两个字段。

具体的示例如下所示。

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: java8-lifecycle-hook-demo
        description: 'fc example by serverless devs'
        runtime: java8
        codeUri: ./target
        handler: example.App::handleRequest
        memorySize: 128
        timeout: 60
        initializationTimeout: 60
        initializer: example.App::initialize
        instanceLifecycleConfig:
          preFreeze:
            handler: example.App::preFreeze
            timeout: 30
          preStop:
            handler: example.App::preStop
            timeout: 30

关于Serverless Devs的YAML配置规范,请参见基本功能

示例程序

  • java11-mysql函数计算提供的Initializer回调和PreStop回调的示例程序。

    该示例为您展示了如何使用Java运行时的Initializer回调从环境变量中获取数据库配置并创建MySQL连接,以及如何使用PreStop回调负责关闭MySQL连接。