ASP.NET Core 3.x控制IHostedService启动顺序浅探

太过爱你忘了你带给我的痛 2022-10-22 12:58 118阅读 0赞

> 想写好中间件，这是基础。

# 一、前言 #

今天这个内容，基于于ASP.NET Core 3.x。

从3.x开始，ASP.NET Core使用了通用主机模式。它将`WebHostBuilder`放到了通用的`IHost`之上，这样可以确保`Kestrel`可以运行在`IHostedService`中。

我们今天就来研究一下这个启动方式和启动顺序。

*    为了防止不提供原网址的转载，特在这里加上原文链接：[https://www.cnblogs.com/tiger-wang/p/13636641.html][https_www.cnblogs.com_tiger-wang_p_13636641.html]*

# 二、通常的启动次序 #

通常情况下，`IHostedService`的任何实现在添加到`Startup.ConfigureServices()`后，都会在`GenericWebHostService`之前启动。

![907112-20200909004753410-513418571.png][]

这是微软官方给出的图。

这个图展示了在`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

# 五、总结 #

最后总结一下：

`IHostedServices`的执行顺序与它们在`Startup.configureservices()`中添加到DI容器中的顺序相同。运行侦听HTTP请求的`Kestrel`服务器的`GenericWebHostSevice`总是注册的`IHostedServices`之后运行。

要在`GenericWebHostSevice`之后启动`IHostedService`，需要在`Program.cs`中的`IHostBuilder上`的`ConfigureServices()`扩展方法中进行注册。

（全文完）

本文的代码在：[https://github.com/humornif/Demo-Code/tree/master/0024/demo][https_github.com_humornif_Demo-Code_tree_master_0024_demo]

--------------------

<table> 
 <tbody> 
  <tr> 
   <td><img src="https://img2020.cnblogs.com/blog/907112/202005/907112-20200527230728396-985375280.jpg" alt="" width="160" height="160"></td> 
   <td> <p>微信公众号：老王Plus</p> <p>扫描二维码，关注个人公众号，可以第一时间得到最新的个人文章和内容推送</p> <p>本文版权归作者所有，转载请保留此声明和原文链接</p> </td> 
  </tr> 
 </tbody> 
</table>

[https_www.cnblogs.com_tiger-wang_p_13636641.html]: https://www.cnblogs.com/tiger-wang/p/13636641.html
[907112-20200909004753410-513418571.png]: /images/20221022/14b06bc6f73947e591afeadf25415b47.png
[https_github.com_humornif_Demo-Code_tree_master_0024_demo]: https://github.com/humornif/Demo-Code/tree/master/0024/demo