处理流处理标准数据类型处理程序签名序列化 Lambda 函数 Lambda 函数处理程序限制在使用 C# 编写的 Amazon Lambda 函数中应用 Async

C# 中的 Amazon Lambda 函数处理程序

Lambda 函数的处理程序 是函数代码中处理事件的方法。当调用函数时，Lambda 运行处理程序方法。处理程序退出或返回响应后，可处理另一个事件。

将 Lambda 函数处理程序定义为某个类中的实例或静态方法。如果您希望访问 Lambda context 对象，可通过定义类型为 ILambdaContext 的方法参数来实现，该参数是一个您可以用来访问有关当前调用的信息（例如，当前函数的名称、内存限制、剩余执行时间和日志记录）的接口。


returnType handler-name(inputType input, ILambdaContext context) {
   ...
}

在该语法中，需要注意以下方面：

inputType – 第一个处理程序参数是处理程序的输入，它可以是事件数据（由事件源发布）或您提供的自定义输入（如字符串或任意自定义数据对象）。
returnType – 如果打算同步调用 Lambda 函数（使用 RequestResponse 调用类型），则可以使用任何支持的数据类型返回函数输出。例如，如果使用 Lambda 函数作为移动应用程序后端并同步调用它，则输出数据类型会序列化为 JSON。

如果打算异步调用 Lambda 函数（使用 Event 调用类型），则 returnType 应为 void。例如，将 Amazon Lambda 搭配 Amazon S3 或 Amazon SNS 之类的事件源使用时，这些事件源会使用 Event 调用类型调用 Lambda 函数。
ILambdaContext context – 处理程序签名中的第二个参数是可选的。它提供对上下文对象的访问权限，该对象包含有关函数和请求的信息。

处理流

仅 System.IO.Stream 类型在默认情况下可作为输入参数受支持。

例如，考虑以下 C# 示例代码。


using System.IO;

namespace Example
{            
  public class Hello
  {
    public Stream MyHandler(Stream stream)
    {
       //function logic
    }
  }
}

在此 C# 示例代码中，第一个处理程序参数是处理程序 (MyHandler) 的输入，它可以是事件数据（由 Amazon S3 之类的事件源发布），也可以是您提供的自定义输入（如本示例中的 Stream）或任何自定义数据对象。输出的类型为 Stream。

处理标准数据类型

其他所有类型（如下所列）均需要您指定串行器。

Primitive .NET 类型（例如 string 或 int）。
集合和映射 - IList、IEnumerable、IList<T>、Array、IDictionary、IDictionary<TKey 和 TValue>
POCO 类型（无格式的旧 CLR 对象）
预定义 Amazon 事件类型
Lambda 将忽略异步调用的返回类型。在这种情况下，可能会将返回类型设置为 void。
如果您使用的是 .NET 异步编程，则返回类型可以是 Task 和 Task<T>，并且可使用 async 和 await 关键字。有关更多信息，请参阅在使用 C# 编写的 Amazon Lambda 函数中应用 Async。

除非函数输入和输出参数的类型为 System.IO.Stream，否则您需要对这些参数执行序列化。Amazon Lambda 提供了可在应用程序的程序集或方法级别应用的默认串行器，或者您也可以通过实施由 Amazon.Lambda.Core 库提供的 ILambdaSerializer 接口定义自己的串行器。有关更多信息，请参阅使用 .zip 文件存档部署 C＃ Lambda 函数。

要向某个方法添加默认的串行器属性，请先添加对 Amazon.Lambda.Serialization.Json 文件中 .csproj 的依赖关系。



<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
    <AssemblyName>AssemblyName</AssemblyName>
    </PropertyGroup>
      
    <ItemGroup>
    <PackageReference Include="Amazon.Lambda.Core" Version="1.2.0" />
    <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.3.0" />
    <PackageReference Include="Amazon.Lambda.Serialization.Json" Version="1.8.0" />
    <PackageReference Include="Newtonsoft.Json" Version="12.0.1" />
    </ItemGroup>
</Project>

以下示例说明了您可以分别针对自己选择的各种方法灵活地指定默认 Json.NET 串行器：


public class ProductService{
    [LambdaSerializer(typeof(Amazon.Lambda.Serialization.Json.JsonSerializer))]
    public Product DescribeProduct(DescribeProductRequest request)
    {
      return catalogService.DescribeProduct(request.Id);
    }
   
   [LambdaSerializer(typeof(MyJsonSerializer))]
   public Customer DescribeCustomer(DescribeCustomerRequest request)
   {
      return customerService.DescribeCustomer(request.Id);
   }
}

注意

如果您使用的是 .NET Core 3.1，我们建议您使用 Amazon.Lambda.Serialization.SystemTextJson 串行器。此程序包提供了优于 Amazon.Lambda.Serialization.Json 的性能改进。

处理程序签名

创建 Lambda 函数时，您必须提供一个处理程序字符串，告知 Amazon Lambda 在何处查找要调用的代码。在 C# 中，格式如下：

ASSEMBLY::TYPE::METHOD，其中：

ASSEMBLY 是您的应用程序的 .NET 程序集文件的名称。使用 .NET Core CLI 构建应用程序时，如果未使用 .csproj 中的 AssemblyName 属性来设置程序集名称，则在构建完成后，ASSEMBLY 名称将为包含 .csproj 文件的文件夹的名称。有关更多信息，请参阅.NET Core CLI。在这种情况下，假设文件夹名称为 HelloWorldApp。
TYPE 是包含 Namespace 和 ClassName 的处理程序类型的全名。在本例中为 Example.Hello。
METHOD 是函数处理程序的名称，在本例中为 MyHandler。

