开发事件函数

函数定义

建议使用Node.js 12.13版本。

• Node.js 6.10函数定义

  Node.js6.10 函数的接口定义如下所示。

  export.handler = function(event, context, callback)

  • 入口函数名（handler）：入口函数名称， 需和函数执行入口处用户自定义的入口函数名称一致。
  • 执行事件（event）：函数执行界面由用户输入的执行事件参数， 格式为JSON对象。
  • 上下文环境（context）：Runtime提供的函数执行上下文，其接口定义在SDK接口说明。
  • 回调函数（callback）：callback方法完整声明为callback(err, message)，用户通过此方法可以返回err和message至前台结果显示页面。具体的err或message内容需要用户自己定义，如字符串。
  • 函数执行入口： index.handler

    函数执行入口格式为“[文件名].[函数名]”。例如创建函数时设置为index.handler，那么FunctionGraph会去加载index.js中定义的handler函数。

• Node.js 8.10、Node.js 10.16、Node.js 12.13、Node.js14.18、Node.js16.17、Node.js18.15函数定义

  Node.js 8.10、Node.js 10.16、Node.js 12.13、Node.js14.18、Node.js16.17、Node.js18.15 Runtime除了兼容Node.js 6.10 Runtime函数的接口定义规范，还支持使用async的异步形式作为函数入口。

  exports.handler = async (event, context, callback[可选]) => { return data;}

  通过return进行返回。

Node.js的initializer入口介绍

FunctionGraph目前支持以下Node.js运行环境：

• Node.js6.10 (runtime = Node.js6)
• Node.js8.10 (runtime = Node.js8)
• Nodejs10.16(runtime = Node.js10)
• Nodejs12.13(runtime = Node.js12)
• Node.js14.18(runtime = Node.js14)
• Node.js16.17(runtime = Node.js16)
• Node.js18.15(runtime = Node.js18)

SDK接口

Context类中提供了许多上下文方法供用户使用，其声明和功能如表1所示。

getToken()、getAccessKey()和getSecretKey()方法返回的内容包含敏感信息，请谨慎使用，避免造成用户敏感信息的泄露。

开发Node.js函数

如下为本地开发后上传实例，也可以直接在页面创建在线编辑。

1. 创建函数工程
   1. 创建函数代码（同步形式入口函数）

      打开文本编辑器，编写函数，代码如下，文件命名为index.js，保存文件。如下为同步方式入口函数。

      exports.handler = function (event, context, callback) {
          const error = null;
          const output = {
              'statusCode': 200,
              'headers':
              {
                  'Content-Type': 'application/json'
              },
              'isBase64Encoded': false,
              'body': JSON.stringify(event),
          }
          callback(error, output);
      }

      

      1. callback返回的第一个参数不为null，则认为函数执行失败，会返回定义在第二个参数的HTTP错误信息。
      2. 注意，当使用APIG触发器时，函数返回必须使用示例中output的格式， 函数Body参数仅支持返回如下几种类型的值。相关约束条件请参考Base64解码和返回结构体的说明。

         null：函数返回的HTTP响应Body为空。

         []byte: 函数返回的HTTP响应Body内容为该字节数组内容。

         string：函数返回的HTTP响应Body内容为该字符串内容。

   2. 创建函数代码(异步形式的入口函数, 运行时 8.10 及以上支持）

      exports.handler = async (event, context) => {
          const output =
          {
              'statusCode': 200,
              'headers':
              {
                  'Content-Type': 'application/json'
              },
              'isBase64Encoded': false,
              'body': JSON.stringify(event),
          }
          return output;
      }

      如果您的Node.js函数中包含异步任务，须使用Promise以确保该异步任务在当次调用执行，可以直接return声明的Promise，也可以await执行该Promise。 暂时不支持在函数响应请求后继续执行异步任务的能力。

      exports.handler =  async(event, context ) => {
          const output =
          {
              'statusCode': 200,
              'headers':
              {
                  'Content-Type': 'application/json'
              },
              'isBase64Encoded': false,
              'body': JSON.stringify(event),
          }
       
          const promise = new Promise((resolve, reject) => {
              setTimeout(() => {
                  resolve(output)
              }, 2000)
          })
          return promise
          // anthor way 
          // res = await promise;
          // return res 
      }

      如果期望函数先响应，随后继续执行任务。 可以通过SDK/API调用FunctionGraph的异步执行函数接口实现。如果使用APIG触发器，可以单击生成的APIG触发器名称，跳转到APIG服务页面，选择Asynchronous方式调用。

2. 工程打包

   下列示例中，使用异步形式入口作为演示。函数工程创建以后，可以得到以下目录，选中工程所有文件，打包命名为“fss_examples_nodejs.zip”。

   图1 打包
   
   

   本例函数工程文件保存在“~/Code/”文件夹下，在打包的时候务必进入Code文件夹下选中所有工程文件进行打包，这样做的目的：定义了FunctionGraph函数的index.js是程序执行入口，确保fss_examples_nodejs.zip解压后，index.js文件位于根目录。

3. 创建FunctionGraph函数，上传程序包

   登录FunctionGraph控制台，创建Node.js函数，上传fss_examples_nodejs.zip文件。如图2所示。

   图2 上传程序包
   
   

   1. 函数设置中，函数执行入口中的index与步骤创建函数工程中创建的函数文件名保持一致，通过该名称找到FunctionGraph函数所在文件。
   2. 函数执行入口中的handler为函数名，与步骤创建函数工程中创建的index.js文件中的函数名保持一致。

   在函数工作流控制台左侧导航栏选择“函数 > 函数列表”，单击需要设置的“函数名称”进入函数详情页，选择“设置 > 常规设置”，配置“函数执行入口”参数，如图3所示。其中参数值为“index.handler”格式，“index”和“handler”支持自定义命名。

   图3 函数执行入口参数
   

4. 测试函数
   1. 创建测试事件。

      在函数详情页，单击“配置测试事件”，弹出“配置测试事件”页，输入测试信息如图4所示，单击“创建”。

      图4 配置测试事件
      
   2. 在函数详情页，选择已配置测试事件，单击“测试”。

5. 函数执行

   函数执行结果分为三部分，分别为函数返回（由callback返回）、执行摘要、日志输出（由console.log或getLogger()方法获取的日志方法输出），如图5所示。

   图5 测试结果
   

执行结果

执行结果由3部分组成：函数返回、执行摘要和日志。

{
    "errorMessage": "", 
    "errorType":"", 
}