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

背景信息

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

Initializer回调

初始化回调程序(Initializer回调)在函数实例启动成功之后,运行请求处理程序(Handler)之前执行。函数计算保证在一个实例生命周期内,成功且最多成功执行一次Initializer回调。例如,您的Initializer回调第一次执行失败后系统会重试,直到成功为止,然后再执行您的请求处理程序。

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

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

exports.initialize = function(context, callback) {
  console.log('initializer');
  callback(null, "");
};

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

方法签名

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

PreFreeze回调

预冻结回调程序(PreFreeze回调)在函数实例冻结前执行,方法签名同Initializer回调。

一个最简单的PreFreeze程序如下所示。

module.exports.preFreeze = function(context, callback) {
  console.log('preFreeze');
  callback(null, "");
};

PreStop回调

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

一个最简单的preStop程序如下所示。

module.exports.preStop = function(context, callback){
  console.log('preStop');
  callback(null, "");
}

配置生命周期回调函数

通过控制台配置

您可以在函数计算控制台FC函数配置中,配置Initializer 回调程序PreFreeze 回调程序PreStop 回调程序。具体操作步骤,请参见函数实例生命周期。回调格式为[文件名.方法名],例如:
  • Initializer 回调程序设置为index.initialize,表示index.py文件中的initialize方法。
  • PreFreeze 回调程序设置为index.preFreeze,表示index.py文件中的preFreeze方法。
  • PreStop 回调程序设置为index.preStop,表示index.py文件中的preStop方法。
db-node.js-lifecycle

通过Serverless Devs工具配置

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

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

  • PreFreeze回调配置

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

  • PreStop回调配置

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

具体的示例如下所示。

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

services:
  fc-deploy-test: # 模块名称
    component: devsapp/fc  # 组件名称
    props:                 # 组件的属性值
      region: cn-hangzhou   # 地域
      service:             # 服务配置
        name: fc-deploy-service    # service名称
        description: dem component # Service的简短描述
      function:                       # 函数配置
        name: fc-base-service         # function名称
        description: 'this is test'   # function的简短描述
        codeUri: './code'             # 代码位置
        handler: 'index.handler'      # function执行的入口,具体格式和语言相关
        memorySize: 128               # function的内存规格
        runtime: nodejs14             # 运行时
        timeout: 60                   # function运行的超时时间
        initializationTimeout: 20     # 初始化方法超时时间
        initializer: index.initialize # 初始化方法
        instanceLifecycleConfig:      # 扩展函数
          preFreeze:              # PreFreeze 函数
            handler: index.preFreeze  # 函数入口
            timeout: 60              # 超时时间  
          preStop:                    # PreStop 函数
            handler: index.preStop    # 函数入口
            timeout: 60               # 超时时间

关于Serverless Devs的YAML配置规范,请参见基本功能

示例程序

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

详细信息,请参见nodejs14-mysql