1 个不稳定版本

0.3.0-patched.12021 年 5 月 20 日

#1123HTTP 服务器


用于 3 个 Crates(2 个直接使用)

Apache-2.0

40KB
827

Rust Runtime for AWS Lambda

Build Status

此包使运行用 Rust 编写的 AWS Lambda 函数变得容易。此工作区包含多个 Crates

  • 文档 lambda-runtime 是一个为用 Rust 编写的应用程序提供 Lambda 运行的库。
  • 文档 lambda-http 是一个库,它使用 Rust 编写 API Gateway 代理事件聚焦的 Lambda 函数变得容易。

示例函数

下面的代码创建了一个简单的函数,该函数接收一个包含 firstName 字段的 event 并向调用者返回一条消息。注意:此 crate 对最新的稳定 Rust 进行了测试。

use lambda_runtime::{handler_fn, Context, Error};
use serde_json::{json, Value};

#[tokio::main]
async fn main() -> Result<(), Error> {
    let func = handler_fn(func);
    lambda_runtime::run(func).await?;
    Ok(())
}

async fn func(event: Value, _: Context) -> Result<Value, Error> {
    let first_name = event["firstName"].as_str().unwrap_or("world");

    Ok(json!({ "message": format!("Hello, {}!", first_name) }))
}

上面的代码与 lambda_runtime crate 中的 基本示例 相同。

部署

目前有几种方法可以构建此包:使用 AWS CLI 手动构建,以及使用 Serverless 框架

AWS CLI

要将基本示例作为Lambda函数部署,使用AWS CLI,我们首先需要使用cargo手动构建它。由于Lambda使用Amazon Linux,您需要为目标平台x86_64-unknown-linux-musl编译您的可执行文件。

运行此脚本一次以添加新目标

$ rustup target add x86_64-unknown-linux-musl
  • 注意:如果您正在Mac OS上运行,您需要为目标平台安装链接器。您可以通过从Homebrew安装musl-cross tap来实现,它为Mac OS提供完整的交叉编译工具链。一旦安装了musl-cross,在为x86_64-unknown-linux-musl平台构建时,我们还需要通知cargo新安装的链接器。
$ brew install filosottile/musl-cross/musl-cross
$ mkdir .cargo
$ echo $'[target.x86_64-unknown-linux-musl]\nlinker = "x86_64-linux-musl-gcc"' > .cargo/config

将其中一个示例编译为发布版,并指定特定目标以部署到AWS

$ cargo build -p lambda_runtime --example basic --release --target x86_64-unknown-linux-musl

对于自定义运行时,AWS Lambda会在部署包zip中查找名为bootstrap的可执行文件。将生成的basic可执行文件重命名为bootstrap并将其添加到zip存档中。

$ cp ./target/x86_64-unknown-linux-musl/release/examples/hello ./bootstrap && zip lambda.zip bootstrap && rm bootstrap

现在我们有了部署包(lambda.zip),我们可以使用AWS CLI创建一个新的Lambda函数。请确保将执行角色替换为您账户中现有的角色!

$ aws lambda create-function --function-name rustTest \
  --handler doesnt.matter \
  --zip-file fileb://./lambda.zip \
  --runtime provided \
  --role arn:aws:iam::XXXXXXXXXXXXX:role/your_lambda_execution_role \
  --environment Variables={RUST_BACKTRACE=1} \
  --tracing-config Mode=Active

您现在可以使用AWS CLI或AWS Lambda控制台测试该函数

$ aws lambda invoke --function-name rustTest \
  --payload '{"firstName": "world"}' \
  output.json
$ cat output.json  # Prints: {"message": "Hello, world!"}

注意:当使用AWS CLI版本2时,--cli-binary-format raw-in-base64-out是一个必需的参数。更多信息

Serverless Framework

或者,您可以使用Serverless框架Rust插件声明性地构建基于Rust的Lambda函数。

存在许多入门级Serverless应用程序模板,可以帮助您快速启动

  • 一个最小echo函数,演示最小的Rust函数设置看起来像什么
  • 一个最小http函数,演示如何使用Rust的本地http crate与API Gateway进行接口(注意,这将是git依赖项,直到0.2发布)
  • 一个组合multi函数服务,演示如何设置具有多个独立函数的服务

