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

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

背景信息

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

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

Initializer回调

Initializer示例

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

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

一个最简单的Initializer回调如下所示。

<?php
function my_initializer($context) {
    $logger = $GLOBALS['fcLogger'];
    $logger->info("hello world");
}
?>

my_initializer是Initializer回调方法名，需要与您在函数计算控制台配置的Initializer 回调程序相对应。例如，您为函数配置的Initializer 回调程序为main.my_initializer，那么函数计算在配置Initializer属性后会去加载main.php中定义的my_initializer方法。

方法签名

输入参数只有context，包含的信息和事件请求处理程序（handler）的context保持一致。
context中initializer和initializationTimeout两个信息是为Initializer回调设计，如果使用Initializer功能，会被分别设置为您为函数配置的Initializer 回调程序和Initializer 回调超时时间的值，否则为空，且不生效。
无返回值。

PreStop回调

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

如下是preStop回调的具体示例。

<?php

$counter = 0;
function preStop($context) {
    $GLOBALS['fcLogger']->info("preStop ok");
}

function handler($event, $context) {
    global $counter;
    $counter += 2;
    return $counter;
}
?>

您可以在您为函数开通的LogStore中查询到PreStop函数的日志。比如使用如下格式的语句查询该函数所有日志。更多信息，请参见查询回调函数相关日志。

<funcName> AND <ServiceName> AND qualifier: <VERSION>

配置生命周期回调函数

通过控制台配置

您可以在函数计算控制台的FC函数配置中，配置Initializer 回调程序和PreStop 回调程序。具体操作步骤，请参见配置实例生命周期。回调格式为[文件名.方法名]，例如：

Initializer 回调程序设置为index.initialize，表示index.php文件中的initialize方法。
PreStop 回调程序设置为index.preStop，表示index.php文件中的preStop方法。

db-php-lifecycle

通过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: "testphp"
      description: 'this is a test'
      runtime: "php7.2"
      code: ./
      handler: index.handler
      memorySize: 128
      timeout: 30
      instanceLifecycleConfig:      # 扩展函数
        initializer:                # initializer函数
          handler: index.my_initializer 
          timeout: 60     
        preStop:                    # PreStop函数
          handler: index.preStop    # 函数入口
          timeout: 60               # 超时时间

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

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

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

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

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

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

2024-03-04 17:57:28FC Initialize Start RequestId: 1-65e59b07-1520da26-bf73bbb91b69
2024-03-04 17:57:282024-03-04 09:57:28.192 1-65e59b07-1520da26-bf73bbb91b69 [info] initializer
2024-03-04 17:57:28FC Initialize End RequestId: 1-65e59b07-1520da26-bf73bbb91b69
2024-03-04 17:57:28FC Invoke Start RequestId: 1-65e59b07-1520da26-bf73bbb91b69
2024-03-04 17:57:28FC Invoke End RequestId: 1-65e59b07-1520da26-bf73bbb91b69

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

2024-03-04 18:33:26FC PreStop Start RequestId: 93c93603-9fbe-4576-9458-193c8b213031
2024-03-04 18:33:262024-03-04 10:33:26.077 93c93603-9fbe-4576-9458-193c8b213031 [info] preStop
2024-03-04 18:33:26FC PreStop End RequestId: 93c93603-9fbe-4576-9458-193c8b213031

示例程序

函数计算为您提供了使用Initializer回调和PreStop回调的MySQL示例程序。在本示例中，Initializer回调函数用于从环境变量中获取MySQL数据库配置，创建MySQL连接并测试连通性，PreStop回调函数负责关闭MySQL连接。详细信息，请参见php72-mysql。