一张图理清ASP.NET Core启动流程

落日映苍穹つ 2021-06-26 16:06 451阅读 0赞

## 1. 引言 ##

对于`ASP.NET Core`应用程序来说，我们要记住非常重要的一点是：其本质上是一个独立的控制台应用，它并不是必需在IIS内部托管且并不需要IIS来启动运行（而这正是`ASP.NET Core`跨平台的基石）。`ASP.NET Core`应用程序拥有一个内置的`Self-Hosted`（自托管）的`Web Server`（Web服务器），用来处理外部请求。

不管是托管还是自托管，都离不开`Host`（宿主）。在`ASP.NET Core`应用中通过配置并启动一个`Host`来完成应用程序的启动和其生命周期的管理（如下图所示）。而`Host`的主要的职责就是`Web Server`的配置和`Pilpeline`（请求处理管道）的构建。  
![ASP.NET Core总体启动流程][ASP.NET Core]

这张图描述了一个总体的启动流程，从上图中我们知道`ASP.NET Core`应用程序的启动主要包含三个步骤：

1.  `CreateDefaultBuilder()`：创建`IWebHostBuilder`
2.  `Build()`：`IWebHostBuilder`负责创建`IWebHost`
3.  `Run()`：启动`IWebHost`

**所以，`ASP.NET Core`应用的启动本质上是启动作为宿主的`WebHost`对象。**  
其主要涉及到两个关键对象`IWebHostBuilder`和`IWebHost`，它们的内部实现是`ASP.NET Core`应用的核心所在。下面我们就结合源码并梳理调用堆栈来一探究竟！

## 2. 宿主构造器：`IWebHostBuilder` ##

在启动`IWebHost`宿主之前，我们需要完成对IWebHost的创建和配置。而这一项工作需要借助`IWebHostBuilder`对象来完成的，`ASP.NET Core`中提供了默认实现`WebHostBuilder`。而`WebHostBuilder`是由`WebHost`的同名工具类（`Microsoft.AspNetCore`命名空间下）中的`CreateDefaultBuilder`方法创建的。  
![在这里插入图片描述][2019010415513024.png]  
`CreateDefaultBuilder()`调用堆栈

从上图中我们可以看出`CreateDefaultBuilder()`方法主要干了六件大事：

1.  `UseKestrel`：使用`Kestrel`作为`Web server`。
2.  `UseContentRoot`：指定Web host使用的content  
    root（内容根目录），比如Views。默认为当前应用程序根目录。
3.  `ConfigureAppConfiguration`：设置当前应用程序配置。主要是读取 `appsettinggs.json`配置文件、开发环境中配置的`UserSecrets`、添加环境变量和命令行参数 。
4.  `ConfigureLogging`：读取配置文件中的Logging节点，配置日志系统。
5.  `UseIISIntegration`：使用`IISIntegration` 中间件。
6.  `UseDefaultServiceProvider`：设置默认的依赖注入容器。

创建完毕`WebHostBuilder`后，通过调用`UseStartup()`来指定启动类，来为后续服务的注册及中间件的注册提供入口。

## 3. 宿主：`IWebHost` ##

[在ASP.Net][ASP.Net] Core中定义了`IWebHost`用来表示`Web`应用的宿主，并提供了一个默认实现`WebHost`。宿主的创建是通过调用`IWebHostBuilder`的`Build()`方法来完成的。那该方法主要做了哪些事情呢，我们来看下面这张【[ASP.NET][] Core启动流程调用堆栈】中的黄色边框部分：  
![在这里插入图片描述][20190104155310125.png]  
[ASP.NET][] Core启动流程调用堆栈

其核心主要在于`WebHost`的创建，又可以划分为三个部分：

1.  构建依赖注入容器，初始通用服务的注册：`BuildCommonService();`
2.  实例化`WebHost`：`var host = new WebHost(...);`
3.  初始化`WebHost`，也就是构建由中间件组成的请求处理管道：`host.Initialize();`

### 3.1. 注册初始通用服务 ###

`BuildBuildCommonService`方法主要做了两件事：

1.  查找`HostingStartupAttribute`特性以应用其他程序集中的启动配置
2.  注册通用服务
3.  若配置了启动程序集，则发现并以`IStartup`类型注入到`IOC`容器中

### 3.2. 创建`IWebHost` ###

