在 ASP.NET Core 应用程序启动时运行代码的 3 种方法

本文介绍了在ASP.NET Core应用程序启动时执行一次性代码的不同方法，包括直接在Program或Startup类中、通过IHostedService和使用IHostApplicationLifetime事件。讨论了各种方法的适用场景，如初始化内存缓存、后台任务和配置加载，并强调了选择合适方法的重要性。

开发人员应该将初始化内存缓存的代码放在哪里？

开发人员可能会发现有必要在 ASP.NET Core 应用程序启动时只执行一次代码。例如，开发人员可能需要填充内存缓存、运行后台任务、从某些外部源读取配置、发布应用程序成功启动的事件等。

ASP.NET Core 为开发人员提供了几种不同的方式来实现这一目标，但它们并不等同，开发人员在做出最终选择之前应仔细分析。

直接从`Program`或`Startup`运行代码

在应用程序启动时只执行一次代码的最明显和最直接的方法可能是将该代码直接放入 Program 类的 Main 方法或 Startup 类的 Configure 方法中。 ASP.NET Core 确保这些方法以及放置在其中的代码仅在应用程序启动时执行。

//"Main" method
public static void Main(string[] args)
{
    var host = CreateHostBuilder(args).Build();
    //Startup logic here
    host.Run();
}

//"Configure" method
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    app.UseHttpsRedirection();
    //...
    //Startup logic here
}

开发人员可以根据具体情况选择两种方式之一来放置启动逻辑。例如，如果启动逻辑只应在配置请求处理管道后运行，则开发人员应将其放在 Configure 方法的末尾，而不是在创建 IHost 对象之后。

将逻辑放在 Main（或在极少数情况下的 Configure 方法）中的主要优点是可以在应用程序开始服务 Web 请求之前执行启动逻辑，这对于初始化内存缓存或读取配置等任务很重要。

从托管服务运行代码

ASP.NET Core 为开发人员提供了一个 IHostedService 接口，该接口具有在应用程序启动和停止时执行的 StartAsync 和 StopAsync 方法。此接口通常用于触发长时间运行的后台任务，但 StartAsync 本身必须快速返回，以免阻塞其他托管服务（如果有）。

//Define your hosted service with startup logic
public class MyHostedService : IHostedService
{
    public async Task StartAsync(CancellationToken cancellationToken)
    {
        //Startup logic here
    }

    public async Task StopAsync(CancellationToken cancellationToken)
    {
        //Cleanup logic here
    }
}

//Register hosted service 
public void ConfigureServices(IServiceCollection services)
{
    services.AddHostedService<MyHostedService>();
}

此外，最好知道 StartAsync 方法在配置应用程序的请求管道之前运行（在执行 Configure 方法之前）。当启动逻辑仅在应用程序的请求管道配置后才需要运行时，这可能是一个问题。

订阅 `IHostApplicationLifetime` 事件

另一个 ASP.NET Core 接口 IHostApplicationLifetime 允许开发人员将其处理程序订阅到 ApplicationStarted、ApplicationStopping 和 ApplicationStopped 事件：

public void Configure(
      IApplicationBuilder app, 
      IWebHostEnvironment env, 
      IHostApplicationLifetime appLifetime)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    //...

    appLifetime.ApplicationStarted.Register(OnStarted);
    appLifetime.ApplicationStopping.Register(OnStopping);
    appLifetime.ApplicationStopped.Register(OnStopped);
}

private void OnStarted()
{
    //"On-started" logic
}

private void OnStopping()
{
    //"On-stopping" logic
}

private void OnStopped()
{
    //"On-stopped" logic
}