签名最终将是以下格式：Assembly::Namespace.ClassName::MethodName

请考虑以下示例：


using System.IO;

namespace Example
{            
  public class Hello
  {
    public Stream MyHandler(Stream stream)
    {
       //function logic
    }
  }
}

处理程序字符串为：HelloWorldApp::Example.Hello::MyHandler

重要

如果在处理程序字符串中指定的方法重载，您必须提供 Lambda 应调用的方法的准确签名。如果该解决方法要求在多个（重载）签名中进行选择，Amazon Lambda 将拒绝其他有效签名。

序列化 Lambda 函数

对于任何使用 Stream 对象以外的输入或输出类型的 Lambda 函数，您都需要向应用程序中添加一个序列化库。您可以通过下列方式来执行此操作：

使用 Amazon.Lambda.Serialization.Json NuGet 程序包。该库使用 JSON.NET 来处理序列化。

注意

如果您使用的是 .NET Core 3.1，我们建议您使用 Amazon.Lambda.Serialization.SystemTextJson 串行器。此程序包提供了优于 Amazon.Lambda.Serialization.Json 的性能改进。
通过实施 ILambdaSerializer 接口（作为 Amazon.Lambda.Core 库的一部分提供）创建您自己的序列化库。该接口定义了两种方法：
- T Deserialize<T>(Stream requestStream);
  
  通过实施此方法，您可以将请求负载从 Invoke API 反序列化至传递到 Lambda 函数处理程序的对象中。
- T Serialize<T>(T response, Stream responseStream);。
  
  通过实施此方法，您可以将从 Lambda 函数处理程序中返回的结果序列化到 Invoke API 返回的响应负载中。

您可以使用任意一个串行器，方法是将其作为依赖项添加到您的 MyProject.csproj 文件中。


...
 <ItemGroup>
    <PackageReference Include="Amazon.Lambda.Core" Version="1.0.0" />
    <PackageReference Include="Amazon.Lambda.Serialization.Json" Version="1.3.0" />
  </ItemGroup>

然后将其添加到您的 AssemblyInfo.cs 文件中。例如，如果您使用的是默认 Json.NET 串行器，则需要添加以下项：


[assembly:LambdaSerializer(typeof(Amazon.Lambda.Serialization.Json.JsonSerializer))]

注意

您可以在方法级别定义一个自定义序列化属性，用于覆盖在程序集级别指定的默认串行器。有关更多信息，请参阅处理标准数据类型。

Lambda 函数处理程序限制

请注意，处理程序签名存在一些限制。

处理程序签名不能是unsafe的，且不得使用指针类型，但在处理程序方法及其依赖关系中可以使用unsafe上下文。有关更多信息，请参阅不安全（C# 参考）。
处理程序签名不得使用 params 关键字传递可变数量的参数，也不得将用于支持可变数量参数的 ArgIterator 用作输入或返回参数。
处理程序不能是泛型方法（例如 IList<T> Sort<T>(IList<T> input)）。
不支持使用签名 async void 的 Async 处理程序。

在使用 C# 编写的 Amazon Lambda 函数中应用 Async

如果您知道自己的 Lambda 函数需要长时间的运行过程，例如上传大型文件到 Amazon S3 或者从 DynamoDB 中读取大量记录，则您可以利用 async/await 模式。当您使用此签名时，Lambda 会同步调用函数并等待该函数返回响应或执行超时。


public async Task<Response> ProcessS3ImageResizeAsync(SimpleS3Event input)
{
   var response = await client.DoAsyncWork(input);
   return response;
}

使用此模式时，您必须谨记以下几项注意事项：

Amazon Lambda 不支持 async void 方法。
如果您创建了一个 async Lambda 函数，但未实施 await 运算符，.NET 将发出一个编译器，提醒您注意意外行为。例如，有些 async 操作会运行，而有些不会。或者，有些 async 操作不会在函数调用完成时结束。
```
public async Task ProcessS3ImageResizeAsync(SimpleS3Event event) // Compiler warning
{
    client.DoAsyncWork(input); 
}
```

您的 Lambda 函数可包含多个可并行调用的 async 调用。您可使用 Task.WhenAll 和 Task.WhenAny 方法来处理多项任务。要使用 Task.WhenAll 方法，您需要将一个操作列表作为阵列传递至该方法。请注意，在以下示例中，如果您忘记在该阵列中包含任何操作，则调用可能会在操作结束之前返回。


public async Task DoesNotWaitForAllTasks1()
{
   // In Lambda, Console.WriteLine goes to CloudWatch Logs.
   var task1 = Task.Run(() => Console.WriteLine("Test1"));
   var task2 = Task.Run(() => Console.WriteLine("Test2"));
   var task3 = Task.Run(() => Console.WriteLine("Test3"));
 
   // Lambda may return before printing "Test2" since we never wait on task2.
   await Task.WhenAll(task1, task3);
}

要使用 Task.WhenAny 方法，您同样需要将一个操作列表作为阵列传递至该方法。该调用将在第一个操作结束时返回，即使其他操作仍在运行也是如此。


public async Task DoesNotWaitForAllTasks2()
{
  // In Lambda, Console.WriteLine goes to CloudWatch Logs.
  var task1 = Task.Run(() => Console.WriteLine("Test1"));
  var task2 = Task.Run(() => Console.WriteLine("Test2"));
  var task3 = Task.Run(() => Console.WriteLine("Test3"));
 
  // Lambda may return before printing all tests since we're only waiting for one to finish.
  await Task.WhenAny(task1, task2, task3);
}

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

使用 C#

部署程序包