使用 .NET 7 NativeAOT 在 AWS 上构建 Serverless 应用程序

11/28/2022 02:50:28 | China Standard Time

NativeAOT 使 .NET 代码能够提前编译为本机二进制文件，与 .NET 6 托管运行时相比，冷启动速度提高了 86%。NativeAOT 的快速执行和较低的内存消耗也可以降低 Lambda 成本。这篇文章介绍了如何开始使用 NativeAOT 在 AWS Lambda 上运行 .NET 7 应用程序。

# 什么是 NativeAOT ?

本机 AOT 允许将 .NET 应用程序预编译为单个二进制文件，无需 JIT 和 .NET Runtime。要使您的应用程序在 AWS Lambda 中可用，程序中还需要包含 [Lambda runtime client](https://github.com/aws/aws-lambda-dotnet/blob/master/Libraries/src/Amazon.Lambda.RuntimeSupport/README.md)。Lambda runtime client 会将您的应用程序与 AWS Lambda Runtime API 集成，从而使您的应用程序代码能够由 AWS Lambda 调用。

您可以使用 dotnet CLI ([Amazon.Lambda.Tools](https://github.com/aws/aws-extensions-for-dotnet-cli/#aws-lambda-amazonlambdatools)) 或 [AWSToolkit for Visual Studio](https://aws.amazon.com/visualstudio/) 和 [AWSServerless Application Model](https://aws.amazon.com/serverless/sam/) (AWS SAM 用于构建无服务器应用程序的开源框架) 来构建和部署 AWS Lambda。

本机 AOT 为特定操作系统编译代码。如果在计算机上运行 `dotnet publish` 命令，则编译的代码仅支持在对应体系结构的系统上运行。要使用 NativeAOT 在 Lambda 中运行您的应用程序，必须在 [Amazon Linux 2](https://aws.amazon.com/amazon-linux-2/) (AL2) 操作系统上编译代码。新工具支持在基于 AL2 的 Docker 映像中编译 Lambda 函数，并将编译的应用程序存储在本地硬盘驱动器上。您也可以在本地编译代码后上传到 Lambda。


# 使用 NativeAOT 开发 Lambda functions

接下来我们将讨论如何开发与 .NET 7 NativeAOT 兼容的 Lambda functions 代码。.NET 7 这是微软发布的 NativeAOT 的第一个 GA 版本。它可能不适合所有工作负载。例如，`动态程序集加载` 和 `System.Reflection.Emit` 库不可用。NativeAOT 还会修剪应用程序代码，从而生成一个很小二进制文件，其中包含应用程序运行的基本组件。


## 环境

- [.NET 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
- [Amazon.Lambda.Tools.NET CLI](https://github.com/aws/aws-extensions-for-dotnet-cli/#aws-lambda-amazonlambdatools) v5.6.0 或更高版本

## 创建

首先使用 .NET CLI 创建一个 NativeAOT Lambda 项目。

```bash
dotnet new lambda.NativeAOT -n LambdaNativeAot
cd ./LambdaNativeAot/src/LambdaNativeAot/
dotnet add package Amazon.Lambda.APIGatewayEvents
dotnet add package AWSSDK.Core
```

若要查看项目设置，请打开 `LambdaNativeAot.csproj` 文件。此模板中的目标框架为`net7.0` 。若要启用 NativeAOT，请添加一个名为 `PublishAot` 新属性并标识为 `true`。此标志是 .NET SDK 所需的 MSBuild 属性，以便编译器执行本机 AOT 编译。

将 Lambda 与自定义运行时配合使用时，Lambda 服务会在打包的 ZIP 文件中查找名为 `bootstrap` 的可执行文件。要启用此功能，需要将 `OutputType` 设置为 `exe` 并将 `AssemblyName` 设置为 `bootstrap`。

```xml
<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net7.0</TargetFramework>
        <ImplicitUsings>enable</ImplicitUsings>
        <Nullable>enable</Nullable>
        <AWSProjectType>Lambda</AWSProjectType>
        <AssemblyName>bootstrap</AssemblyName>
        <PublishAot>true</PublishAot>
    </PropertyGroup> 
    …
</Project>
```

## 代码

如果要使用自定义运行时运行 .NET 应用程序。您的代码必须定义静态 Main 方法。在 Main 方法中，您必须初始化 Lambda 运行时客户端，并配置要在处理 Lambda 事件时使用的函数处理程序和 JSON 序列化程序。

> 您需要将 [Amazon.Lambda.RuntimeSupportNuget](https://github.com/aws/aws-lambda-dotnet/blob/master/Libraries/src/Amazon.Lambda.RuntimeSupport/README.md) 包将添加到项目中以启用此运行时初始化。并使用 `LambdaBootstrapBuilder.Create()` 方法配置处理程序和实现 `ILambdaSerializer` 用于（反）序列化。

```csharp
private static async Task Main(string[] args)
{
    Func<string, ILambdaContext, string> handler = FunctionHandler;
    await LambdaBootstrapBuilder.Create(handler, new DefaultLambdaJsonSerializer())
        .Build()
        .RunAsync();
}
```

## 程序集修剪

NativeAOT 修剪应用程序代码以优化编译的二进制文件，这可能会导致两个问题。
- .NET 中常见的 JSON 库如 ([Newtonsoft.Json](https://www.newtonsoft.com/json) 和 [System.Text.Json](https://learn.microsoft.com/en-us/dotnet/api/system.text.json?view=net-6.0)) 依赖于反射。

- 编译器可能会裁剪掉未对 AOT 优化的第三方库所需的依赖。

> 目前这两个问题都有对应的解决方案。

### 使用 JSON

源生成的序列化是 .NET 6 中引入的一项语言功能。它允许在编译时生成反序列化所需的代码，而不是在运行时依赖于反射。本机AOT的一个缺点是无法使用 `System.Relefection.Emit` 库。源生成的序列化使开发人员能够在使用本机 AOT 的同时使用 JSON。

若要使用源生成器，必须定义一个新的空分部类，该类继承自 System.Text.Json.JsonSerializerContext。在空分部类上，为序列化的类型添加 JsonSerializable 属性。

在此示例中，Lambda 函数需要从 API 网关接收事件。在项目中创建一个 `HttpApiJsonSerializerContext` 类并复制以下代码：

```csharp
[JsonSerializable(typeof(APIGatewayHttpApiV2ProxyRequest))]
[JsonSerializable(typeof(APIGatewayHttpApiV2ProxyResponse))]
public partial class HttpApiJsonSerializerContext : JsonSerializerContext { }
```

编译应用程序时，源生成器将生成静态类、属性和方法的代码来执行反序列化。

现在还必须将此自定义序列化程序传入 Lambda 运行时，以确保正确序列化和反序列化事件输入和输出。为此，请在引导时将序列化程序上下文的新实例传递到运行时。

```csharp
using System.Text.Json.Serialization;
using Amazon.Lambda.APIGatewayEvents;
using Amazon.Lambda.Core;
using Amazon.Lambda.RuntimeSupport;
using Amazon.Lambda.Serialization.SystemTextJson;
namespace LambdaNativeAot;
public class Function
{
    /// <summary>
    /// The main entry point for the custom runtime.
    /// </summary>
    private static async Task Main()
    {
        Func<APIGatewayHttpApiV2ProxyRequest, ILambdaContext, Task<APIGatewayHttpApiV2ProxyResponse>> handler = FunctionHandler;
        await LambdaBootstrapBuilder.Create(handler, new SourceGeneratorLambdaJsonSerializer<HttpApiJsonSerializerContext>())
            .Build()
            .RunAsync();
    }

    public static async Task<APIGatewayHttpApiV2ProxyResponse> FunctionHandler(APIGatewayHttpApiV2ProxyRequest apigProxyEvent, ILambdaContext context)
    {
        // API Handling logic here
        return new APIGatewayHttpApiV2ProxyResponse()
        {
            StatusCode = 200,
            Body = "OK"
        };
    }
}
```

### 第三方库

.NET 编译器提供了`控制修剪应用程序`的功能。对于未对 NativeAOT 优化的第三方程序集，我们可以通过配置排除对此程序集的修剪。这对于任何 Lambda 事件源 NuGet 包（如 Amazon.Lambda.ApiGatewayEvents）都很重要。如果不对此进行控制，则会修剪 Amazon API 网关事件源的 C# 对象，从而导致运行时出现序列化错误。

若要控制程序集修整，请在项目根目录中创建一个名为 `rd.xml` 的新文件。有关 rd.xml 格式的完整详细信息，请参见 [Microsoft Docs](https://learn.microsoft.com/en-us/windows/uwp/dotnet-native/runtime-directives-rd-xml-configuration-file-reference)。将程序集添加到 rd.xml 文件会将其排除在修整之外。

以下为排除 AWS SDK 的 rd.xml 示例。

```xml
<Directives xmlns="http://schemas.microsoft.com/netfx/2013/01/metadata">
	<Application>
		<Assembly Name="AWSSDK.Core" Dynamic="Required All"></Assembly>
		<Assembly Name="Amazon.Lambda.APIGatewayEvents" Dynamic="Required All"></Assembly>
		<Assembly Name="bootstrap" Dynamic="Required All"></Assembly>
	</Application>
</Directives>
```

添加 rd.xml 后，必须更新 csproj 文件以引用 rd.xml 文件。

```xml
<ItemGroup>
    <RdXmlFile Include="rd.xml" />
</ItemGroup>
```

> 编译函数时，程序集修整将跳过指定的三个库。如果您将 .NET 7 本机 AOT 与 Lambda 配合使用，建议您排除 Lambda 函数使用的库。

## 打包并部署 NativeAOT 编译的 Lambda 函数

### 使用 dotnet CLI

```bash
dotnet lambda deploy-function
```

使用 Lambda 工具 CLI 编译和打包 Lambda 函数代码时，该工具会检查项目中的 `PublishAot` 标志。如果设置为 `true`。

> 该工具将拉取基于 AL2 的 Docker 映像并在其中编译代码。它将本地文件系统挂载到正在运行的容器，允许将编译的二进制文件存储回本地文件系统，以便进行部署。默认情况下，生成的 ZIP 文件将输出到目录 `bin/Release`。

部署完成后，您可以执行以下命令来调用创建的函数

```bash
dotnet lambda invoke-function FUNCTION_NAME
```

### 使用 Visual Studio

使用 AWS Toolkit for Visual Studio 从 Visual Studio 中编译和部署基于 AOT 的本机 Lambda 函数。

在 Visual Studio 中，选择 `文件->新建项目`。搜索 `Lambda function .NET 7 native AOT` 并创建项目。

![](https://corehome.oss-accelerate.aliyuncs.com/blogs/3235972d-8b13-4a44-8ce4-62076ada2cdf.jpg)

创建项目后，在 Visual Studio 中右键单击该项目，然后选择发布到 AWS Lambda。

![](https://corehome.oss-accelerate.aliyuncs.com/blogs/d0c0de52-c842-40c6-9e7b-c643a1ed0e77.jpg)

完成发布向导中的步骤并点击上传，等待编译完成....

![](https://corehome.oss-accelerate.aliyuncs.com/blogs/11a008d6-869b-488e-b85a-cb7129d0e99f.jpg)

从 Visual Studio 中调用 API Gateway 来运行已部署的 Lambda。

![](https://corehome.oss-accelerate.aliyuncs.com/blogs/c76e426a-4afe-4d7e-8ae1-a8b145469e81.jpg)