ASP.NET Core 中的应用启动

作者：Rick Anderson

使用 Web 模板创建的 ASP.NET Core 应用包含 Program.cs 文件中的应用程序启动代码。

以下应用启动代码支持：

• Razor Pages
• 具有视图的 MVC 控制器
• 具有控制器的 Web API
• 最小 API

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddRazorPages();
builder.Services.AddControllersWithViews();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseAuthorization();

app.MapGet("/hi", () => "Hello!");

app.MapDefaultControllerRoute();
app.MapRazorPages();

app.Run();

使用 EventSource 的应用可以度量启动时间，以了解和优化启动性能。 Microsoft.AspNetCore.Hosting 中的 ServerReady 事件表示服务器已准备好响应请求的点。

有关应用程序启动的详细信息，请参阅 ASP.NET Core 基础知识概述。

使用 Startup 筛选器扩展 Startup

使用 IStartupFilter：

• 在应用的中间件管道的开头或末尾配置中间件，而无需显式调用 Use{Middleware}。 使用 IStartupFilter 在不显式注册默认中间件的情况下将默认值添加到管道的开头。 IStartupFilter 允许代表应用作者使用不同的组件调用 Use{Middleware}。
• 创建 Configure 方法的管道。 IStartupFilter.Configure 可以将中间件设置为在库添加的中间件之前或之后运行。

IStartupFilter 实现 Configure，即接收并返回 Action<IApplicationBuilder>。 IApplicationBuilder 定义用于配置应用请求管道的类。 有关详细信息，请参阅使用 IApplicationBuilder 创建中间件管道。

每个 IStartupFilter 可以在请求管道中添加一个或多个中间件。 筛选器按照添加到服务容器的顺序调用。 筛选器可在将控件传递给下一个筛选器之前或之后添加中间件，从而附加到应用管道的开头或末尾。

下面的示例演示如何使用 IStartupFilter 注册中间件。 RequestSetOptionsMiddleware 中间件从查询字符串参数中设置选项值：

public class RequestSetOptionsMiddleware
{
    private readonly RequestDelegate _next;

    public RequestSetOptionsMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    // Test with https://localhost:5001/Privacy/?option=Hello
    public async Task Invoke(HttpContext httpContext)
    {
        var option = httpContext.Request.Query["option"];

        if (!string.IsNullOrWhiteSpace(option))
        {
            httpContext.Items["option"] = WebUtility.HtmlEncode(option);
        }

        await _next(httpContext);
    }
}

在 RequestSetOptionsStartupFilter 类中配置 RequestSetOptionsMiddleware：

namespace WebStartup.Middleware;
// <snippet1>
public class RequestSetOptionsStartupFilter : IStartupFilter
{
    public Action<IApplicationBuilder> Configure(Action<IApplicationBuilder> next)
    {
        return builder =>
        {
            builder.UseMiddleware<RequestSetOptionsMiddleware>();
            next(builder);
        };
    }
}
// </snippet1>

IStartupFilter 在 Program.cs 中注册：

using WebStartup.Middleware;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddTransient<IStartupFilter,
                      RequestSetOptionsStartupFilter>();

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();

app.Run();

当提供 option 的查询字符串参数时，中间件在 ASP.NET Core 中间件呈现响应之前处理分配值：

@page
@model PrivacyModel
@{
    ViewData["Title"] = "Privacy Policy";
}
<h1>@ViewData["Title"]</h1>

<p> Append query string ?option=hello</p>
Option String: @HttpContext.Items["option"];

中间件执行顺序由 IStartupFilter 注册顺序设置：

• 多个 IStartupFilter 实现可能与相同的对象进行交互。 如果顺序很重要，请将它们的 IStartupFilter 服务注册进行排序，以匹配其中间件应有的运行顺序。

• 库可能添加包含一个或多个 IStartupFilter 实现的中间件，这些实现在向 IStartupFilter 注册的其他应用中间件之前或之后运行。 若要在库的 IStartupFilter 添加的中间件之前调用 IStartupFilter 中间件，请执行以下操作：

  • 在库添加到服务容器之前定位服务注册。
  • 要在此后调用，请在添加库之后定位服务注册。

注意：重写 Configure 时，无法扩展 ASP.NET Core 应用。 有关详细信息，请参阅此 GitHub 问题。

在启动时从外部程序集添加配置

通过 IHostingStartup 实现，可在启动时从应用的 Program.cs 文件之外的外部程序集向应用添加增强功能。 有关详细信息，请参阅在 ASP.NET Core 中使用托管启动程序集。

Startup、ConfigureServices 和 Configure

有关将 ConfigureServices 和 Configure 方法与最小托管模型结合使用的信息，请参阅：

• 将 Startup 与最小托管模型结合使用
• 本文的 ASP.NET Core 5.0 版本：
  • ConfigureServices 方法
  • Configure 方法