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

背景信息

当您实现并配置函数实例生命周期回调后,函数计算将在相关实例生命周期事件发生时调用对应的回调程序。函数实例生命周期涉及Initializer、PreFreeze和PreStop三种回调。当前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保持一致。
  • contextinitializerinitializationTimeout两个信息是为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配置下添加initializerinitializationTimeout两个字段。

  • PreStop回调配置

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

具体的示例如下所示。

edition: 1.0.0         #  命令行YAML规范版本,遵循语义化版本(Semantic Versioning)规范
name: hello-world-app  #  项目名称
access: default        #  密钥别名

vars:
  region: cn-hangzhou
  service:
    name: php72-mysql    # service名称
    description: 'hello world by serverless devs' # Service的简短描述

services:
  helloworld: # 业务名称/模块名称
    component: fc
    props:
      region: ${vars.region}
      service: ${vars.service}
      function:
        name: php72-mysql                              # function名称
        description: 'hello world by serverless devs'  # function的简短描述
        runtime: php7.2                                # 运行时
        codeUri: ./code                                # 代码位置
        handler: index.handler                         # function执行的入口,具体格式和语言相关
        memorySize: 128                                # function的内存规格
        timeout: 60                                    # function运行的超时时间
        initializationTimeout: 20                      # 初始化方法超时时间
        initializer: index.initialize                  # 初始化方法
        instanceLifecycleConfig:                       # 扩展函数
          preStop:                                     # PreStop函数
            handler: index.pre_stop                    # 函数入口
            timeout: 20                                # 超时时间

关于Serverless Devs的YAML配置规范,请参见Serverless Devs操作命令

示例程序

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

详细信息,请参见php72-mysql