View a markdown version of this page

使用本地调用 Lambda 事件函数 Amazon SAM - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

使用本地调用 Lambda 事件函数 Amazon SAM

在云端测试或部署之前在本地调用 Lambda 事件函数可以带来多种好处。它允许您更快地测试函数的逻辑。首先本地测试可减少在云中测试或部署期间发现问题的可能性,从而帮助您避免不必要的成本。此外,本地测试使调试变得更加容易。

您可以通过使用 sam local 调用 命令并提供函数的逻辑 ID 和事件文件,在本地调用 Lambda 函数。sam local invoke 还接受 stdin 作为事件。有关事件的更多信息,请参阅《Amazon Lambda 开发人员指南》中的事件。有关不同事件消息格式的信息 Amazon 服务,请参阅 使用 Amazon Lambda 使用其他服务 在 Amazon Lambda 开发者指南。

重要

本地调用在本地环境中运行函数代码。对于您未编写或审阅的代码,请使用 Lambda 服务,该服务可将其与您的计算机隔离运行。

注意

这个 sam local invoke 命令对应于 Amazon Command Line Interface (Amazon CLI) 命令 aws lambda invoke。您可以使用任一命令调用 Lambda 函数。

必须在包含要调用的函数的项目目录中运行 sam local invoke 命令。

示例:

# Invoking function with event file $ sam local invoke "Ratings" -e event.json # Invoking function with event via stdin $ echo '{"message": "Hey, are you there?" }' | sam local invoke --event - "Ratings" # For more options $ sam local invoke --help

环境变量文件

要在本地声明可覆盖模板中定义的值的环境变量,请执行以下操作:

  1. 创建 JSON 或 .env 包含要覆盖的环境变量的文件。

  2. 使用 --env-vars 参数覆盖模板中定义的值。

这个 --env-vars 选项支持两种文件格式。根据文件内容自动检测文件格式。

使用 JSON 声明环境变量

要声明可全局应用于所有资源的环境变量,请如下所示指定 Parameters 对象:

{ "Parameters": { "TABLE_NAME": "localtable", "BUCKET_NAME": "amzn-s3-demo-bucket", "STAGE": "dev" } }

要为每个资源声明不同的环境变量,请如下所示为每个资源指定对象:

{ "MyFunction1": { "TABLE_NAME": "localtable", "BUCKET_NAME": "amzn-s3-demo-bucket", }, "MyFunction2": { "TABLE_NAME": "localtable", "STAGE": "dev" } }

为每个资源指定对象时,可以使用以下标识符,这些标识符按优先级从高到低的顺序列出:

  1. logical_id

  2. function_id

  3. function_name

  4. 完整路径标识符

您可以在单个文件中结合使用上述两种声明环境变量的方法。如果这样做,您为特定资源提供的环境变量会优先于全局环境变量。

将环境变量保存在 JSON 文件中,例如 env.json。

使用 .env 文件声明环境变量

你也可以使用 .env 用于声明环境变量的文件。在 a 中声明的变量 .env 文件全局应用于所有函数,等效于 Parameters JSON 格式的对象。

TABLE_NAME=localtable BUCKET_NAME=amzn-s3-demo-bucket STAGE=dev

这个 .env 格式支持注释(以以下开头的行) #) 和引用的值。

注意

这个 .env 格式仅支持全局环境变量。要声明特定于函数的环境变量,请使用 JSON 格式。

覆盖环境变量值

要使用环境变量文件中定义的环境变量覆盖环境变量,请使用 --env-vars 与... 争论 invoke 要么 start-api 命令。例如:

# Using a JSON file sam local invoke --env-vars env.json # Using a .env file sam local invoke --env-vars .env

图层

如果应用程序包含层,有关如何在本地主机上调试层的问题,请参阅使用 Lambda 图层提高效率 Amazon SAM。

了解详情

有关在本地调用函数的实际示例,请参见 模块 2-在本地运行 在 完整版 Amazon SAM 工作坊。