在函数计算服务使用 Node.js 编程,需要定义一个 Node.js 函数作为入口函数。本文介绍了 Node.js 事件函数的结构和特点。

事件函数定义

一个最简单的入口函数定义如下。

exports.handler = function(event, context, callback) {
  callback(null, 'hello world');
};       
函数定义中包含以下几部分内容:

函数名

本文示例中的函数名handler 需要与创建函数时的 handler 字段相对应。例如创建函数时指定的 handlerindex.handler,那么函数计算会去加载 index.js 文件中定义的 handler 函数。

event 参数

  • event 参数是您调用函数时传入的数据,其类型是 Buffer,是函数的输入参数。
  • 您在函数中可以根据实际情况对 event 进行转换。如果输入数据是一个 JSON 字符串 ,您可以把它转换成一个 Object 。
    {
    "key": "value"
    }          

    例如,传入 event ,返回结果为 value

    exports.handler = function(event, context, callback) {
      var eventObj = JSON.parse(event.toString());
      callback(null, eventObj['key']);
    };          

context 参数

context 参数中包含一些函数的运行信息,例如 request Id 、 临时 AK 等。您在代码中可以使用这些信息。信息类型是 Object,其定义如下所示。

{
  'requestId': 'b1c5100f-819d-c421-3a5e-7782a27d8a33',
  'credentials': {
    'accessKeyId': 'STS.access_key_id',
    'accessKeySecret': 'access_key_secret',
    'securityToken': 'security_token',
  },
  'function': {
    'name': 'my-func',
    'handler': 'index.handler',
    'memory': 128,
    'timeout': 10,
    'initializer': 'index.initializer',
    'initializationTimeout': 10,
  },
  'service': {
     'name': 'my-service',
     'logProject': 'my-log-project',
     'logStore': 'my-log-store',
     'qualifier': 'qualifier',
     'versionId': '1'
  },
  'region': 'cn-shanghai',
  'accountId': '123456'
}
			

在 context 中包含了以下信息:

字段 说明
requestId 本次调用请求的唯一 ID,您可以把它记录下来在出现问题的时候方便查询。
function 当前调用的函数的一些基本信息,例如函数名、函数入口、函数内存和超时时间。
credentials 函数计算服务通过扮演您提供的服务角色获得的一组临时密钥,其有效时间是 6 小时。您可以在代码中使用 credentials 去访问相应的服务( 例如 OSS ),这就避免了您把自己的 AK 信息写死在函数代码里。

权限相关内容请参见权限简介

service 当前调用的函数所在的 service 的信息,包含 service 的名字、接入的 SLS 的 logProject 和 logStore 信息、service 的版本信息、 qualifier 和 version_id。其中 qualifier 表示调用函数时指定的 service 版本或别名,version_id 表示实际调用的 service 版本。
region 当前调用的函数所在区域,例如 cn-shanghai。
accountId 当前调用函数用户的阿里云 Account ID。

在下面的代码示例中,演示了如何使用临时密钥向 OSS 上传一个文件。

var OSSClient = require('ali-oss').Wrapper;

exports.handler = function (event, context, callback) {
    console.log(event.toString());

    var ossClient = new OSSClient({
        accessKeyId: context.credentials.accessKeyId,
        accessKeySecret: context.credentials.accessKeySecret,
        stsToken: context.credentials.securityToken,
        region: 'oss-cn-shanghai',
        bucket: 'my-bucket',
    });

    ossClient.put('my-object', new Buffer('hello, fc')).then(function (res) {
        callback(null, 'put object');
    }).catch(function (err) {
        callback(err);
    });
};
			
注意 使用临时密钥访问 OSS 时一定要带上第三个参数 securityToken

callback 函数

callback 是由系统定义的函数,作为入口函数的入参用于返回调用函数的结果,标识函数执行结束。其签名是 function(err, data),与 Node.js 中使用的 callback 一样,它的第一个参数是 error ,第二个参数 data

如果调用时 error 不为空,则函数返回 HandledInvocationError ,否则返回 data 的内容。

  • 如果 dataBuffer 类型则它的数据将直接被返回。
  • 如果 dataobject ,则会将其转换成 JSON 字符串返回,
  • 如果data 是其他类型将被转换成字符串返回。