函数实例生命周期回调_函数计算(FC)-阿里云帮助中心

本文介绍Go实现函数实例生命周期回调的方法。

背景信息

当您实现并配置函数实例生命周期回调后，函数计算系统将在相关实例生命周期事件发生时调用对应的回调程序。函数实例生命周期涉及Initializer和PreStop回调。更多信息，请参见函数实例生命周期。

函数实例生命周期回调程序与正常调用请求计费规则一致，但其执行日志只能在函数日志、实例日志或高级日志中查询，调用请求列表不会展示回调程序日志。具体操作，请参见函数实例生命周期回调。

重要

如您需要使用PreStop回调，请将fc-runtime-go-sdk升级到v0.1.0及以上版本。

回调方法签名

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

Initializer回调和PreStop回调方法签名相同，均只有一个Context输入参数，没有返回参数。定义如下：

function(ctx context.Context)

回调方法实现

在代码中实现生命周期回调方法，并使用相应函数进行注册。三种回调方法的注册方法如下：

// 注册Initializer回调方法
fc.RegisterInitializerFunction(initialize)
// 注册PreStop回调方法
fc.RegisterPreStopFunction(preStop)

示例程序如下所示。

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 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.Start(HandleRequest)
}

示例解析如下：

func initialize(ctx context.Context)：Initializer回调方法。其中ctx context.Context参数提供了函数执行时的上下文信息。更多信息，请参见上下文。
func preStop(ctx context.Context)：PreStop回调方法。其中ctx context.Context参数提供了函数执行时的上下文信息。更多信息，请参见上下文。
func main()：运行FC函数代码的入口点，Go程序必须包含main函数。通过添加代码fc.Start(HandleRequest)，设置请求处理程序的执行方法；通过添加代码 fc.RegisterInitializerFunction(initialize)，注册Initializer回调方法。注册PreStop回调方法同理。
重要
注册生命周期回调方法必须在fc.Start(HandleRequest)或fc.StartHttp(HandleRequest)之前执行，否则会导致注册失败。

配置生命周期回调函数

通过控制台配置

在函数计算控制台的FC函数配置中，启用Initializer回调程序和PreStop回调程序。示例如下。

具体步骤，请参见函数实例生命周期。

查看实例生命周期回调函数日志

您可以通过函数日志功能查看回调函数日志。

登录函数计算控制台，在左侧导航栏，单击函数。
在顶部菜单栏，选择地域，然后在函数页面，单击目标函数。

在函数详情页面，选择测试页签，单击测试函数，然后选择日志 > 函数日志。

在函数日志页签，您可以查看函数的调用日志和Initializer回调日志，示例如下。

2023-09-06 11:18:10FC Initialize Start RequestId: 1-64f7ef72-64caf1ff0046194d9a26bbd7
2023-09-06 11:18:10load code for handler:index.initialize
2023-09-06 11:18:102023-09-06 11:18:10 1-64f7ef72-64caf1ff0046194d9a26bbd7 [verbose] initializer
2023-09-06 11:18:10FC Initialize End RequestId: 1-64f7ef72-64caf1ff0046194d9a26bbd7
2023-09-06 11:18:10FC Invoke Start RequestId: 1-64f7ef72-64caf1ff0046194d9a26bbd7
2023-09-06 11:18:10load code for handler:index.handler
2023-09-06 11:18:10FC Invoke End RequestId: 1-64f7ef72-64caf1ff0046194d9a26bbd7

因为每个函数实例会缓存一段时间，不会马上销毁，因此不能立即查看PreStop回调日志。如需快速触发PreStop回调，可更新函数配置或者函数代码。更新完成后，再次查看函数日志，您可以查看PreStop回调日志。示例如下。

2023-09-06 11:08:10FC PreStop Start RequestId: 944bca62-b209-47a1-9e48-2723647bce0a
2023-09-06 11:08:10load code for handler:index.preStop
2023-09-06 11:08:102023-09-06 11:08:10 944bca62-b209-47a1-9e48-2723647bce0a [verbose] preStop
2023-09-06 11:08:10FC PreStop End RequestId: 944bca62-b209-47a1-9e48-2723647bce0a

示例程序

函数计算为您提供了Initializer回调的示例程序。该示例为您展示了如何使用Go运行时的Initializer回调来初始化MySQL连接池。在本示例中，MySQL数据库配置在函数的环境变量配置中（参考s.yaml)。Initializer回调从环境变量中获取数据库配置，创建MySQL连接池并测试连通性。

更多信息，请参见go-initializer-mysql。