public IWebHost Build()
    { 
        //省略部分代码
    
        var host = new WebHost(
            applicationServices,
            hostingServiceProvider,
            _options,
            _config,
            hostingStartupErrors);
        }
        
        host.Initialize();
    
        return host;
    }

### 3.3. 构建请求处理管道 ###

请求管道的构建，主要是中间件之间的衔接处理。

而请求处理管道的构建，又包含三个主要部分：

1.  注册`Startup`中绑定的服务；
2.  配置`IServer`；
3.  构建管道

请求管道的构建主要是借助于`IApplicationBuilder`，相关类图如下：  
![在这里插入图片描述][20190104155453237.png]  
请求管道的构建

## 4. 启动`WebHost` ##

`WebHost`的启动主要分为两步：

1.  再次确认请求管道正确创建
2.  启动`Server`以监听请求
3.  启动 `HostedService`  
    ![在这里插入图片描述][2019010415555313.png]  
    启动`WebHost`调用堆栈

### 4.1. 确认请求管道的创建 ###

从图中可以看出，第一步调用`Initialize()`方法主要是取保请求管道的正确创建。其内部主要是对`BuildApplication()`方法的调用，与我们上面所讲`WebHost`的构建环节具有相同的调用堆栈。而最终返回的正是由中间件衔接而成的`RequestDelegate`类型代表的请求管道。

### 4.2. 启动`Server` ###

我们先来看下类图：  
![在这里插入图片描述][20190104155616355.png]  
`IServer`类图

从类图中我们可以看出`IServer`接口主要定义了一个只读的特性集合属性、一个启动和停止的方法声明。在创建宿主构造器`IWebHostBuilder`时我们通过调用`UseKestrel()`方法指定了使用`KestrelServer`作为默认的`IServer`实现。其方法申明中接收了一个`IHttpApplication<TContext> application`的参数，从命名来看，它代表一个`Http`应用程序，我们来看下具体的接口定义：  
![在这里插入图片描述][20190104155634410.png]  
`IHttpApplication`类图

其主要定义了三个方法，第一个方法用来创建请求上下文；第二个方法用来处理请求；第三个方法用来释放上下文。而至于请求上下文，是用来携带请求和返回响应的核心参数，其贯穿与整个请求处理管道之中。`ASP.NET Core`中提供了默认的实现`HostingApplication`，其构造函数接收一个`RequestDelegate _application`（也就是链接中间件形成的处理管道）用来处理请求。

var httpContextFactory = _applicationServices.GetRequiredService<IHttpContextFactory>();
    var hostingApp = new HostingApplication(_application, _logger, diagnosticSource, httpContextFactory);

### 4.3. 启动`IHostedService` ###

`IHostedService`接口用来定义后台任务，通过实现该接口并注册到`Ioc`容器中，它会随着`ASP.NET Core` 程序启动而启动，终止而终止。

## 5. 总结 ##

结合源码，通过对`ASP.NET Core`运行调用堆栈的梳理，其启动流程的总体脉络一目了然，并且了解到主要的几个关键对象：

1.  负责创建`IWebHost`的宿主构造器`IWebHostBuilder`
2.  代表宿主的`IWebHost`接口
3.  用于构建请求管道的`IApplicationBuilder`
4.  中间件衔接而成的`RequestDelegate`
5.  代表`Web Server`的`IServer`接口
6.  贯穿请求处理管道的请求上下文`HttpContext`
7.  可以用来注册后台服务的`IHostedService`接口

[ASP.NET Core]: /images/20210626/1151813e72a3473698aa77787319ea6c.png
[2019010415513024.png]: /images/20210626/850a417bb36e4293afd3ff92a7b1cf14.png
[ASP.Net]: http://xn--ASP-lp6e.Net
[ASP.NET]: http://ASP.NET
[20190104155310125.png]: /images/20210626/1833c6c41102465b8a407b744f2bd5c7.png
[20190104155453237.png]: /images/20210626/1efa1a1b733f40649324a3cea4cb6f8e.png
[2019010415555313.png]: /images/20210626/b14ad52c58244beb82876c45159467b3.png
[20190104155616355.png]: /images/20210626/cc2a1e2b1f5644469076bfc378a5f480.png
[20190104155634410.png]: /images/20210626/40d851100276470f80e41ec4e6f20025.png