1个不稳定版本

0.3.0 2021年1月22日

#5#alb

Apache-2.0

48KB
896

Rust运行时,适用于AWS Lambda

本软件包使运行用Rust编写的AWS Lambda函数变得容易。

⚠️ ⚠️ ⚠️ 👷 👷 👷 🍴 🍴 🍴

这是AWS Lambda官方Rust运行时的分支。我们创建这个分支是为了能够推动社区的所有贡献,这些贡献在awslabs仓库中停滞不前,而没有任何发布的迹象。

Lambda运行时 包含运行时组件。 Lambda属性 包含用于创建Lambda函数的宏定义。 Lambda HTTP 包含通过HTTP端点访问的Lambda函数的创建定义。

⚠️ ⚠️ ⚠️ 👷 👷 👷 🍴 🍴 🍴

示例函数

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

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

#[tokio::main]
async fn main() -> Result<(), Error> {
    run(handler_fn(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 crate中的基本示例 相同。

部署

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

AWS CLI

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

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

$ rustup target add x86_64-unknown-linux-musl
  • 注意:如果您在Mac OS上运行,则需要为目标平台安装链接器。您可以通过从 Homebrew 安装 musl-cross tap 来完成此操作,该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 --example hello --release --target x86_64-unknown-linux-musl

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

$ cp ./target/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包与API Gateway进行交互(注意,这将是一个git依赖项,直到0.2版本发布)。
  • 一个组合的multi函数服务,用于展示如何设置具有多个独立函数的服务。

假设您的宿主机的Node.js版本相对较新,您将不需要安装任何全局的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

lambda

lambda是一个用于编写可靠和高效Rust基于AWS Lambda函数的库。从高层次来看,它提供了一些主要组件:

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

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

自定义事件对象

为了序列化和反序列化事件和响应,我们建议使用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(())
}

依赖项

~9–20MB
~269K SLoC