亚马逊AWS官方博客

使用 Lambda Web Adapter在Lambda上 构建 web应用

背景介绍

Amazon Lambda 可结合 Amazon API Gateway 或 Application Load Balancer,使您无需提前启动或管理服务器即可运行基于 restful API 的应用程序。此时,Lambda 将以 JSON 格式的字符串接收 http 事件,并将其转换为对象,它将事件对象以及上下文传递给Lambda函数。而对于已经开发好的 Web 应用程序,您可能需要做一定的改造适配才能部署到已经存在的Lambda。

现在,我们推出了Lambda Web Adapter 方案,您可以在不改造已有WEB应用程序代码,使用熟悉的框架(例如 Express.js、Flask、SpringBoot 和 Laravel,或任何使用 HTTP 1.1/1.0)构建 Web 应用程序并在 Amazon Lambda 上运行它。

文章目的

本文以 nodejs express web 应用程序为例,介绍如何在不修改原有 nodejs 代码情况下,使用 Lambda Web Adapter 开发和部署一个 express web应用部署到 Lambda。

如何工作

Amazon Lambda Web Adapter 实际上是一个 Lambda Extensions,当 docker 镜像在 Amazon Lambda 中运行时,Lambda 会自动启动 Adapter 和运行时进程。在 Lambda Web Adapter 启动应用程序后,将每 10 毫秒对 http://localhost:8080/ 执行一次就绪检查。它将在收到应用程序的 200 响应后,启动 lambda 运行时客户端,并将http请求转发到 http://localhost:8080  。 这允许开发人员在不需要修改代码的情况下,将其 Web 应用程序打包为容器映像,并运行到 Amazon Lambda 。

目前 Lambda Web Adapter 可以使用Amazon API Gateway Rest API, HTTP API, Application Load Balancer和Lambda Function URLs,接收HTTP请求。然后调用Lambda function执行代码逻辑,Lambda Adapter将前端请求转换为 http 请求并发送到 Web 应用程序,等到 web 应用程序处理好之后,再将 http 响应转换回 lambda 事件响应

开始使用 Lambda Web Adapter

可以选择Docker镜像或者Zip包两种方式进行代码部署,请选择自己喜欢的方式迁移或构建您的 web 应用程序。

前提条件:

配置和安装 sam cli:

https://docs.aws.amazon.com/zh_cn/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html

option1: 打包为 Docker 镜像或 OCI 镜像的 Lambda 函数

可选操作:

要将 Lambda Web Adapter 与 Docker 镜像一起使用,请将您的 Web 应用程序 (http api) 打包到 Dockerfile 中,然后添加一行以将 Lambda Web Adapter 二进制文件复制到容器内的 /opt/extensions。默认情况下,Lambda 适配器假定 Web 应用程序正在侦听端口 8080。如果不是,您可以通过配置指定端口。在 Lambda 之外运行时,Lambda Web Adapter 根本不运行。

COPY --from=public.ecr.aws/awsguru/aws-lambda-adapter:0.3.2 /lambda-adapter /opt/extensions/lambda-adapter

ECR 公共存储库中提供了预编译的 Lambda 适配器二进制文件:public.ecr.aws/awsguru/aws-lambda-adapter。此 repo 中还提供了多架构镜像。适用于 x86_64 和 arm64 CPU 架构。

下面是一个示例 nodejs 应用程序的 Dockerfile:

FROM public.ecr.aws/docker/library/node:16.13.2-stretch-slim
COPY --from=public.ecr.aws/awsguru/aws-lambda-adapter:0.3.2 /lambda-adapter /opt/extensions/lambda-adapter
EXPOSE 8080
WORKDIR "/var/task"
ADD src/package.json /var/task/package.json
ADD src/package-lock.json /var/task/package-lock.json
RUN npm install --production
ADD src/ /var/task
CMD ["node", "index.js"]

开始迁移 nodejs express hello world:

