概念:主机是用于构建应用程序和服务、封装应用资源的对象,负责程序的启动和生命周期的管理,简单来说主机即应用程序。
主机运行:当主机运行的时候,他会将托管在服务容器集合里面注册的IHostService
的每个实现调用IHostService.StartAsync()
。在web应用中,每一个IHostService
实现就是启动。
需要掌握:
- 主机的作用是什么?
- 主机的种类、对应的版本?
- 泛型主机的代码上和逻辑上的构造流程
- 泛型主机替换Web主机的原因以及通过什么拓展方法来支持Http负载?
主机的种类和构建方式
1. WebHost(范围:3.0版本之前)官网
在3.0版本之前,当我们构建Web应用的时候,Program.cs默认构建的主机类型是WebHost,在CreateWebHostBuilder()方法中通过调用WebHost静态类的CreateDefaultBuilder()方法返回一个IWebHostBuilder对象,
然后调用Build()
方法和Run()
方法来构建主机和运行主机。
流程:获取WebHost构建器
-> 调用Build()
方法生成主机实例 -> Run()
方法
2.1版本
// WebAPI的Program.cs public class Program { public static void Main(string[] args) { CreateWebHostBuilder(args).Build().Run(); } /// <summary> /// 生成Web应用主机 /// </summary> /// <param name="args"></param> /// <returns></returns> public static IWebHostBuilder CreateWebHostBuilder(string[] args) => WebHost.CreateDefaultBuilder(args) .UseStartup<Startup>()); }
2. 泛型Host(范围:3.0版本之后)官网
3.0以后微软将主机类型替换为了Host
通用主机,通过在CreatHostBuilder()
中调用Host.reateDefaultBuilder()
方法返回一个IHostBuilder对象
,然后调用Build()方法和Run()方法
来构建主机和运行主机。
在3.0版本,微软对Host
进行了升级,原本Host
只能用于非HTTP负载,但是通过调用ConfigureWebHostDefaults()拓展方法
来实现HTTP负载。
在6.0版本,微软对于netcore进行了大升级,Program.cs
文件发生了很大的改变,所以下方将会分为2个部分来分别介绍3.0版本到5.0版本的泛型Host是如何创建的?6.0版本的泛型Host是如何创建的?
3.0版本到5.0版本的的创建泛型Host
流程:获取IHostBuilder
-> 调用ConfigureWebHostDefaults()
方法来拓展WebHost
(web应用需要调用此拓展方法,非web应用,如WokerService则不需要) -> 调用Build()
方法生成主机实例 -> Run()
方法
5.0版本
// WebAPI的Program.cs文件 public class Program { public static void Main(string[] args) { CreateHostBuilder(args).Build().Run(); } /// <summary> /// 生成通用主机 /// </summary> /// <param name="args"></param> /// <returns></returns> public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) // 因为是WebAPI,所以要调用此拓展服务,配置WebAPI的配置,如中间件、服务等。 // 使用拓展方法UseStartup()指向Startup文件 // 官方描述:用于托管Web应用程序的默认值配置 .ConfigureWebHostDefaults(Builder => { Builder.UseStartup<Startup>(); }); }
ConfigureWebHostDefaults()拓展方法:
原本Host是不支持HTTP工作负载的,所以要使用此拓展方法可以配置主机所需要的Web服务。
调用这个方法会将WebHost注入到Host中。
简单来说,如果你的版本是3.0到5.0,且需要web服务,如MVC或者WebAPI则需要配置此服务。
(创造项目的时候会自动生成的,所以了解一下这个拓展方法是干什么的就好了)
ConfigureWebHostDefaults拓展方法源码
namespace Microsoft.Extensions.Hosting { // 用于托管 Web 应用程序的默认值配置 Microsoft.Extensions.Hosting.IHostBuilder // 这应该在应用程序特定的配置之前调用,以避免它覆盖提供的服务、配置源、环境、内容根等 public static class GenericHostBuilderExtensions { public static IHostBuilder ConfigureWebHostDefaults(this IHostBuilder builder, Action<IWebHostBuilder> configure); } }
6.0版本的的创建泛型Host
6.0版本,NetCore使用最小托管模型来创建应用,只需要4行代码就能构建一个应用
通过使用WebApplication.CreateBuilder(args)
来创建主机
最小托管模型
// 得到应用构造器:WebApplicationBuilder
var builder = WebApplication.CreateBuilder(args);
// 配置日志
builder.Logging.AddLog4Net("ConfigFile/log4net.config");
// 得到应用:WebApplication
var app = builder.Build();
// 配置中间件
app.UseStaticFiles();
// 运行主机
app.Run();
3. 为什么要用泛型Host替换WebHost:
泛型Host在2.1版本就已经存在了,当时只是用于非Http请求的工作负载,而WebHost 构建器更多地与 HTTP 请求相关联并且适用于 Web 应用,随着微服务和Docker的发展和出现,程序需要一个更通用的 Web 主机,因此 .NET核心团队在3.0对Host进行了改进,让Host也可也支持HTTP负载(通过拓展方法ConfigureWebHostDefaults
),可以更好地将 ASP.NET Core 应用与非 Web 特定的其他服务器方案集成。简而言之就是为了在所有的netcore应用中都是用一个主机。
4. 从WebHost改为泛型Host后发生主要变化:
使用Host替换WebHost,即3.0之后的变化,主要在于依赖注入DI,在使用HostBuilder的时候,Startup.cs的构造函数只能注入以下类型:
-
IConfiguration:键值对的配置,如默认的appsetting.json文件中的配置,或者通过创建主机的时候使用
Builder.AddJsonFile()
方法引入的自定义json配置文件引入的json配置文件,通过这个接口可以获取配置文件的数据; -
IHostEnvironment:提供运行应用程序的宿主环境,比如常用的IsDevelopment()方法来判断是否是运行时环境;
-
IWebHostEnvironment:提供有关运行应用程序的 Web 托管环境的信息,可以获取比如可服务应用程序的文件的绝对路径,默认是wwwroot的子文件夹;
5.代码上的流程与实际逻辑详细流程对比(泛型主机)
代码上的流程:
-
Main方法中调用
CreateHostBuilder()
。 -
CreateHostBuilder()
方法调用静态方法Host.CreateDefaultBuilder()
方法得到IHostBuilder
构造器 。 -
配置系统所需服务和
ConfigureWebHostDefaults()
。 -
返回
IHostBuilder
构造器。 -
Main方法继续调用构造器的
Build()
方法 ->Run()
方法。
逻辑上的流程(源码):
-
Host.CreateDefaultBuilder()方法,配置基础服务,并返回IHostBuilder构造器:
创建一个
IHostBuilder接口
的HostBuilder实例
,根据4个方法来配置基础服务:1.1
ConfigureHostConfiguration()
配置主机配置。1.2
ConfigureLogging()
配置日志服务。1.3
ConfigureAppConfiguration()
配置系统配置appsetting.json和自定义配置文件。1.4
UseDefaultServiceProvider()
配置ServiceProvider()
依赖注入容器。 -
ConfigureWebHostDefaults()注入WebHost,配置我们自己的服务和Http负载支持:
创建一个
WebHostBuilder
构造器,并调用4个方法来配置基础服务:2.1
UseKestrel()
配置Kestrel的服务器的应用。2.2
UseIIS()
配置对IIS进程内运行的调用,首先判断是不是windows,然后注册IISHttpServer
服务,会覆盖UseKestrel()
,UseIISIntegration()
对IIS进程外运行的调用。2.3
UseStart()
配置对于Startup.cs文件的引用,找到后,会先找到用Startup.cs里面的ConfigureService()
方法,然后使用Builder()
方法调用。2.4
services.AddHostedService<GenericWebHostService>()
,添加了一个IHostedService
服务。 -
Build()方法,生成IHost的实例,并配置相关服务然后返回IHost:
比较重要的:
在这里会创建依赖注入容器,并依赖注入相关服务
-
Run()方法:
本质上是调用的
IHost.RunAsync()
-> 调用的是IHost.StartAsync()
,它的流程是:4.1 从容器中调用所有的
IHostService
服务,然后依次调用StartAsync()
包括
ConfigureWebHostDefaults()
中的WebHost
的StartAsync()
,包括Startup.cs
里面的Configuer()
方法来创建中间件。4.2 运行
拓展:
IHostService作用(6.0版本)
继承实现IHostService接口
中的StartAsync()
方法和StopAsync()
方法来管理应用启动和关闭事件,当然需要在Program.cs
文件中使用builder.Services.AddHostService<T>()
注入主机服务才会起作用;
ApplicationStart类源码
/// <summary> /// 应用启动和关闭事件,也可也继承IApplicationLifetime /// </summary> public class ApplicationStart : IHostedService { /// <summary> /// 应用启动 /// </summary> /// <param name="cancellationToken"></param> /// <returns></returns> public Task StartAsync(CancellationToken cancellationToken) { return Task.CompletedTask; } /// <summary> /// 应用关闭 /// </summary> /// <param name="cancellationToken"></param> /// <returns></returns> public Task StopAsync(CancellationToken cancellationToken) { return Task.CompletedTask; } }
关于BackgroundService类(6.0版本)(后台运行服务)
BackgroundService类
也是继承于IHostService
,并增加了一个Task的任务属性,CancellationTokenSource
取消令牌属性和ExecuteTask()
方法来运行任务。通常用于WokerService服务的Woker
类,同样也是需要通过builder.Services.AddHostService<T>()
此方法来注入的主机服务中,以达到后台运行的目的;