云函数 基本概念 - 开发指南

用户在使用云函数（Serverless Cloud Function，SCF）平台支持的语言编写代码时，需要采用一个通用的范式，包含以下核心概念：

执行方法

SCF 平台在调用云函数时，首先会寻找执行方法作为入口，执行用户的代码。此时，用户需以文件名.执行方法名的形式进行设置。
例如，用户设置的执行方法为 index.handler，则 SCF 平台会首先寻找代码程序包中的 index 文件，并找到该文件中的 handler 方法开始执行。
在编写执行方法时，用户需遵循平台特定的编程模型。如下所示：

def method_name(event,context): 
   ...
   return some_value

该模型中指定固定的 event 事件数据和 context 环境数据作为入参。在执行方法中，用户需对参数进行处理，并且可任意调用代码中的任何其他方法。

函数入参

函数入参，是指函数在被触发调用时所传递给函数的内容。通常情况下，函数入参包括 event 入参和 context 入参两部分，但根据开发语言和环境的不同，入参个数可能有所不同，详情请参见 开发语言说明。

{
    getRemainingTimeInMillis: [Function: getRemainingTimeInMillis],
    memory_limit_in_mb: 128,
    time_limit_in_ms: 3000,
    request_id: '4ca7089c-3bb0-48cf-bcdb-26d130fed2ae',
    environment: '{"SCF_NAMESPACE":"default"}',
    environ: 'SCF_NAMESPACE=default;SCF_NAMESPACE=default',
    function_version: '$LATEST',
    function_name: 'test',
    namespace: 'default',
    tencentcloud_region: 'ap-chengdu',
    tencentcloud_appid: '1253970226',
    tencentcloud_uin: '3473058547' 
}

• 为保证针对各开发语言和环境的统一性，event 入参和 context 入参均使用 JSON 数据格式统一封装。
• 不同触发器在触发函数时，所传递的数据结构均有所不同。详情请参见 函数触发器说明。
• 在使用云 API 方法触发云函数时，您可以自行定义传递给云函数的入参。
• 当云函数不需要任何输入时，您可以在代码中忽略 event 和 context 参数。

函数返回

SCF 平台会获取到云函数执行完成后的返回值，并根据下表中不同的触发方式进行处理。

当函数中的代码返回具体值时，通常返回特定的数据结构。例如 ：

为保证针对各开发语言和环境的统一性，函数返回会使用 JSON 数据格式统一封装。SCF 平台在获取到例如以上运行环境函数的返回值后，将会对返回的数据结构进行 JSON 化，并返回 JSON 内容到调用方。

注意：

• 需确保函数的返回值均可被 JSON 化，若直接返回对象且不具备 JSON 化方法，将会导致 SCF 平台在 JSON 化操作时失败并报错。
• 例如以上运行环境的返回值，无需在 return 前自行 JSON 化，否则会导致输出的字符串会进行再次 JSON 化。

异常处理

若函数在调试和运行过程中出现异常，SCF 平台会尽最大可能捕获异常并将异常信息写入日志中。函数运行产生的异常包括捕获的异常（Handled error）和未捕获的异常（Unhandled Error）。

处理方式

本文提供以下三种抛出异常方式，您可根据实际需求选择在代码中进行异常处理。

说明：

您可以前往 SCF 控制台 按照以下步骤进行异常处理测试：

1. 新建函数并复制以下函数代码，不添加任何触发器。
2. 单击控制台【测试】，选择 “Hello World” 测试示例进行测试。

返回错误信息

当用户的代码逻辑中未进行异常处理及错误捕获时，SCF 平台会尽可能的捕获错误。例如，用户函数在运行过程中突然崩溃退出，当出现此类平台也无法捕获错误的情况时，系统将会返回一个通用的错误信息。
下表展示了代码运行中常见的一些错误：

日志

SCF 平台会将函数调用的所有记录及函数代码中的全部输出存储在日志中，请使用编程语言中的打印输出语句或日志语句生成输出日志，方便调试及故障排除时使用。

日志组成

函数运行日志包含：函数名、启动时间、执行时间、计费时间、内存实际用量、返回码、返回值、代码日志、执行状态。

函数的运行日志通常数据结构如下所示：

{
   "functionName": "testnode",
   "retMsg": "\"ok\"",
   "requestId": "b33b9d0b-9c51-11e7-b38f-525400c7c826",
   "startTime": "2017-09-18 17:13:57",
   "retCode": 0,
   "invokeFinished": 1,
   "duration": 7.437,
   "billDuration": 100,
   "memUsage": 131072,
   "log": "2017-09-18T09:13:57.155Z\tundefined\tHello World\n2017-09-18T09:13:57.156Z\tundefined\t{ Records: [ { CMQ: [Object] } ] }\n2017-09-18T09:13:57.158Z\tundefined\t{ msgBody: '3',\n  msgId: '3096224743817223',\n  msgTag: '',\n  publishTime: '2017-09-18T17:13:57Z',\n  requestId: '5761047512720426853',\n  subscriptionName: 'test',\n  topicName: 'test',\n  topicOwner: 1251762227,\n  type: 'topic' }\n2017-09-18T09:13:57.159Z\tundefined\t{ callbackWaitsForEmptyEventLoop: [Getter/Setter],\n  done: [Function: done],\n  succeed: [Function: succeed],\n  fail: [Function: fail],\n  memory_limit_in_mb: 128,\n  time_limit_in_ms: 30000 }\n"
}

日志写入

Log 语句为函数提供必要的执行过程中的信息，是开发者对代码进行排障的必要手段。SCF 平台会将用户在代码中使用 log 语句生成的日志全部写入日志系统中，如果您使用控制台调用函数，控制台将显示相同的日志。

您可以通过 print 语句或 logging 模块中的 Logger 函数生成日志条目。 如下所示：

import logging
logger = logging.getLogger()
def my_logging_handler(event):
   logger.info('got event{}'.format(event))
   logger.error('something went wrong')
   return 'Hello World!'

def print_handler(event):
   print('this will show up in logging')
   return 'Hello World!'

获取日志

您可以通过以下途径获取函数运行日志：

注意事项

由于 SCF 的特点，您须以无状态的风格编写您的函数代码。本地文件存储等函数生命周期内的状态特征，在函数调用结束后将随之销毁。
因此，持久状态建议存储在关系型数据库 TencentDB、对象存储 COS、云数据库 Memcached 或其他云存储服务中。

开发流程

了解更多云函数开发流程，请参见 使用流程。