使用 .zip 文件归档部署 Node.js Lambda 函数 - Amazon Lambda
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

使用 .zip 文件归档部署 Node.js Lambda 函数

Amazon Lambda 函数的代码包含一个 .js 或 .mjs 文件,其中包含函数的处理程序代码,以及代码所依赖的任何其他包和模块。要将此函数部署到 Lambda,您可以使用部署包。此包可以是 .zip 文件归档或容器映像。有关在 Node.js 中使用容器映像的更多信息,请参阅使用容器映像部署 Node.js Lambda 函数

要创建 .zip 文件归档格式的部署包,可以使用命令行工具内置的 .zip 文件归档实用工具或任何其他 .zip 文件实用工具(例如 7zip)。以下各部分中显示的示例假设您在 Linux 或 macOS 环境中使用命令行 zip 工具。要在 Windows 中使用相同命令,您可以安装 Windows Subsystem for Linux,以获取 Windows 集成版本的 Ubuntu 和 Bash。

请注意,Lambda 使用 POSIX 文件权限,因此在创建 .zip 文件归档之前,您可能需要为部署包文件夹设置权限

Node.js 中的运行时系统依赖项

对于使用 Node.js 运行时系统的 Lambda 函数,依赖项可以是任何 Node.js 模块。Node.js 运行时系统包括许多常用库以及一个 Amazon SDK for JavaScript 版本。nodejs16.x Lambda 运行时系统包括 SDK 的版本 2.x。运行时系统版本 nodejs18.x 及更高版本包括 SDK 的版本 3。要将 SDK 版本 2 与运行时系统版本 nodejs18.x 及更高版本结合使用,请将该 SDK 添加到您的 .zip 文件部署包中。如果所选运行时系统包含您正在使用的开发工具包版本,则无需在.zip 文件中包含开发工具包库。要查找正在使用的运行时系统中包含哪个版本的 SDK,请参阅 包含运行时的 SDK 版本

Lambda 会定期更新 Node.js 运行时系统中的开发工具包库,以包含最新更新和安全补丁。Lambda 还会对运行时系统中包含的其他库应用安全补丁和更新。要完全控制包中的依赖项,您可以将任何包含运行时系统依赖项的首选版本添加到部署包中。例如,如果您想使用适用于 JavaScript 的开发工具包的特定版本,则可以将其作为依赖项包含在.zip 文件中。有关向.zip 文件添加包含运行时系统的依赖项的更多信息,请参阅 依赖项搜索路径和包含运行时系统的库

Amazon 责任共担模式下,您负责管理函数部署包中的所有依赖项。这包括应用更新和安全补丁。要更新函数部署包中的依赖项,请先创建一个新的 .zip 文件,然后将其上传到 Lambda 中。有关更多信息,请参阅 创建含依赖项的 .zip 部署包使用 .zip 文件创建和更新 Node.js Lambda 函数

创建不含依赖项的 .zip 部署包

如果除了包含在 Lamba 运行时系统中的库外,您的函数代码没有其他依赖项,则 .zip 文件仅包含带有函数处理程序代码的 index.js 或 index.mjs 文件。使用您的首选 zip 实用工具创建一个 .zip 文件,并将 index.js 或 index.mjs 文件置于根目录中。如果包含您处理程序代码的文件不在 .zip 文件的根目录中,Lambda 将无法运行代码。

要了解如何部署 .zip 文件以创建新的 Lambda 函数或更新现有函数,请参阅 使用 .zip 文件创建和更新 Node.js Lambda 函数

创建含依赖项的 .zip 部署包

如果函数代码依赖未包含在 Lamba Node.js 运行时系统中的程序包或模块,您可以使用函数代码将这些依赖项添加到 .zip 文件中,也可以使用 Lambda 层。本部分中的说明向您展示了如何将依赖项包含在 .zip 部署包中。有关如何将依赖项包含在层中的说明,请参阅 为依赖项创建 Node.js 层

以下示例 CLI 命令将创建名为 my_deployment_package.zip 的 .zip 文件,其中包含 index.js 或 index.mjs 文件,以及您的函数处理程序代码及其依赖项。在示例中,您要使用 npm 程序包管理器来安装依赖项。

创建部署包
  1. 导航到包含 index.js 或 index.mjs 源代码文件的项目目录。在此示例中,该目录名为 my_function

    cd my_function
  2. 使用 npm install 命令在 node_modules 目录中安装函数所需的库。在此示例中,您要安装 Amazon X-Ray SDK for Node.js。

    npm install aws-xray-sdk

    这将创建一个类似于下面的文件夹结构:

    ~/my_function ├── index.mjs └── node_modules ├── async ├── async-listener ├── atomic-batcher ├── aws-sdk ├── aws-xray-sdk ├── aws-xray-sdk-core

    您还可以将自己创建的自定义模块添加到部署包中。在 node_modules 下创建一个以模块命名的目录,然后将自定义编写程序包保存在此处。

  3. 在根目录下创建一个包含您的项目文件夹内容的 .zip 文件。使用 r (递归)选项来确保 zip 压缩子文件夹。

    zip -r my_deployment_package.zip .

为依赖项创建 Node.js 层

本部分中的说明旨在向您展示如何将依赖项包含在层中。有关如何将依赖项包含在部署包中的说明,请参阅 创建含依赖项的 .zip 部署包

当您向函数添加层时,Lambda 会将层内容加载到该执行环境的 /opt 目录中。对于每个 Lambda 运行时系统,PATH 变量都包括 /opt 目录中的特定文件夹路径。为确保 PATH 变量能够获取层内容,层 .zip 文件应在以下文件夹路径中具有依赖项:

  • nodejs/node_modules

  • nodejs/node16/node_modules (NODE_PATH)

  • nodejs/node18/node_modules (NODE_PATH)

  • nodejs/node20/node_modules (NODE_PATH)

例如,层.zip 文件结构可能如下所示:

xray-sdk.zip └ nodejs/node_modules/aws-xray-sdk

此外,Lambda 会自动检测 /opt/lib 目录中的任何库,以及 /opt/bin 目录中的任何二进制文件。为确保 Lambda 正确获取层内容,还可以创建包含以下结构的层:

custom-layer.zip └ lib | lib_1 | lib_2 └ bin | bin_1 | bin_2

打包层后,请参阅 在 Lambda 中创建和删除层 和 向函数添加层 以完成层设置。

依赖项搜索路径和包含运行时系统的库

Node.js 运行时系统包括许多常用库以及一个 Amazon SDK for JavaScript 版本。如果您想使用包含运行时系统的库的不同版本,可以通过将其与自己的函数捆绑或将其作为依赖项添加到部署包中来实现。例如,您可以通过将开发工具包添加到 .zip 部署包中来使用其他版本的开发工具包。您也可以将其包含在函数的 Lambda 层中。

在代码中使用 import 或 require 语句时,Node.js 运行时系统会搜索 NODE_PATH 路径中的目录,直到找到相应模块。默认情况下,运行时系统搜索的第一个位置是解压缩并安装 .zip 部署包的目录 (/var/task)。如果在部署包中包含运行时系统的库的某个版本,则此版本将优先于运行时系统中包含的版本。部署包中的依赖项也优先于层中的依赖项。

向层添加依赖项时,Lambda 会将其提取到 /opt/nodejs/nodexx/node_modules 中,其中 nodexx 表示正在使用的运行时系统版本。在搜索路径中,此目录优先于包含运行时系统的库的目录 (/var/lang/lib/node_modules)。因此,函数层中的库优先于运行时系统中包含的版本。

通过添加以下代码行,您可以查看 Lambda 函数的完整搜索路径。

console.log(process.env.NODE_PATH)

您还可以在 .zip 程序包内的单独文件夹中添加依赖项。例如,您可以将自定义模块添加到 .zip 程序包中名为 common 的文件夹中。解压缩并安装 .zip 程序包后,此文件夹将放置在 /var/task 目录中。要在代码中使用 .zip 部署包中某个文件夹的依赖项,请使用 import { } from 或 const { } = require() 语句,具体取决于您使用的是 CJS 还是 ESM 模块解析。例如:

import { myModule } from './common'

如果您将代码与 esbuildrollup 或类似内容捆绑在一起,则函数使用的依赖项将捆绑在一个或多个文件中。我们建议尽量使用此方法来提供依赖项。与向部署包添加依赖项相比,由于减少了 I/O 操作,捆绑代码可以提高性能。

使用 .zip 文件创建和更新 Node.js Lambda 函数

创建 .zip 部署包后,您可以使用它来创建新的 Lambda 函数或更新现有的 Lambda 函数。您可以使用 Lambda 控制台、Amazon Command Line Interface 和 Lambda API 部署 .zip 程序包。您也可以使用 Amazon Serverless Application Model(Amazon SAM)和 Amazon CloudFormation 创建和更新 Lambda 函数。

Lambda 的 .zip 部署包的最大大小为 250MB(已解压缩)。请注意,此限制适用于您上传的所有文件(包括任何 Lambda 层)的组合大小。

Lambda 运行时需要权限才能读取部署包中的文件。在 Linux 权限八进制表示法中,Lambda 对于不可执行文件(rw-r--r--)需要 644 个权限,对于目录和可执行文件需要 755 个权限(rwxr-xr-x)。

在 Linux 和 MacOS 中,使用 chmod 命令更改部署包中文件和目录的文件权限。例如,要为可执行文件提供正确的权限,请运行以下命令。

chmod 755 <filepath>

要在 Windows 中更改文件权限,请参阅 Microsoft Windows 文档中的 Set, View, Change, or Remove Permissions on an Object

使用控制台通过 .zip 文件创建和更新函数

要创建新函数,必须先在控制台中创建该函数,然后上传您的 .zip 归档。要更新现有函数,请打开函数页面,然后按照相同的步骤添加更新的 .zip 文件。

如果您的 .zip 文件小于 50MB,则可以通过直接从本地计算机上传该文件来创建或更新函数。对于大于 50MB 的 .zip 文件,必须首先将您的程序包上传到 Amazon S3 存储桶。有关如何使用 Amazon Web Services Management Console 将文件上传到 Amazon S3 存储桶的说明,请参阅 Amazon S3 入门。要使用 Amazon CLI 上传文件,请参阅《Amazon CLI 用户指南》中的移动对象

注意

您无法更改现有函数的部署包类型(.zip 或容器映像)。例如,您无法将容器映像函数转换为使用 .zip 文件归档。您必须创建新函数。

创建新函数(控制台)
  1. 打开 Lambda 控制台的“函数”页面,然后选择创建函数

  2. 选择 Author from scratch (从头开始创作)

  3. Basic information (基本信息) 中,执行以下操作:

    1. 对于函数名称,输入函数的名称。

    2. 对于运行时系统,选择要使用的运行时系统。

    3. (可选)对于架构,选择要用于函数的指令集架构。默认架构为 x86_64。确保您的函数的 .zip 部署包与您选择的指令集架构兼容。

  4. (可选)在 Permissions(权限)下,展开 Change default execution role(更改默认执行角色)。您可以创建新的执行角色,也可以使用现有角色。

  5. 选择创建函数。Lambda 使用您选择的运行时系统创建基本“Hello world”函数。

从本地计算机上传 .zip 归档(控制台)
  1. 在 Lambda 控制台的“函数”页面中,选择要为其上传 .zip 文件的函数。

  2. 选择代码选项卡。

  3. 代码源窗格中,选择上传自

  4. 选择 .zip 文件

  5. 要上传 .zip 文件,请执行以下操作:

    1. 选择上传,然后在文件选择器中选择您的 .zip 文件。

    2. 选择打开

    3. 选择保存

从 Amazon S3 存储桶上传 .zip 归档(控制台)
  1. 在 Lambda 控制台的“函数”页面中,选择要为其上传新 .zip 文件的函数。

  2. 选择代码选项卡。

  3. 代码源窗格中,选择上传自

  4. 选择 Amazon S3 位置

  5. 粘贴 .zip 文件的 Amazon S3 链接 URL,然后选择保存

使用控制台代码编辑器更新 .zip 文件函数

对于某些带有 .zip 部署包的函数,您可以使用 Lambda 控制台的内置代码编辑器直接更新函数代码。要使用此功能,函数必须满足以下条件:

  • 函数必须使用一种解释性语言运行时系统(Python、Node.js 或 Ruby)

  • 函数的部署包必须小于 3MB。

带有容器映像部署包的函数的代码不能直接在控制台中编辑。

要使用控制台代码编辑器更新函数代码。
  1. 打开 Lambda 控制台的“函数”页面,然后选择函数。

  2. 选择代码选项卡。

  3. 代码源窗格中,选择源代码文件并在集成的代码编辑器中对其进行编辑。

  4. 编辑完代码后,选择部署以保存更改并更新函数。

使用 Amazon CLI 通过 .zip 文件创建和更新函数

您可以使用 Amazon CLI 创建新函数或使用 .zip 文件更新现有函数。使用 create-functionupdate-function-code 命令部署 .zip 程序包。如果您的 .zip 文件小于 50MB,则可以从本地生成计算机上的文件位置上传 .zip 程序包。对于较大的文件,必须从 Amazon S3 存储桶上传 .zip 程序包。有关如何使用 Amazon CLI 将文件上传到 Amazon S3 存储桶的说明,请参阅《Amazon CLI 用户指南》中的移动对象

注意

如果您使用 Amazon CLI 从 Amazon S3 存储桶上传 .zip 文件,则该存储桶必须与您的函数位于同一个 Amazon Web Services 区域 中。

要通过 Amazon CLI 使用 .zip 文件创建新函数,则必须指定以下内容:

  • 函数的名称 (--function-name)

  • 函数的运行时系统 (--runtime)

  • 函数的执行角色 (--role) 的 Amazon 资源名称(ARN)

  • 函数代码 (--handler) 中处理程序方法的名称

还必须指定 .zip 文件的位置。如果 .zip 文件位于本地生成计算机上的文件夹中,请使用 --zip-file 选项指定文件路径,如以下示例命令所示。

aws lambda create-function --function-name myFunction \ --runtime nodejs20.x --handler index.handler \ --role arn:aws:iam::111122223333:role/service-role/my-lambda-role \ --zip-file fileb://myFunction.zip

要指定 .zip 文件在 Amazon S3 存储桶中的位置,请使用 --code 选项,如以下示例命令所示。您只需对版本控制对象使用 S3ObjectVersion 参数。

aws lambda create-function --function-name myFunction \ --runtime nodejs20.x --handler index.handler \ --role arn:aws:iam::111122223333:role/service-role/my-lambda-role \ --code S3Bucket=myBucketName,S3Key=myFileName.zip,S3ObjectVersion=myObjectVersion

要使用 CLI 更新现有函数,请使用 --function-name 参数指定函数的名称。您还必须指定要用于更新函数代码的 .zip 文件的位置。如果 .zip 文件位于本地生成计算机上的文件夹中,请使用 --zip-file 选项指定文件路径,如以下示例命令所示。

aws lambda update-function-code --function-name myFunction \ --zip-file fileb://myFunction.zip

要指定 .zip 文件在 Amazon S3 存储桶中的位置,请使用 --s3-bucket--s3-key 选项,如以下示例命令所示。您只需对版本控制对象使用 --s3-object-version 参数。

aws lambda update-function-code --function-name myFunction \ --s3-bucket myBucketName --s3-key myFileName.zip --s3-object-version myObject Version

使用 Lambda API 通过 .zip 文件创建和更新函数

要使用 .zip 文件归档创建和更新函数,请使用以下 API 操作:

使用 Amazon SAM 通过 .zip 文件创建和更新函数

Amazon Serverless Application Model(Amazon SAM)是一个工具包,可帮助简化在 Amazon 上构建和运行无服务器应用程序的过程。您可以在 YAML 或 JSON 模板中为应用程序定义资源,并使用 Amazon SAM 命令行界面(Amazon SAM CLI)构建、打包和部署应用程序。当您通过 Amazon SAM 模板构建 Lambda 函数时,Amazon SAM 会使用您的函数代码和您指定的任何依赖项自动创建 .zip 部署包或容器映像。要了解有关使用 Amazon SAM 构建和部署 Lambda 函数的更多信息,请参阅《Amazon Serverless Application Model 开发人员指南》中的 Amazon SAM 入门

您可以使用 Amazon SAM 创建使用现有 .zip 文件归档的 Lambda 函数。要使用 Amazon SAM 创建 Lambda 函数,您可以将 .zip 文件保存在 Amazon S3 存储桶或生成计算机上的本地文件夹中。有关如何使用 Amazon CLI 将文件上传到 Amazon S3 存储桶的说明,请参阅《Amazon CLI 用户指南》中的移动对象

在 Amazon SAM 模板中,AWS::Serverless::Function 资源将指定 Lambda 函数。在此资源中,设置以下属性以创建使用 .zip 文件归档的函数:

  • PackageType – 设置为 Zip

  • CodeUri – 设置为函数代码的 Amazon S3 URI、本地文件夹的路径或 FunctionCode 对象

  • Runtime – 设置为您选择的运行时系统

使用 Amazon SAM,如果 .zip 文件大于 50MB,则不需要先将其上传到 Amazon S3 存储桶。Amazon SAM 可以从本地生成计算机上的某个位置上传最大允许大小为 250MB(已解压缩)的 .zip 程序包。

要了解有关在 Amazon SAM 中使用 .zip 文件部署函数的更多信息,请参阅《Amazon SAM 开发人员指南》中的 AWS::Serverless::Function

使用 Amazon CloudFormation 通过 .zip 文件创建和更新函数

您可以使用 Amazon CloudFormation 创建使用 .zip 文件归档的 Lambda 函数。要从 .zip 文件创建 Lambda 函数,必须先将您的文件上传到 Amazon S3 存储桶。有关如何使用 Amazon CLI 将文件上传到 Amazon S3 存储桶的说明,请参阅《Amazon CLI 用户指南》中的移动对象

在 Amazon CloudFormation 模板中,AWS::Lambda::Function 资源将指定 Lambda 函数。在此资源中,设置以下属性以创建使用 .zip 文件归档的函数:

  • PackageType – 设置为 Zip

  • Code – 在 S3BucketS3Key 字段中输入 Amazon S3 存储桶名称和 .zip 文件名。

  • Runtime – 设置为您选择的运行时系统

Amazon CloudFormation 生成的 .zip 文件不能超过 4MB。要了解有关在 Amazon CloudFormation 中使用 .zip 文件部署函数的更多信息,请参阅《Amazon CloudFormation 用户指南》中的 AWS::Lambda::Function