ASP.NET Core 3.x控制IHostedService啟動順序淺探

老王Plus發表於2020-09-09

ASP.NET

想寫好中介軟體，這是基礎。

一、前言

今天這個內容，基於於ASP.NET Core 3.x。

從3.x開始，ASP.NET Core使用了通用主機模式。它將WebHostBuilder放到了通用的IHost之上，這樣可以確保Kestrel可以執行在IHostedService中。

我們今天就來研究一下這個啟動方式和啟動順序。

為了防止不提供原網址的轉載，特在這裡加上原文連結：https://www.cnblogs.com/tiger-wang/p/13636641.html

二、通常的啟動次序

通常情況下，IHostedService的任何實現在新增到Startup.ConfigureServices()後，都會在GenericWebHostService之前啟動。

這是微軟官方給出的圖。

這個圖展示了在IHost上呼叫RunAsync()時的啟動順序（後者又呼叫StartAsync()）。對我們來說，最重要的部分是啟動的IHostedServices。從圖上也可以看到，自定義IHostedServices先於GenericWebHostSevice啟動。

我們來看一個簡單的例子：

public class StartupHostedService : IHostedService
{
    private readonly ILogger _logger;
    public StartupHostedService(ILogger<StartupHostedService> logger)
    {
        _logger = logger;
    }
    public Task StartAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Starting IHostedService registered in Startup");
        return Task.CompletedTask;
    }
    public Task StopAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Stopping IHostedService registered in Startup");
        return Task.CompletedTask;
    }
}

我們做一個簡單的IHostedService。希望加到Startup.cs中：

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddHostedService<StartupHostedService>();
    }
}

執行程式碼：

info: demo.StartupHostedService[0]            # 這是上邊的StartupHostedService
      Starting IHostedService registered in Startup
info: Microsoft.Hosting.Lifetime[0]            # 這是GenericWebHostSevice
      Now listening on: https://localhost:5001
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.

正如預期的那樣，IHostedService首先執行，然後是GenericWebHostSevice。ApplicationLifetime事件在所有IHostedServices執行之後觸發。無論在什麼地方註冊了Startup.ConfigureServices()中的IHostedService， GenericWebHostSevice都在最後啟動。

那麼問題來了，為什麼GenericWebHostSevice在最後啟動？

三、為什麼`GenericWebHostSevice`在最後啟動？

先看看多個IHostedService的情況。

當有多個IHostedService的實現加入到Startup.ConfigureServices()時，執行次序取決於它被加入的次序。

看例子：

public class Service1 : IHostedService
{
    private readonly ILogger _logger;
    public Service1(ILogger<Service1> logger)
    {
        _logger = logger;
    }
    public Task StartAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Starting Service1");
        return Task.CompletedTask;
    }
    public Task StopAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Stoping Service1");
        return Task.CompletedTask;
    }
}
public class Service2 : IHostedService
{
    private readonly ILogger _logger;
    public Service2(ILogger<Service2> logger)
    {
        _logger = logger;
    }
    public Task StartAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Starting Service2");
        return Task.CompletedTask;
    }
    public Task StopAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Stoping Service2");
        return Task.CompletedTask;
    }
}

Startup.cs:

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddHostedService<Service1>();
        services.AddHostedService<Service2>();
    }
}

執行：

info: demo.Service1[0]                # 這是Service1
      Starting Service1
info: demo.Service2[0]                # 這是Service2
      Starting Service2
info: Microsoft.Hosting.Lifetime[0]        # 這是GenericWebHostSevice
      Now listening on: https://localhost:5001
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.

那麼，GenericWebHostSevice是什麼時候註冊的？

我們看看另一個檔案Program.cs：

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }
    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>            # 這是GenericWebHostSevice註冊的位置
            {
                webBuilder.UseStartup<Startup>();
            });
}

ConfigureWebHostDefaults擴充套件方法呼叫ConfigureWebHost方法，該方法執行Startup.ConfigureServices()，然後註冊GenericWebHostService。整理一下程式碼，就是下面這個樣子：

public static IHostBuilder ConfigureWebHost(this IHostBuilder builder, Action<IWebHostBuilder> configure)
{
    var webhostBuilder = new GenericWebHostBuilder(builder);

    configure(webhostBuilder);

    builder.ConfigureServices((context, services) => services.AddHostedService<GenericWebHostService>());
    return builder;
}

這樣可以確保GenericWebHostService總是最後執行，以保持通用主機實現和WebHost（已棄用）實現之間的行為一致。

因此，可以採用同樣的方式，讓IHostedService在GenericWebHostService後面啟動。

四、讓`IHostedService`在`GenericWebHostService`後面啟動

在大多數情況下，在GenericWebHostService之前啟動IHostedServices就可以滿足常規的應用。但是，GenericWebHostService還負責構建應用程式的中介軟體管道。如果IHostedService依賴於中介軟體管道或路由，那麼就需要將它的啟動延遲到GenericWebHostService完成之後。

根據上面的說明，在GenericWebHostService之後執行IHostedService的唯一方法是將它新增到GenericWebHostService之後的DI容器中。這意味著你必須跳出Startup.ConfigureServices()，在呼叫ConfigureWebHostDefaults之後，直接在IHostBuilder上呼叫ConfigureServices()：

public class ProgramHostedService : IHostedService
{
    private readonly ILogger _logger;
    public ProgramHostedService(ILogger<ProgramHostedService> logger)
    {
        _logger = logger;
    }
    public Task StartAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Starting ProgramHostedService registered in Program");
        return Task.CompletedTask;
    }
    public Task StopAsync(CancellationToken cancellationToken)
    {
        _logger.LogInformation("Stopping ProgramHostedService registered in Program");
        return Task.CompletedTask;
    }
}

加到Program.cs中：

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>            # 這是GenericWebHostSevice註冊的位置
            {
                webBuilder.UseStartup<Startup>();
            })
            .ConfigureServices(services => 
                services.AddHostedService<ProgramHostedService>());            # 這是ProgramHostedService註冊的位置
}

看輸出：

info: demo.StartupHostedService[0]            # 這是StartupHostedService
      Starting IHostedService registered in Startup
info: Microsoft.Hosting.Lifetime[0]            # 這是GenericWebHostSevice
      Now listening on: https://localhost:5001
info: demo.ProgramHostedService[0]            # 這是ProgramHostedService
      Starting ProgramHostedService registered in Program
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.

同樣，在關閉應用時，IHostedServices被反向停止，所以ProgramHostedService首先停止，接著是GenericWebHostSevice，最後是StartupHostedService：

info: Microsoft.Hosting.Lifetime[0]
      Application is shutting down...
info: demo.ProgramHostedService[0]
      Stopping ProgramHostedService registered in Program
info: demo.StartupHostedService[0]
      Stopping IHostedService registered in Startup