Amazon.Lambda.AspNetCoreServer 9.0.0

Amazon.Lambda.AspNetCoreServer

此包使运行 ASP.NET Core Web API 应用程序作为 Lambda 函数（使用 API Gateway 或 ELB 应用程序负载均衡器）变得简单。这使得 .NET Core 开发人员可以使用 ASP.NET Core Web API 框架创建“无服务器”应用程序。

函数从 API Gateway 代理 或从 应用程序负载均衡器 中接收请求，将该请求转换为 ASP.NET Core 框架期望的类，然后将来自 ASP.NET Core 框架的响应转换为 API Gateway 代理或应用程序负载均衡器可以理解的响应体。

Lambda 入口点

在 ASP.NET Core 应用程序中添加一个类，作为 Lambda 调用应用程序的入口点。这个类通常被称为 LambdaEntryPoint。基于 Lambda 函数的调用方式来决定基类。

注意：HTTP API 默认为载荷 2.0，除非明确设置为 1.0，否则基类应该是 APIGatewayHttpApiV2ProxyFunction。

下面是一个在 ASP.NET Core Web API 应用程序中实现的 Lambda 函数示例。

using System.IO;

using Amazon.Lambda.AspNetCoreServer;
using Microsoft.AspNetCore.Hosting;

namespace TestWebApp
{
    /// <summary>
    /// This class extends from APIGatewayProxyFunction which contains the method FunctionHandlerAsync which is the 
    /// actual Lambda function entry point. The Lambda handler field should be set to
    /// 
    /// AWSServerless19::AWSServerless19.LambdaEntryPoint::FunctionHandlerAsync
    /// </summary>
    public class LambdaEntryPoint :

        // The base class must be set to match the AWS service invoking the Lambda function. If not Amazon.Lambda.AspNetCoreServer
        // will fail to convert the incoming request correctly into a valid ASP.NET Core request.
        //
        // API Gateway REST API                         -> Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFunction
        // API Gateway HTTP API payload version 1.0     -> Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFunction
        // API Gateway HTTP API payload version 2.0     -> Amazon.Lambda.AspNetCoreServer.APIGatewayHttpApiV2ProxyFunction
        // Application Load Balancer                    -> Amazon.Lambda.AspNetCoreServer.ApplicationLoadBalancerFunction
        // 
        // Note: When using the AWS::Serverless::Function resource with an event type of "HttpApi" then payload version 2.0
        // will be the default and you must make Amazon.Lambda.AspNetCoreServer.APIGatewayHttpApiV2ProxyFunction the base class.

        Amazon.Lambda.AspNetCoreServer.APIGatewayProxyFunction
    {
        /// <summary>
        /// The builder has configuration, logging and Amazon API Gateway already configured. The startup class
        /// needs to be configured in this method using the UseStartup<>() method.
        /// </summary>
        /// <param name="builder"></param>
        protected override void Init(IWebHostBuilder builder)
        {
            builder
                .UseStartup<Startup>();
        }
    }
}

Lambda 函数的处理程序将是 TestWebApp::TestWebApp.LambdaEntryPoint::FunctionHandlerAsync。

应用程序启动（IWebHostBuilder 与 IHostBuilder）

ASP.NET Core 应用程序通过使用宿主构建器进行启动。宿主构建器用于配置运行 ASP.NET Core 应用程序所需的所有必需服务。使用 Amazon.Lambda.AspNetCoreServer，有多个选项可以自定义启动过程，并且这些选项因目标版本的 .NET Core 而异。

ASP.NET Core 3.1

ASP.NET Core 3.1 使用泛型 IHostBuilder 来启动应用程序。在典型的 ASP.NET Core 3.1 应用程序中，使用以下代码片段所示的 Program.cs 文件启动应用程序。作为创建 IHostBuilder 的过程的一部分，通过 ConfigureWebHostDefaults 方法创建了一个 IWebHostBuilder。

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

