配置回调函数对函数实例生命周期关键点进行精细化控制

本文介绍Python如何实现并应用函数实例生命周期回调方法。

背景信息

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

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

Initializer回调

初始化回调程序（Initializer回调）在函数实例启动成功后，请求处理程序（Handler）之前执行。函数计算保证在一个实例生命周期内，成功且只成功执行一次Initializer回调。如果您的Initializer回调第一次执行失败，那么此次函数调用直接返回失败，下次调用时，会再新建一个函数实例执行initializer回调。

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

一个最简单的Initializer方法定义如下所示。

def initialize(context):
    print("initialize invoked")

initialize是Initializer回调方法名，需要与您在函数计算控制台配置的Initializer回调程序一致。例如，您为函数配置的Initializer回调程序为index.initialize，那么函数计算在配置Initializer属性后会去加载index.py中定义的initialize方法。

方法签名

输入参数只有context，为您的FC函数调用提供在调用时的运行上下文信息。
无返回值。

PreStop回调

预停止回调程序（PreStop回调）在函数实例销毁前执行，方法签名同Initializer回调。

一个最简单的PreStop方法定义如下所示。

def preStop(context):
    print("preStop invoked")

配置生命周期回调函数

通过控制台配置

您可以登录函数计算控制台，为函数配置Initializer 回调程序和PreStop 回调程序。具体操作步骤，请参见函数实例生命周期。

回调程序的格式为[文件名.方法名]。例如，Initializer 回调程序设置为index.initialize，表示index.py文件中的initialize方法。

shengmingzhouqi

通过Serverless Devs工具配置

如果使用Serverless Devs工具，需要在s.yaml配置文件中添加Initializer回调配置和PreStop回调配置。

Initializer回调配置
在function配置下添加instanceLifecycleConfig.initializer字段，包括handler和timeout两个字段。
PreStop回调配置
在function配置下添加instanceLifecycleConfig.preStop字段，包括handler和timeout两个字段。

具体的示例如下所示。

edition: 3.0.0
name: fcDeployApp
access: "default"

vars: # 全局变量
  region: "cn-hangzhou"

resources:
  hello_world:
    component: fc3 # 组件名称
    props:
      region: ${vars.region}              # 关于变量的使用方法，可以参考：https://docs.serverless-devs.com/serverless-devs/yaml#%E5%8F%98%E9%87%8F%E8%B5%8B%E5%80%BC
      functionName: "emojipy"
      description: 'this is emoji'
      runtime: "python3"
      code: ./
      handler: index.handler
      memorySize: 128
      timeout: 30
      environmentVariables:
        PYTHONPATH: /code:/code/python:/opt/python
#     initializationTimeout: 20     # 初始化方法超时时间
#     initializer: index.my_initializer # 初始化方法
      instanceLifecycleConfig:      # 扩展函数
        preStop:                    # PreStop函数
          handler: index.preStop    # 函数入口
          timeout: 60               # 超时时间
        initializer:                # initializer函数
          handler: index.initialize
          timeout: 60

关于Serverless Devs的YAML配置规范，请参见Serverless Devs常用命令。

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

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

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

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

在函数日志页签，您可以查看函数的调用日志和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回调和PreStop回调的MySQL示例程序。在本示例中，Initializer回调函数用于从环境变量中获取MySQL数据库配置，创建MySQL连接并测试连通性，PreStop回调函数负责关闭MySQL连接。

详细信息，请参见python3-mysql。