以下示例说明如何使用 Lambda 适配器在运行 express.js  docker应用程序,部署工具使用SAM,因此前提条件是需要安装aws cli(https://aws.amazon.com/cli/),sam cli(https://github.com/awslabs/aws-sam-cli),docker(https://www.docker.com/products/docker-desktop),nodejs(https://nodejs.org/en/):

  1. 下载example代码到开发环境电脑,https://github.com/awslabs/aws-lambda-web-adapter/
  2. 进入example目录
cd aws-lambda-web-adapter/examples/expressjs
  1. 登陆docker,用于构建image镜像
aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
  1. 构建和部署
sam build
sam deploy --guided

部署时需要输入一些选项,如下图所示

  1. 执行以上命令成功后,输出API url

  1. 进行 curl 测试访问,显示 “Hi there!”

  1. 清理资源
sam delete

部署过程中如果遇到报错,可以登陆控制台手动删除该sam对应的cloudformation模板,然后重新开始部署。

以上example代码适用于除 Amazon 托管基础镜像之外的任何基础镜像。

Amazon 提供了一组可用于创建容器映像的基础映像,这些基础镜像包括运行时接口客户端,用于管理 Lambda 和函数代码之间的交互。要使用 Amazon 托管基础映像,您需要覆盖 ENTRYPOINT 以启动您的 Web 应用程序。以下Dockfile使用Amazon Lambda基础镜像:

FROM public.ecr.aws/lambda/nodejs:14
COPY --from=public.ecr.aws/awsguru/aws-lambda-adapter:0.3.1 /opt/extensions/lambda-adapter /opt/extensions/lambda-adapter
EXPOSE 8080
WORKDIR "/var/task"
ADD src/package.json /var/task/package.json
ADD src/package-lock.json /var/task/package-lock.json
RUN npm install --production
ADD src/index.js /var/task/index.js
ENTRYPOINT [ "node", "index.js" ]

然后重新进行构建和部署

sam build
sam deploy --guided

如果遇到测试报错,可以在console上找到部署的lambda函数,查看cloudwathc 日志。

option2: 打包为 Zip 包的 Lambda 函数(使用Amazon 托管运行时)

Amazon Lambda Web Adapter 也适用于 Amazon 托管的 Lambda 运行时。你需要做三件事:

  1. 将Lambda Web Adapter layer附加到您的函数。
    1. x86_64: arn:aws:lambda:${AWS::Region}:753240598075:layer:LambdaAdapterLayerX86:2
    2. arm64: arn:aws:lambda:${AWS::Region}:753240598075:layer:LambdaAdapterLayerArm64:2
  2. 将 Lambda 环境变量 AWS_LAMBDA_EXEC_WRAPPER 配置为 /opt/bootstrap。
  3. 将function handler设置为您的 Web 应用程序启动脚本。例如sh

以下示例说明如何使用 Lambda 适配器在运行 express.js 应用程序,部署工具使用SAM,因此前提条件是需要安装aws cli,sam cli,nodejs:

  1. 下载example代码到开发环境电脑,https://github.com/awslabs/aws-lambda-web-adapter/
  2. 进入example目录,cd aws-lambda-web-adapter/examples/expressjs-zip
  3. 构建和部署
sam build
sam deploy --guided

部署时需要输入一些选项,如下图所示

  1. 执行以上命令成功后,输出API url

  1. 进行 curl 测试访问,显示 “Hi there!”

  1. 清理资源
sam delete

配置说明

可以修改默认配置,使用环境变量配置就绪检查端口/路径和流量端口。这些环境变量可以在 docker 文件中定义,也可以定义为 Lambda 函数配置。

Environment Variable Description Default
1 READINESS_CHECK_PORT readiness check port 8080
2 READINESS_CHECK_PATH readiness check path /
3 PORT traffic port 8080
4 REMOVE_BASE_PATH the base path to be removed from request path empty string

REMOVE_BASE_PATH – 此环境变量的值告诉Lambda Web Adapter是否在base path下运行。例如,您可以将 API  Gateway配置为具有 /orders/{proxy+} 和 /catalog/{proxy+} 资源。每个资源都由单独的 Lambda 函数处理。因此,Lambda 内部的应用程序可能不知道 /orders 路径存在这一事实。将请求路由到应用程序时,使用 REMOVE_BASE_PATH 删除 /orders 前缀。默认为空字符串。

各种语言的Example参考

除了使用 Nodejs express 之外,如果您使用的是 Flask,SpringBoot 等web 框架开发web 程序,可以从以下各种语言的Example示例开始,方便您使用自己熟悉的框架开发基于Lambda 的web 应用程序

Flask:https://github.com/awslabs/aws-lambda-web-adapter/blob/main/examples/flask

Express.js:https://github.com/awslabs/aws-lambda-web-adapter/blob/main/examples/expressjs

Express.js in Zip:https://github.com/awslabs/aws-lambda-web-adapter/blob/main/examples/expressjs-zip

SpringBoot:https://github.com/awslabs/aws-lambda-web-adapter/blob/main/examples/springboot

nginx:https://github.com/awslabs/aws-lambda-web-adapter/blob/main/examples/nginx

php:https://github.com/awslabs/aws-lambda-web-adapter/blob/main/examples/php

收益和总结

HTTP 1.1 协议是目前最主流的应用层协议,借助 Lambda Web Adapter ,我们可以在Lambda 中开发和部署任何兼容 HTTP 1.1/1.0 web 框架,例如 Nodejs express, php WordPress, python Flask, nginx, java SpringBoot 等等, 还能利用 Lambda 省去了大部分的运维工作,同时实现自动容量调配和弹性伸缩。

参考资料

Lambda Web Adapter开源文档:https://github.com/awslabs/aws-lambda-web-adapter

Lambda服务:https://aws.amazon.com/cn/lambda/

SAM CLI:https://docs.aws.amazon.com/zh_cn/serverless-application-model/latest/developerguide/serverless-sam-cli-install-mac.html

AWS CLI:https://docs.aws.amazon.com/zh_cn/cli/latest/userguide/cli-configure-files.html

如何开发参考:https://github.com/awslabs/aws-lambda-web-adapter/blob/main/docs/development.md

本篇作者

谢佰臻

Amazon Web Services公司解决方案架构师,负责基于云计算方案架构的咨询和设计,目前专注于Serverless、DevSecOps。

王寒冰

亚马逊云科技解决方案架构师,负责基于AWS云计算方案的架构咨询和设计实现,具有丰富的解决客户实际问题的经验,专注于容器化,无服务器化的应用。