asp.net core 3.1 入口:Program.cs中的Main函數


本文分析Program.cs 中Main()函數中代碼的運行順序分析asp.net core程序的啟動,重點不是剖析源碼,而是理清程序開始時執行的順序。到底用了哪些實例,哪些法方。

asp.net core 3.1 的程序入口在項目Program.cs文件里,如下。

ususing System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; namespace WebDemo { public class Program { public static void Main(string[] args) { CreateHostBuilder(args).Build().Run(); } 
        public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); }); } }

1. Program類

program類是定義在項目根目錄Program.cs文件中,所有.net core程序的入口,包括asp.net core 程序。這很有意思,就有點類似控制端程序。相比之前的web項目沒有任何程序入口只有web.config、global這類配置文件和全局文件這種沒有程序入口web項目,我覺得這類更容易理解asp.net core是怎么工作的。

在asp.net core 3.1中 的Program類里,定義了2個方法:Main() 和CreateHostBuilder()

2. 主程序入口Program.Main()方法

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

Main() 方法是整個項目的入口方法,就如同C系列語言,所有的程序入口都是。這里main()只有一行代碼,但是實際上執行了三個函數C:

  1 IHostBuilder builder= CreateHostBuilder(args);
  2 IHost host=builder.Build();
  3 host.Run();

第一行,是定義在Program類的CreateHostBuilder 它主要產生一個IhostBuilder實例builder。

第二行,通過builder.Build()法方產生一個Ihost實例 host。

第三含,通過host.Run()方法,開始運行web項目,這時候就可以響應各種請求了。

而這個過程里最繁瑣的就是創建builder,本文重點篇幅就是在這里。

3. 創建並配置主機Builder:Program.CreateHostBuilder(args)法方

分解CreateHostBuilder(args) 的定義

