本文介绍Go实现函数实例生命周期回调的方法。
背景信息
当您实现并配置函数实例生命周期回调后，函数计算系统将在相关实例生命周期事件发生时调用对应的回调程序。函数实例生命周期涉及Initializer、PreFreeze和PreStop三种回调。更多信息，请参见函数实例生命周期回调。
函数实例生命周期回调程序与正常调用请求计费规则一致，但其执行日志只能在函数日志、实例日志或高级日志中查询，调用请求列表不会展示回调程序日志。具体操作，请参见查看实例生命周期回调函数日志。
回调方法签名
- 初始化回调程序（Initializer回调）是在函数实例启动成功之后，运行请求处理程序（Handler）之前执行。函数计算保证在一个实例生命周期内，成功且只成功执行一次Initializer回调。例如您的Initializer回调第一次执行失败了，系统会重试，直到成功为止，然后再执行您的请求处理程序。因此，您在实现Initializer回调时，需要保证它被重复调用时的正确性。
- 预冻结回调程序（PreFreeze回调）在函数实例冻结前执行。
- 预停止回调程序（PreStop回调）在函数实例销毁前执行。
function(ctx context.Context)回调方法实现
// 注册Initializer回调方法
fc.RegisterInitializerFunction(initialize)
// 注册PreStop回调方法
fc.RegisterPreStopFunction(preStop)
// 注册PreFreeze回调方法
fc.RegisterPreFreezeFunction(preFreeze)package main
import (
"context"
"log"
"github.com/aliyun/fc-runtime-go-sdk/fc"
"github.com/aliyun/fc-runtime-go-sdk/fccontext"
)
func HandleRequest(ctx context.Context) (string, error) {
return "hello world!", nil
}
func preStop(ctx context.Context) {
log.Print("this is preStop handler")
fctx, _ := fccontext.FromContext(ctx)
fctx.GetLogger().Infof("context: %#v\n", fctx)
}
func preFreeze(ctx context.Context) {
log.Print("this is preFreeze handler")
fctx, _ := fccontext.FromContext(ctx)
fctx.GetLogger().Infof("context: %#v\n", fctx)
}
func initialize(ctx context.Context) {
log.Print("this is initialize handler")
fctx, _ := fccontext.FromContext(ctx)
fctx.GetLogger().Infof("context: %#v\n", fctx)
}
func main() {
fc.RegisterInitializerFunction(initialize)
fc.RegisterPreStopFunction(preStop)
fc.RegisterPreFreezeFunction(preFreeze)
fc.Start(HandleRequest)
} func initialize(ctx context.Context)：Initializer回调方法。其中ctx context.Context参数提供了函数执行时的上下文信息。更多信息，请参见上下文。func preStop(ctx context.Context)：PreStop回调方法。其中ctx context.Context参数提供了函数执行时的上下文信息。更多信息，请参见上下文。func preFreeze(ctx context.Context)：PreFreeze回调方法。其中ctx context.Context参数提供了函数执行时的上下文信息。更多信息，请参见上下文。- func main()：运行FC函数代码的入口点，Go程序必须包含
main函数。通过添加代码fc.Start(HandleRequest)，设置请求处理程序的执行方法；通过添加代码fc.RegisterInitializerFunction(initialize)，注册Initializer回调方法。同理，注册PreStop和PreFreeze回调方法。重要- 上述示例仅适用于事件请求处理程序（Event Handler）。如果是HTTP请求处理程序（HTTP Handler），您需要将示例中的
fc.Start(HandleRequest)换成fc.StartHttp(HandleRequest)。 - 注册生命周期回调方法必须在
fc.Start(HandleRequest)或fc.StartHttp(HandleRequest)之前执行，否则会导致注册失败。
- 上述示例仅适用于事件请求处理程序（Event Handler）。如果是HTTP请求处理程序（HTTP Handler），您需要将示例中的
配置生命周期回调函数
通过控制台配置
在函数计算控制台的FC函数配置中，启用Initializer回调程序、PreFreeze回调程序和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两个字段。
s.yaml文件中使用默认值"true"时，必须携带双引号。
具体的示例如下所示。
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
props: # 组件的属性值
region: ${vars.region}
service: ${vars.service}
function:
name: golang-lifecycle-hook-demo
description: 'fc example by serverless devs'
runtime: go1
codeUri: ./target
handler: main
memorySize: 128
timeout: 60
initializationTimeout: 60
initializer: "true"
instanceLifecycleConfig:
preFreeze:
handler: "true"
timeout: 30
preStop:
handler: "true"
timeout: 30关于Serverless Devs的YAML配置规范，请参见Serverless Devs操作命令。
查看实例生命周期回调函数日志
您可以通过函数日志功能查看回调函数日志。
示例程序
函数计算为您提供了Initializer回调的示例程序。该示例为您展示了如何使用Go运行时的Initializer回调来初始化MySQL连接池。在本示例中，MySQL数据库配置在函数的环境变量配置中（参考s.yaml)。Initializer回调从环境变量中获取数据库配置，创建MySQL连接池并测试连通性。
更多信息，请参见go-initializer-mysql。