假设您的宿主机安装了相对较新的node版本,您不需要安装任何全局的serverless依赖项。要开始,运行以下命令创建一个新的lambda Rust应用程序并安装项目级依赖项。

$ npx serverless install \
  --url https://github.com/softprops/serverless-aws-rust \
  --name my-new-app \
  && cd my-new-app \
  && npm install --silent

使用标准serverless工作流程部署它

# build, package, and deploy service to aws lambda
$ npx serverless deploy

使用serverless框架或配置的AWS集成触发源调用它

$ npx serverless invoke -f hello -d '{"foo":"bar"}'

Docker

或者,您可以在AWS Lambda提供的运行时的docker镜像中构建基于Rust的Lambda函数,其中预安装了Rust工具链。

运行以下命令将启动一个临时的docker容器,该容器将构建您的Rust应用程序,并生成一个zip文件,其中包含其二进制文件,自动重命名为bootstrap,以满足AWS Lambda对二进制文件的要求,通常这仅仅是您crate的名称,如果您使用的是cargo默认的二进制文件(即main.rs

# build and package deploy-ready artifact
$ docker run --rm \
    -v ${PWD}:/code \
    -v ${HOME}/.cargo/registry:/root/.cargo/registry \
    -v ${HOME}/.cargo/git:/root/.cargo/git \
    softprops/lambda-rust

您的应用程序构建和打包完成后,即可部署到生产环境。您还可以使用lambdaci:提供的Docker容器在本地调用它,以验证其行为。这是一个省略了构建依赖项的AWS Lambda提供的运行时的镜像。

# start a docker container replicating the "provided" lambda runtime
# awaiting an event to be provided via stdin
$ unzip -o \
    target/lambda/release/{your-binary-name}.zip \
    -d /tmp/lambda && \
  docker run \
    -i -e DOCKER_LAMBDA_USE_STDIN=1 \
    --rm \
    -v /tmp/lambda:/var/task \
    lambci/lambda:provided

# provide an event payload via stdin (typically a json blob)

# Ctrl-D to yield control back to your function

调试

可以使用由@rimutaka维护的特别Lambda调试代理(非AWS仓库)在本地运行和调试Lambdas。这是一个将传入请求转发到一个AWS SQS队列并从另一个队列读取响应的Lambda函数。运行在您开发计算机上的本地代理读取队列,在本地调用您的lambda并返回响应。这种方法允许在AWS工作流中本地调试Lambda函数,而不需要在本地和AWS版本之间修改lambda处理程序代码。

lambda

lambda_runtime是一个用于编写可靠和性能优良的基于Rust的AWS Lambda函数的库。在较高层面,它提供了一些主要组件

  • Handler,一个定义客户编写的代码与该库之间交互的trait。
  • lambda_runtime::run,运行Handler的函数。

handler_fn函数将Rust函数或闭包转换为Handler,然后可以被lambda_runtime::run运行。

AWS事件对象

虽然我们打算在将来包括Lambda事件结构定义,但该项目目前尚未包含。相反,可以利用社区维护的aws_lambda_events crate提供强类型Lambda事件结构。您还可以创建自己的自定义事件对象及其对应的结构。

自定义事件对象

为了序列化和反序列化事件和响应,我们建议使用serde库。为了接收自定义事件,使用Serde的宏注解您的结构。

use serde::{Serialize, Deserialize};
use serde_json::json;
use std::error::Error;

#[derive(Serialize, Deserialize)]
pub struct NewIceCreamEvent {
  pub flavors: Vec<String>,
}

#[derive(Serialize, Deserialize)]
pub struct NewIceCreamResponse {
  pub flavors_added_count: usize,
}

fn main() -> Result<(), Box<Error>> {
    let flavors = json!({
      "flavors": [
        "Nocciola",
        "抹茶",
        "आम"
      ]
    });

    let event: NewIceCreamEvent = serde_json::from_value(flavors)?;
    let response = NewIceCreamResponse {
        flavors_added_count: event.flavors.len(),
    };
    serde_json::to_string(&response)?;

    Ok(())
}

依赖项

~6–8.5MB
~151K SLoC