Amazon.Lambda.AspNetCoreServer 创建了这个 IHostBuilder 并配置了在 Lambda 中运行 ASP.NET Core 应用程序所需的默认设置。

可以重写两个 Init 方法来自定义 IHostBuilder。最常见的自定义是通过重写 Init(IWebHostBuilder) 方法，并通过 UseStartup 方法设置启动类。要自定义 IHostBuilder，请重写 Init(IHostBuilder)。**不要在重写 Init(IHostBuilder) 时调用 ConfigureWebHostDefaults，因为 Amazon.Lambda.AspNetCoreServer 在创建 IHostBuilder 时会调用 ConfigureWebHostDefaults。在 Init(IHostBuilder) 方法中调用 ConfigureWebHostDefaults 将导致 IWebHostBuilder 配置两次**。

如果想要完全控制创建 IHostBuilder 的过程，则可以重写 CreateHostBuilder 方法。当重写 CreateHostBuilder 方法时，除非重写调用基本实现或显式调用 Init(IWebHostBuilder) 方法，否则不会调用任一 Init 方法。当重写 CreateHostBuilder 方法时，建议调用 ConfigureWebHostLambdaDefaults 而不是 ConfigureWebHostDefaults 来配置 Lambda 中的 IWebHostBuilder。

如果在一个 ASP.NET Core 3.1 应用程序中重写了 CreateWebHostBuilder，则只使用 IWebHostBuilder 进行启动，采用与 ASP.NET Core 2.1 应用程序相同的模式。当重写 CreateWebHostBuilder 时，不会调用 CreateHostBuilder 和 Init(IHostBuilder)。

ASP.NET Core 2.1

ASP.NET Core 2.1 应用程序使用 IWebHostBuilder 类型进行启动。Amazon.Lambda.AspNetCoreServer 将创建一个 IWebHostBuilder 实例，可以通过重写 Init(IWebHostBuilder) 方法来自定义它。最常见的自定义是通过 UseStartup 方法配置启动类。

如果想要完全控制创建 IWebHostBuilder 的过程，请重写 方法。当重写 CreateWebHostBuilder 方法时，除非重写调用基本实现或显式调用 Init(IWebHostBuilder) 方法，否则不会调用 Init(IWebHostBuilder) 方法。

    public class LambdaEntryPoint : ApplicationLoadBalancerFunction
    {
        protected override void Init(IWebHostBuilder builder)
        {
            builder
                .UseStartup<Startup>();
        }

        protected override void PostMarshallRequestFeature(IHttpRequestFeature aspNetCoreRequestFeature, ApplicationLoadBalancerRequest lambdaRequest, ILambdaContext lambdaContext)
        {
            aspNetCoreRequestFeature.PathBase = "/webapp/";

            // The minus one is ensure path is always at least set to `/`
            aspNetCoreRequestFeature.Path = 
                aspNetCoreRequestFeature.Path.Substring(aspNetCoreRequestFeature.PathBase.Length - 1);
            lambdaContext.Logger.LogLine($"Path: {aspNetCoreRequestFeature.Path}, PathBase: {aspNetCoreRequestFeature.PathBase}");
        }
    }

using System.IO;

using Amazon.Lambda.AspNetCoreServer;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc;

namespace TestWebApp
{
    public class LambdaFunction : APIGatewayProxyFunction
    {
        protected override void Init(IWebHostBuilder builder)
        {
            // Register any MIME content types you want treated as binary
            RegisterResponseContentEncodingForContentType("application/octet-stream",
                    ResponseContentEncoding.Base64);
            
            // ...
        }
    }

    // In your controller actions, be sure to provide a Content Type for your responses
    public class LambdaController : Controller
    {
        public IActionResult GetBinary()
        {
            var binData = new byte[] { 0x00, 0x01, 0x02, 0x03 };
 
            return base.File(binData, "application/octet-stream");
        }
    }
}