ASP.NET Core基础（四）——IHostBuilder

此文是在官方文档的基础上做的个人笔记，一些简单的内容就没用再列出来了，参考官方文档：https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/host/generic-host?view=aspnetcore-5.0

主机封装了应用的所有资源，例如：

• HTTP服务器实现（Kestrel）
• 中间件
• Logging
• DI
• Configuration
• IHostedService ，可以实现执行后台任务的功能

主机分为两种：

• .Net 通用主机IHostBuilder：也称为泛型主机 （推荐使用）。
  Program.cs的CreateDefaultBuilder和ConfigureWebHostDefaults方法为主机配置了一组默认选项包括：
  1. 将Kestrel作为默认的web服务器并启用与IIS的集成
  2. 从appsettings.json、appsettings.{environment name}.json、环境变量、命令行参数等其它配置项中加载配置。
• asp.net core web主机IWebHostbuilder：仅用于后向兼容性asp.ner core 1.0 2.0

1. 主机服务

框架会自动注册以下服务：

• IHostApplicationLifetime
• IHostLifetime
• IHostEnvironment / IWebHostEnvironment

1.1 ★使用IHostApplicationLifetime执行后台任务★

可以将 IHostApplicationLifetime服务注入任何类以处理启动后和正常关闭任务。

下面我们创建一个类LifetimeEventsHostedService 实现IHostedService接口。

internal class LifetimeEventsHostedService : IHostedService
{
    private readonly ILogger _logger;
    private readonly IHostApplicationLifetime _appLifetime;

    public LifetimeEventsHostedService(
        ILogger<LifetimeEventsHostedService> logger, 
        IHostApplicationLifetime appLifetime)
    {
        _logger = logger;
        _appLifetime = appLifetime;
    }

    public Task StartAsync(CancellationToken cancellationToken)
    {
        _appLifetime.ApplicationStarted.Register(OnStarted);
        _appLifetime.ApplicationStopping.Register(OnStopping);
        _appLifetime.ApplicationStopped.Register(OnStopped);

        return Task.CompletedTask;
    }

    public Task StopAsync(CancellationToken cancellationToken)
    {
        return Task.CompletedTask;
    }

    private void OnStarted()
    {
    	//可以启动一个后台任务
        _logger.LogInformation("OnStarted has been called.");
    }

    private void OnStopping()
    {
        _logger.LogInformation("OnStopping has been called.");
    }

    private void OnStopped()
    {
        _logger.LogInformation("OnStopped has been called.");
    }
}

注册服务，两种方式都可以：

builder.Services.AddHostedService<LifetimeEventsHostedService>();
builder.Services.AddTransient<IHostedService, LifetimeEventsHostedService>();

1.2 IHostApplicationLifetime vs IHostedService vs BackgroudService

如果仔细观察的话，会发现这两个接口和抽象类很像。

• IHostedService： StartAsync、StopAsync
• IHostApplicationLifetime：ApplicationStarted、ApplicationStopping、ApplicationStopped
• BackgroudService：ExecuteAsync

你可以实现IHostedService接口或BackgroudService抽象类来执行后台任务。

BackgroundService是IHostedService的一个实现类，用来执行耗时的后台任务。

你也可以直接实现IHostedSerivice接口，来执行简单的后台任务。

IHostApplicationLifetime粒度更精细一些，可以在应用启动之后执行，停止过程中/后执行。这些都是IHostedService所没有的。微软对二者做了这样的区分，我感觉可能是Host里除了Application可能还有些其他事情需要处理。 不过我们一般不主动去实现这个接口，使用方法参考上面的示例。

1.3 IHostLifetime

用来控制主机何时启动和何时停止。 当注册了多个实现时，仅最后一个有效。

Microsoft.Extensions.Hosting.Internal.ConsoleLifetime 是默认的 IHostLifetime 实现，用来

• 侦听 Ctrl+C/SIGINT 或 SIGTERM 并调用 StopApplication 来启动关闭进程。
• 解除阻止 RunAsync 和 WaitForShutdownAsync 等扩展。

2. 配置主机

如果感觉框架对主机的默认配置不合理，可以调用IHostBuilder的ConfigureHostConfiguration和ConfigureAppConfiguration用来自定义配置主机和应用。比如可以加载额外的json文件，设置BasePath等。

3. 适用于Web应用的一些配置

如：UseUrls、PreferHostingUrls、UseStartup、UseWebRoot、UseSettings等。

参考：https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/host/generic-host?view=aspnetcore-5.0#settings-for-web-apps

4. 主机生存周期

可以调用IHost对象的Run、RunAsync、RunConsoleAsync、Start、Stop、WaitForShutdown等方法

5. Web主机

https://stackoverflow.com/questions/52085806/what-is-the-difference-between-iwebhost-webhostbuilder-buildwebhost

---

参考：
在 ASP.NET Core 中使用托管服务实现后台任务