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

背景信息

当您实现并配置函数实例生命周期回调后,函数计算系统将在相关实例生命周期事件发生时调用对应的回调程序。函数实例生命周期涉及Initializer、PreFreeze和PreStop三种回调。更多信息,请参见函数实例生命周期回调
注意 如您需要使用PreFreeze和PreStop回调,请将fc-runtime-go-sdk升级到v0.1.0及以上版本。

回调方法签名

  • 初始化回调程序(Initializer回调)是在函数实例启动成功之后,运行请求处理程序(Handler)之前执行。函数计算保证在一个实例生命周期内,成功且只成功执行一次Initializer回调。例如您的Initializer回调第一次执行失败了,系统会重试,直到成功为止,然后再执行您的请求处理程序。因此,您在实现Initializer回调时,需要保证它被重复调用时的正确性。
  • 预冻结回调程序(PreFreeze回调)在函数实例冻结前执行。
  • 预停止回调程序(PreStop回调)在函数实例销毁前执行。
Initializer回调、PreFreeze回调和PreStop回调方法签名相同,均只有一个Context输入参数,没有返回参数。定义如下:
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)之前执行,否则会导致注册失败。

配置生命周期回调函数

通过控制台配置

函数计算控制台FC函数配置中,启用Initializer回调程序PreFreeze回调程序PreStop回调程序。示例如下:

db-go-lifecycle

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

通过Serverless Devs配置

使用Serverless Devs配置

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

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

  • PreFreeze回调配置

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

  • PreStop回调配置

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

注意 handler字段需配置为非空字符串,在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操作命令

查看日志

您可以在高级日志中,通过实例ID来查询实例生命周期回调函数的相关日志。具体操作,请参见函数实例生命周期

示例程序

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

详细信息,请参见go-initializer-mysql