本文介绍Java运行时实现函数实例生命周期回调的方法。
背景信息
当您实现并配置函数实例生命周期回调后，函数计算系统将在相关实例生命周期事件发生时调用对应的回调程序。函数实例生命周期涉及Initializer、PreStop和PreFreeze三种回调。Java运行时已支持三种回调方式。更多信息，请参见函数实例生命周期回调。
函数实例生命周期回调程序与正常调用请求计费规则一致，但其执行日志只能在函数日志、实例日志或高级日志中查询，调用请求列表不会展示回调程序日志。具体操作，请参见查看实例生命周期回调函数日志。
回调方法签名
Initializer回调签名
初始化回调程序（Initializer回调）是在函数实例启动成功之后，运行请求处理程序（Handler）之前执行。函数计算保证在一个实例生命周期内，成功且只成功执行一次Initializer回调。例如您的Initializer回调第一次执行失败了，系统会重试，直到成功为止，然后再执行您的请求处理程序。因此，您在实现Initializer回调时，需要保证它被重复调用时的正确性。
Initializer回调只有一个context输入参数，使用方法同事件请求处理程序。
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方法，接口定义如下。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方法，接口定义如下。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 ...");
}
}配置生命周期回调函数
通过控制台配置
[包名].[类名]::[方法名]。示例如下：
- 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配置
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: 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配置规范，请参见Serverless Devs操作命令。
查看实例生命周期回调函数日志
您可以通过函数日志功能查看回调函数日志。
示例程序
- java11-mysql：函数计算提供的Initializer回调和PreStop回调的示例程序。
该示例为您展示了如何使用Java运行时的Initializer回调从环境变量中获取数据库配置并创建MySQL连接，以及如何使用PreStop回调负责关闭MySQL连接。