在函数计算服务使用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是其他类型将被转换成字符串返回。