此法方通過lamada表達式定義在Pogram類中。因為它就執行了一句化,所以可以用這種簡便的方式定義(關於匿名函數、lamada、內置委托可以參考我之前的文章C# 匿名方法(函數) 匿名委托 內置泛型委托 lamada1)。為了方便閱讀按照上面刨析Main()法方,所以它實際的定義如下:

  1         public static IHostBuilder CreateHostBuilder(string[] args)
  2         {
  3             IHostBuilder builder = Host.CreateDefaultBuilder(args);
  4             Action < IWebHostBuilder > configAction = delegate(IWebHostBuilder webBuilder)
  5             {
  6                 webBuilder.UseStartup<Startup>();
  7             };
  8             builder=builder.ConfigureWebHostDefaults(configAction);
  9             return builder;
 10         }

3.1. builder誕生 :生成IHostBuilder

將從Host.CreateHostBuilder()法方分析入手

CreateHostBuilder()法方的第一行代碼是調用Host.CreateDefaultBuilder(args)法方,來創建IBuilder 對象實例。

IHostBuilder builder = Host.CreateDefaultBuilder(args);

IHostBuilder是一個非常重要的實例,有了這個實例才可以繼續后續的加載更多的配置操作。通過IHostBuilder.Build()生產IHost實例。最終通過IHost.Run()運行項目。

3.1.1 Host類——用於產生初始的builder靜態類

Host類是定義在Microsoft.Extensions.Hosting命名空間(Program.cs中引用了該命名公開)下的靜態類.在Program.cs里引入。

聲明如下:

  1 using Microsoft.Extensions.Hosting;
  2 
  3 namespace Microsoft.Extensions.Hosting
  4 {
  5     public static class Host
  6     {
  7 	    public static IHostBuilder CreateDefaultBuilder();
  8         public static IHostBuilder CreateDefaultBuilder(string[] args);
  9     }
 10 }

Host靜態類就一個法方就是CreateDefaultBuilder() 。合計2個重載聲明:一個帶參數,一個不帶參數。參考源碼(.NET Core 3.0之深入源碼理解Host(一)2)不帶參數的重載實際在是將null作為參數調用帶參數形式,如下:

  1 public static IHostBuilder CreateDefaultBuilder() =>CreateDefaultBuilder(args: null);
3.1.2 Host.CreateDefaultBuilder(args)方法
官方說明是用預先配置的默認值初始化一個Microsoft.Extensions.Hosting.HostBuilder實例(Initializes a new instance of the Microsoft.Extensions.Hosting.HostBuilder class with pre-configured defaults,詳細見參考官方文檔3)。
相關操作有:設置根目錄ContentRootPath ;給Host.IConfiguration 加載:環境變量EnvironmentName,命令行參數args,配置文件IConfiguration.[EnvironmentName] json;還有加載日志模塊等等。
詳細見參考文檔2、3,其中.NET Core 3.0之深入源碼理解Host(一),作者從源碼角度剖析了此法方,官方文檔Host.CreateDefaultBuilder 方法官方說明了法方操作那些內容。

3.2. IHostBuilder轉變成IWebHostBuilder

繼續對Host.CreateHostBuilder()法方分析,在3.1建立了IHostBuilder實例后,將通過builder.ConfigureWebHostDefaults(Action <IWebHostBuilder >)方法將IHostBuilder實例轉變為一個web主機性質的webbuilder(IWebHostBuilder)

IHoustBuilder.ConfigureWebHostDefaults(Action <IWebHostBuilder>)方法定義在Microsoft.Extensions.Hosting.GenericHostBuilderExtensions靜態類中(GenericHostBuilderExtensions.cs),此靜態類就定義這一個靜態方法。

3.2.1. ConfigureWebHostDefaults()參數

此處參數configure是一個內置委托Action <IWebHostBuilder>,這個委托的定義就執行一行代碼:
webBuilder.UseStartup<Startup>();

3.2.2. ConfigureWebHostDefaults()方法定義

其實ConfigureWebHostDefaults(Action <IWebHostBuilder >)方法是一個IHostBuilder的擴展方法(所以之前的寫法並不准確,缺少了this builder參數,之前省略了)。
為了方便閱讀法,用3.中的方式碼剖析如下:
 
 
 
         
  1  	     public static IHostBuilder ConfigureWebHostDefaults(this IHostBuilder builder, Action<IWebHostBuilder> configure)
  2         {
  3             Action<IWebHostBuilder> webconfigure = delegate(IWebHostBuilder webHostBuilder)
  4             {
  5                 WebHost.ConfigureWebDefaults(webHostBuilder);
  6                 configure(webHostBuilder);
  7             };
  8             return builder.ConfigureWebHost(webconfigure);
  9         }
其實就調取了IHostBuilder的另一個擴展類ConfigureWebHost(Action<IWebHostBuilder>)(此擴展法方定義在Microsoft.Extensions.Hosting.GenericHostWebHostBuilderExtensions靜態類中)。

3.2.2.1 把IHostBuilder轉變為IWebHostBuilder: builder.ConfigureWebHost(webconfigure)法方

3.2.2.1.1 Action<IWebHostBuilder> webconfigure參數
內置委托,在這里對委托進行了定義,主要兩行代碼:
配置IWebHostBuilder的默認web設置。
 
 
 
         
WebHost.ConfigureWebDefaults(webHostBuilder);
在core2.1中該方法是在CreateHostBuilder()中WebHost.CreateDefaultBuilder(arg)中調用,core3.1,改為Host.ConfigureDefualts(arg)后,通過委托在ConfigureWebHost中調用。因為此方法在委托里調用,在下面章節降到委托執行的時候再詳細說明。
調用參數傳入的委托
configure(webHostBuilder);
 就是3.2.1中的
 
 
 
         
webBuilder.UseStartup<Startup>();
具體在下面章節講解委托執行時在詳細說明。
3.2.2.1.2 builder.ConfigureWebHost(webconfigure)法方定義
定義在Microsoft.Extensions.Hosting.GenericHostWebHostBuilderExtensions(GenericHostWebHostBuilderExtensions.cs) 
  1 using System;
  2 using Microsoft.AspNetCore.Hosting;
  3 using Microsoft.AspNetCore.Hosting.Internal;
  4 
  5 namespace Microsoft.Extensions.Hosting
  6 {
  7     public static class GenericHostWebHostBuilderExtensions
  8     {
  9         public static IHostBuilder ConfigureWebHost(this IHostBuilder builder, Action<IWebHostBuilder> configure)
 10         {
 11             var webhostBuilder = new GenericWebHostBuilder(builder);
 12             configure(webhostBuilder);
 13             return builder;
 14         }
 15     }
 16 }
Microsoft.AspNetCore.Hosting.Internal.GenericWebHostBuilder
在asp.net core 2.1 里IWebHostBuilder 在asp.net core 3.1里是怎么把泛型IHostBuilder生產webhost的builder的了,終於扒到它了。  
通過Microsoft.AspNetCore.Hosting.Internal.GenericWebHostBuilder類實例。GenericWebHostBuilder是一個內部類。這個類網上資源極少,甚至在官方文檔里找不到說明,但可以參考其源碼GenericWebHostBuilder.cs源代碼。此類聲明和其構造函數聲明如下:
internal class GenericWebHostBuilder : IWebHostBuilder, ISupportsStartup, ISupportsUseDefaultServiceProvider
{
     public GenericWebHostBuilder(IHostBuilder builder);
}
此類非常重要,它是Asp.net core 3.1 項目中IHostBuilder轉變成IWebHostBuilder的基石或者源頭 一個IHostBuilder實例最早就是通過此類構造函數實例化后變成了2.1里的IWebHostBuilder。實際干的就是注入了一些web有關的服務,詳細建議查看源碼(參考文檔4
3.2.2.2 給IWebHostBuilder配置Web相關參數委托參數:終於執行委托了
 
 
 
         
configure(webhostBuilder);
在傳入了那么多層委托后,終於我們扒到底了,在實現了IHostBuilder轉變為IWebHostBuilder后,所有config有關的委托終於得以執行
 
 
 
         
  1 //在 builder.ConfigureWebHostDefaults()(-->在program.GreateHostBuilder()中)
  2 //和下一句代碼一同作為委托參數傳入builder.ConfigureWebHost()
  3 WebHost.ConfigureWebDefaults(webHostBuilder);
  4 //Program.CreateHostBuilder()里的作為委托參數傳入builder.ConfigureWebHostDefaults()
  5 //再經過builder.ConfigureWebHostDefaults()合上一句一同作為委托傳入builder.ConfigureWebHost()
  6 webBuilder.UseStartup<Startup>();
3.2.2.2.1 WebHost.ConfigureWebDefualts(IWebHostBuilder)方法:
此方法在Asp.net core 2.1中 是WebHost.CreateDefaultBuilder(args) 里最后調用的方法,而在Asp.net core 3.1中,把IWebHostBuilder該為泛型IHostBuilder后,在執行IHostBuilder.ConfigureWebHost()時回調委托執行。此方法作用類似與Host.CreateDefaultBuilder(args),使用預配置配置一些關於Web方式的參數。主要是注入一些web相關的服務,配置主機地址等。此方法沒有官方文檔說明,建議直接查看源碼WebHost.cs源代碼(參考文檔5)。
3.2.2.2.2 webBuilder.UseStartup<Startup>()法方:
UseStartup()是webbuilder的擴展發放,定義在Microsoft.AspNetCore.Hosting.WebHostBuilderExtensions靜態類中(WebHostBuilderExtensions.cs),此方法申明如下
public static IWebHostBuilder UseStartup(this IWebHostBuilder hostBuilder, Type startupType)

從方法名就可以看出是使用Startup類,這個方法主要使用反射技術,反射Startup類,響應startup類中的配置的信息

3.3. 最后梳理一下builder核心的代碼

1.IHostBuilder builder = Host.CreateDefaultBuilder(args);
創建一個基礎builder(讀取app.json)
2.IWebHostBuilder webHostBuilder= new GenericWebHostBuilder(builder);
轉換為webbuilder
3.WebHost.ConfigureWebDefaults(webHostBuilder);
給webbuilder使用預先的默認值配置
4.webBuilder.UseStartup<Startup>();
讀取startup類配置信息

4.總結

aps.net core 3.1的程序啟動代碼分析下來。基本3個概念創建builder ,通過builder生成host ,最后使用host執行起來。其中builder及builder配置 ,host主機都是重要的概念。core 3.1 和 core2.1的區別,就是把IWebHostBuilder上再抽象一個IHostBuilder,可以是core 3.1的代碼更加的靈活,以后的服務可以不單單是web服務。
另外asp.net core 的builder 配置中可以看到很多非常依賴,控制反轉技術也就是注入依賴,好處就是想要什么服務就注冊什么服務,更加靈活。
如果想深入學習,建議參考如下文章:

1. .NET Core 3.0之深入源碼理解Host(一)
2. .NET Core 3.0之深入源碼理解Host(二)
  作者的這個2個文章從源碼角度簡介了Ihostbuilder的相關知識剖析深度更深
3. 官方文檔:.NET 通用主機 講解IHostBuilder相關知識
4. 官方文檔:ASP.NET Core 中的應用啟動 介紹startup類相關知識


參考文檔:
1. C# 匿名方法(函數) 匿名委托 內置泛型委托 lamada 作者:edzjx
2. .NET Core 3.0之深入源碼理解Host(一) 作者:艾心
3. 官方文檔Host.CreateDefaultBuilder 方法 作者:Micrsoft官方文檔
4. GenericWebHostBuilder.cs源代碼 作者:Asp.net@github 
5. WebHost.cs源代碼 作者:Asp.net@github 
6. .NET Core 3.0之深入源碼理解Host(二) 作者:艾心
7. 官方文檔:.NET 通用主機 作者:Micrsoft官方文檔
8. 官方文檔:ASP.NET Core 中的應用啟動 作者:Micrsoft官方文檔


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM