使用网关调用 Lambda API - Amazon SDK for JavaScript
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

Amazon SDK for JavaScript V3 API 参考指南详细描述了 Amazon SDK for JavaScript 版本 3 (V3) 的所有API操作。

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

使用网关调用 Lambda API

您可以使用 Amazon API Gateway 调用 Lambda 函数,这是一项用于大规模创建、发布、维护RESTHTTP、监控和保护 WebSocket APIs的 Amazon 服务。API开发人员可以创建APIs该访问权限 Amazon 或其他 Web 服务,以及存储在 Amazon 云中的数据。作为 API Gateway 开发人员,您可以创建APIs以在自己的客户端应用程序中使用。有关更多信息,请参阅什么是 Amazon API Gateway

Amazon Lambda 是一项计算服务,使您无需预置或管理服务器即可运行代码。您可以使用各种编程语言创建 Lambda 函数。有关的更多信息 Amazon Lambda,请参阅什么是 Amazon Lambda

在此示例中,您将使用 Lambda 运行时创建一个 Lambda 函数。 JavaScript API此示例调用不同的 Amazon 服务来执行特定的用例。例如,假设组织在员工入职一周年纪念日时向员工发送移动短信表示祝贺,如下图所示。

DynamoDB 表

完成此示例大约需要 20 分钟。

此示例向您展示如何使用 JavaScript 逻辑来创建执行此用例的解决方案。例如,您将学习如何使用 Lambda 函数读取数据库以确定哪些员工已达到入职一周年纪念日、如何处理数据以及如何发送短信。然后,您将学习如何使用 API Gateway 通过 Rest 端点调用此 Amazon Lambda 函数。例如,您可以使用以下 curl 命令调用 Lambda 函数:

curl -XGET "https://xxxxqjko1o3.execute-api.us-east-1.amazonaws.com/cronstage/employee"

本 Amazon 教程使用名为 Employee 的 Amazon DynamoDB 表,其中包含这些字段。

  • id - 表的主键。

  • firstName-员工的名字。

  • phone - 员工的电话号码。

  • startDate-员工的开始日期。

DynamoDB 表
重要

完成费用:本文档中包含的 Amazon 服务包含在 Amazon 免费套餐中。但是,请务必在完成此示例后终止所有资源,以确保系统不会向您收费。

完成先决条件任务

要设置和运行此示例,您必须先完成以下任务:

创建 Amazon 资源

本教程要求具有以下资源:

  • 一个名为 Employee 的 Amazon DynamoDB 表,其键名为 Id,其字段如上图所示。请务必输入正确的数据,包括要用来测试此使用案例的有效手机号。有关更多信息,请参阅创建表

  • 具有执行 Lambda 函数的附加权限的IAM角色。

  • 一个用于托管 Lambda 函数的 Amazon S3 存储桶。

您可以手动创建这些资源,但我们建议 Amazon CloudFormation 按照本教程中的说明使用配置这些资源。

使用创建 Amazon 资源 Amazon CloudFormation

Amazon CloudFormation 使您能够以可预测的方式重复创建和配置 Amazon 基础架构部署。有关的更多信息 Amazon CloudFormation,请参阅《Amazon CloudFormation 用户指南》

要使用以下方法创建 Amazon CloudFormation 堆栈 Amazon CLI:

  1. 按照《 Amazon CLI Amazon CLI 用户指南》中的说明进行安装和配置。

  2. 在项目文件夹的根目录setup.yaml中创建一个名为的文件,然后将此处的内容复制 GitHub到该文件中。

    注意

    该 Amazon CloudFormation 模板是使用此处 Amazon CDK 提供的模板生成的 GitHub。有关更多信息 Amazon CDK,请参阅《Amazon Cloud Development Kit (Amazon CDK) 开发人员指南》

  3. 从命令行运行以下命令,替换 STACK_NAME 为堆栈使用唯一的名称。

    重要

    堆栈名称在 Amazon 区域和 Amazon 账户中必须是唯一的。您最多可指定 128 个字符,支持数字和连字符。

    aws cloudformation create-stack --stack-name STACK_NAME --template-body file://setup.yaml --capabilities CAPABILITY_IAM

    有关 create-stack 命令参数的更多信息,请参阅 Amazon CLI 命令参考指南Amazon CloudFormation 用户指南

  4. 接下来,按照填充表过程填充表。

填充表

要填充表,请先创建一个名为 libs 的目录,然后在其中创建一个名为 dynamoClient.js 的文件,再将下面的内容粘贴到其中。

const { DynamoDBClient } = require ( "@aws-sdk/client-dynamodb" ); // Set the AWS Region. const REGION = "REGION"; // e.g. "us-east-1" // Create an Amazon Lambda service client object. const dynamoClient = new DynamoDBClient({region:REGION}); module.exports = { dynamoClient };

此代码可从此处获得 GitHub。

接下来,在项目文件夹的根目录populate-table.js中创建一个名为的文件,然后将此处的内容复制 GitHub到其中。对于其中一项,将 phone 属性的值替换为 E.164 格式的有效手机号码,将 startDate 的值替换为今天的日期。

在命令行处,运行以下命令。

node populate-table.js
const { BatchWriteItemCommand } = require ( "aws-sdk/client-dynamodb" ); const {dynamoClient} = require ( "./libs/dynamoClient" ); // Set the parameters. export const params = { RequestItems: { Employees: [ { PutRequest: { Item: { id: { N: "1" }, firstName: { S: "Bob" }, phone: { N: "155555555555654" }, startDate: { S: "2019-12-20" }, }, }, }, { PutRequest: { Item: { id: { N: "2" }, firstName: { S: "Xing" }, phone: { N: "155555555555653" }, startDate: { S: "2019-12-17" }, }, }, }, { PutRequest: { Item: { id: { N: "55" }, firstName: { S: "Harriette" }, phone: { N: "155555555555652" }, startDate: { S: "2019-12-19" }, }, }, }, ], }, }; export const run = async () => { try { const data = await dbclient.send(new BatchWriteItemCommand(params)); console.log("Success", data); } catch (err) { console.log("Error", err); } }; run();

此代码可从此处获得 GitHub。

创建 Amazon Lambda 函数

正在配置 SDK

libs 目录中,创建名为 snsClient.jslambdaClient.js 的文件,并将以下内容分别粘贴到这些文件中。

const { SNSClient } = require("@aws-sdk/client-sns"); // Set the AWS Region. const REGION = "REGION"; //e.g. "us-east-1" // Create an Amazon SNS service client object. const snsClient = new SNSClient({ region: REGION }); module.exports = { snsClient };

Replace(替换) REGION 与该 Amazon 地区合作。此代码可从此处获得 GitHub。

const { LambdaClient } = require("@aws-sdk/client-lambda"); // Set the AWS Region. const REGION = "REGION"; //e.g. "us-east-1" // Create an Amazon Lambda service client object. const lambdaClient = new LambdaClient({ region: REGION }); module.exports = { lambdaClient };

Replace(替换) REGION 与该 Amazon 地区合作。此代码可从此处获得 GitHub。

首先,导入所需的 Amazon SDK for JavaScript (v3) 模块和命令。然后计算今天的日期并将其分配给一个参数。然后,为 ScanCommand 创建参数。Replace(替换) TABLE_NAME 使用您在本示例创建 Amazon 资源 部分中创建的表的名称。

下面的代码段演示了此步骤。(有关完整示例,请参阅捆绑 Lambda 函数。)

const { ScanCommand } = require("@aws-sdk/client-dynamodb"); const { PublishCommand } = require("@aws-sdk/client-sns"); const { snsClient } = require("./libs/snsClient"); const { dynamoClient } = require("./libs/dynamoClient"); // Get today's date. const today = new Date(); const dd = String(today.getDate()).padStart(2, "0"); const mm = String(today.getMonth() + 1).padStart(2, "0"); //January is 0! const yyyy = today.getFullYear(); const date = `${yyyy}-${mm}-${dd}`; // Set the parameters for the ScanCommand method. const params = { // Specify which items in the results are returned. FilterExpression: "startDate = :topic", // Define the expression attribute value, which are substitutes for the values you want to compare. ExpressionAttributeValues: { ":topic": { S: date }, }, // Set the projection expression, which are the attributes that you want. ProjectionExpression: "firstName, phone", TableName: "Employees", };

扫描 DynamoDB 表

首先,创建一个名为 async/await 函数sendText,用于使用 Amazon 发布短信。SNS PublishCommand然后,添加一个 try 块模式,用于扫描 DynamoDB 表中是否有工作周年纪念日在今天的员工,然后调用 sendText 函数向这些员工发送短信。如果发生错误,则将调用 catch 块。

下面的代码段演示了此步骤。(有关完整示例,请参阅捆绑 Lambda 函数。)

// Helper function to send message using Amazon SNS. exports.handler = async () => { // Helper function to send message using Amazon SNS. async function sendText(textParams) { try { await snsClient.send(new PublishCommand(textParams)); console.log("Message sent"); } catch (err) { console.log("Error, message not sent ", err); } } try { // Scan the table to identify employees with work anniversary today. const data = await dynamoClient.send(new ScanCommand(params)); for (const element of data.Items) { const textParams = { PhoneNumber: element.phone.N, Message: `Hi ${element.firstName.S}; congratulations on your work anniversary!`, }; // Send message using Amazon SNS. sendText(textParams); } } catch (err) { console.log("Error, could not scan table ", err); } };

捆绑 Lambda 函数

本主题介绍如何将本示例的模块mylambdafunction.ts和必需的 Amazon SDK for JavaScript 模块捆绑到名index.js为的捆绑文件中。

  1. 如果您尚未安装 Webpack,请按照本示例中的完成先决条件任务部分进行安装。

    注意

    有关 Webpack 的信息,请参阅将应用程序与 webpack 捆绑在一起

  2. 在命令行中运行以下命令,将本示例 JavaScript 的捆绑到名为的文件中<index.js>

    webpack mylambdafunction.ts --mode development --target node --devtool false --output-library-target umd -o index.js
    重要

    请注意,输出被命名为 index.js。这是因为 Lambda 函数必须有一个 index.js 处理程序才能工作。

  3. 将捆绑的输出文件压缩成名mylambdafunction.zip为的ZIP文件。index.js

  4. mylambdafunction.zip 上传到您在本教程的创建 Amazon 资源 主题中创建的 Amazon S3 存储桶。

部署 Lambda 函数

在项目的根目录中,创建一个 lambda-function-setup.ts 文件,然后将以下内容粘贴到其中。

Replace(替换) BUCKET_NAME 使用您将 Lambda 函数ZIP版本上传到的 Amazon S3 存储桶的名称。Replace(替换) ZIP_FILE_NAME 使用名称命名您的 Lambda 函数的ZIP版本。Replace(替换) ROLE 使用您在本教程创建 Amazon 资源 主题中创建的IAM角色的 Amazon 资源编号 (ARN)。Replace(替换) LAMBDA_FUNCTION_NAME 带有 Lambda 函数的名称。

// Load the required Lambda client and commands. const { CreateFunctionCommand } = require ( "@aws-sdk/client-lambda" ); const { lambdaClient} = require ( "./libs/lambdaClient.js ); // Set the parameters. const params = { Code: { S3Bucket: "BUCKET_NAME", // BUCKET_NAME S3Key: "ZIP_FILE_NAME", // ZIP_FILE_NAME }, FunctionName: "LAMBDA_FUNCTION_NAME", Handler: "index.handler", Role: "IAM_ROLE_ARN", // IAM_ROLE_ARN; e.g., arn:aws:iam::650138640062:role/v3-lambda-tutorial-lambda-role Runtime: "nodejs12.x", Description: "Scans a DynamoDB table of employee details and using Amazon Simple Notification Services (Amazon SNS) to " + "send employees an email on each anniversary of their start-date.", }; const run = async () => { try { const data = await lambdaClient.send(new CreateFunctionCommand(params)); console.log("Success", data); // successful response } catch (err) { console.log("Error", err); // an error occurred } }; run();

在命令行中输入以下内容以部署 Lambda 函数。

node lambda-function-setup.ts

此代码示例可在此处找到 GitHub

将API网关配置为调用 Lambda 函数

创建其余的 API

您可以使用API网关控制台为 Lambda 函数创建休息终端节点。完成后,您就可以使用 restful 调用来调用 Lambda 函数。

  1. 登录 Amazon API Gateway 控制台

  2. 在 “休息” 下API,选择 “构建”。

  3. 选择新建API

    DynamoDB 表
  4. 将 “员工” 指定为API姓名并提供描述。

    DynamoDB 表
  5. 选择 “创建” API。

  6. Employee 部分下选择资源

    DynamoDB 表
  7. 在名称字段中,指定员工

  8. 选择创建资源

  9. 操作下拉菜单中,选择创建资源

    DynamoDB 表
  10. 选择 /employ ees,从 “操作” 中选择 “创建方法”,然后从/emplo GETyees 下方的下拉菜单中进行选择。选择复选标记图标。

    DynamoDB 表
  11. 选择 Lambda 函数并输入 mmylambdafunction 作为 Lambda 函数名称。选择保存

测试网API关方法

在本教程中,您可以测试调用 my lambdafunction Lambda 函数的 API Gateway 方法。要测试该方法,请选择测试,如下图所示。

DynamoDB 表

调用 Lambda 函数后,您可以查看日志文件以查看成功消息。

部署网API关方法

测试成功后,您可以从 Amazon API Gateway 控制台部署该方法。

  1. 选择 GET

    DynamoDB 表
  2. 从 “操作” 下拉列表中,选择 “部署” API。

    DynamoDB 表
  3. 填写 “部” API 表单并选择 “部署”。

    DynamoDB 表
  4. 选择 Save Changes(保存更改)。

  5. 再次选择 “获取”,并注意URL发生了变化。这是您可以URL用来调用 Lambda 函数的调用。

    DynamoDB 表

删除资源

恭喜您!您已使用 Amazon Gate API way 调用了 Lambda 函数。 Amazon SDK for JavaScript如本教程开头所述,请务必在学习本教程时终止您创建的所有资源,以确保系统不会向您收费。您可以通过删除在本教程创建 Amazon 资源 主题中创建的 Amazon CloudFormation 堆栈来实现此目的,如下所示:

  1. Amazon CloudFormation 在 Amazon 管理控制台中打开。

  2. 打开堆栈页面,然后选择堆栈。

  3. 选择删除