iT邦幫忙

2022 iThome 鐵人賽

DAY 2
2
自我挑戰組

[Dot Net Core](圖解系列與常用套件)系列 第 2

[Dot Net Core](圖解系列) 2. Host 運作總覽 - Host Outline diagram of Framework operation

  • 分享至 

  • xImage
  •  

Dot Net Core 為一跨平台的應用開發,其此框架上可以加上許多自製服務,這邊以圖解的方式將其軌跡整理出來,將其作出關係圖,當作踏入此框架的一個指引地圖,進而未來可以抓出蛛絲馬跡來深入探討。

當一開始建立 .net core 專案時,呈現如下:

namespace CoreProj
{
    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>();
                });
    }
}

與重要的 Startup 類別:

namespace CoreProj
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
        }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

接著來看 Host 相關建置:

https://ithelp.ithome.com.tw/upload/images/20220902/201446142HlhiisWqJ.jpg

首先進入第一個函示CreateHostBuilder(),使用靜態類別 Host。接著S1的路線新增HostBuilder實體,此為一個架構內部的大容器,包含數個子容器,與其它如 _serviceProviderFactory、_appServices等重要的欄位;也有如驅動的函示如Build、CreateServiceProvider等。沿S2路線,來到此HostBuilder實體的擴增類別,可以找到 ConfugureWebHostDefaults函示,此函示包含相關設定如 Web Server、IIS 、相關provider等設定。當設置好該賦予的設定與預先規劃好要做的程式後,來到S3路線的 CreateServiceProvider。這邊會執行註冊Service,所以首先會到S4建立 ServiceCollection 實體當作容器,其擴充類別提供了重要的註冊函示 Add、AddScoped、AddSingleton、AddTransient等,註冊的服務會存放到 _desciptors,為ServiceDescriptor集合。

接下來要繼續HostBuilder實體的ConfugureWebHostDefaults所執行的事:
https://ithelp.ithome.com.tw/upload/images/20220902/20144614Ur1ekpN1TF.jpg

HostBuilder實體的ConfugureWebHostDefaults會新增實體GenericWebHostBuilder,並將此實體傳送到靜態類別WebHost的ConfugureWebDefaults函示中,做環境的設定、相關服務的註冊、IIS的設定及相關建置程式規劃。

另外還會呼叫GenericWebHostBuilder的UseStartup函示,它會透過 Microsoft.AspNetCore.Hosting 下的擴增類別作初始化設定後,再呼叫GenericWebHostBuilder的ConfigureServices函示,其先對HostBuilder.ConfigureServices做委派內容;最後離開UseStartup再對HostBuilder.ConfigureServices進行委派,如下:

HostBuilder.ConfigureServices((context, services) => services.AddHostedService<GenericWebHostService>());

以上可以視為大部分的設定與委派程式行為,到此時為一個中途段落,接下來是 HostBuilder.Build() ,非常重要,有5大步驟,以下為第一步,即呼叫 HostBuilder.BuildHostConfiguration:
https://ithelp.ithome.com.tw/upload/images/20220902/20144614cBkJHDDdJg.jpg

先新增實體ConfigurationBuilder,並利用ConfigurationBuilder.Build新增ConfigurationRoot實體,回存到HostBuilder的_hostConfiguration。接續foreach處理HostBuilder裡的_configureHostConfigActions此一子容器的委派內容,其中一個內容點出來為執行GenericWebHostBuilder.ExecuteHosingStartups(),產生實體HostingStartupWebHostBuilder實體存回自己的_hostingStartupWebHostBuilder,可以利用它來對GenericWebHostBuilder做相關的事務。

第二步為呼叫 HostBuilder.CreateHostingEnvironment,其內容大多對環境做設定。

第三步為呼叫 HostBuilder.CreateHostingBuilderContext,如下:
https://ithelp.ithome.com.tw/upload/images/20220902/20144614hD8VMJsQuq.jpg

新增HostBuilderContext實體,存放了HostBuilder的_hostConfiguration與_hostingEnvironment參考,再回存到HostBuilder的_hostBuilderContext。

第四步呼叫 HostBuilder.BuildAppConfiguration:

https://ithelp.ithome.com.tw/upload/images/20220902/20144614hU4eXBCQtC.jpg
新增了ConfigurationBuilder實體,也一用擴增類別函示新增了ChainedConfigurationSource實體,將HostBuilder的_hostConfiguration參考加入到configuration屬性中,再把自己整份實體存到ConfigurationBuilder.Sources;再呼叫ConfigurationBuilder.Build新增實體ConfigurationRoot,回存到HostBuilder的_appConfiguration。

第五步呼叫HostBuilder.CreateServiceProvider:
https://ithelp.ithome.com.tw/upload/images/20220902/20144614QwrJvzRcjK.jpg

這步驟和開發者會接觸到的Startup類別有密切關係。首先會foreach處理HostBuilder的容器_configureServicesActions,其中一個被處理的事務是去擷取專案內的Startup類別,並利用了StartupLoader.FindMethod方法將Startup類別中的ConfigureServices函式相關資訊存到ConfigureServicesBuilder.MethodInfo屬性,然後執行此函式。

此函示可以供開發者註冊相關服務,也可將實行DI到Controller建構子參數的實作註冊到ServiceCollection的_descriptor中。

最後利用預設的 ServiceFactoryAdapter 與 DefaultServiceProviderFactory,建立了Provider如下:
https://ithelp.ithome.com.tw/upload/images/20220902/20144614bEbjzOMxIK.jpg

其以ServiceCollection為參數透過DynamicServiceProviderEngine與父類別ServiceProviderEngine產生CallSiteFactory實體為屬性,存回HostBuilder的_appServices。如果要實現已經註冊的服務,可以呼叫透過DynamicServiceProviderEngine繼承的ServiceProvider中的函示GetService來進行resolve。

回到剛剛Startup類別中的ConfigureServices函式,本專案執行services.AddControllers(),如下:

https://ithelp.ithome.com.tw/upload/images/20220902/20144614uz2ShkfjZr.jpg

然後執行:

services
.AddMvcCore()
.AddApiExplorer()
.AddAuthorization()
.AddCors()
.AddDataAnnotations()
.AddFormatterMappings()

services.AddMvcCore為 ServiceCollection的擴充類別下的AddMvcCore函式,最後產生MvcBuilder實體,其中一個屬性Services,為整個ServiceCollection的參考。而此MvcBuilder實體的產生目的,是為之後的AddApiExplorer、AddAuthorization、AddCors、AddDataAnnotations與AddFormatterMappings,以MvcBuilder擴充類別的方式來整合這些函式。這些函式的目的,就是將相關service註冊到ServiceCollection中的_descriptor。

最後要展示的是Startup類別中,Configure函式被呼叫的時間點與用途,運作關係如下:

https://ithelp.ithome.com.tw/upload/images/20220902/20144614lr8QiNHWZm.jpg

在HostBuilder.Run()的階段,其中一個task為 Host.StartAsync(),會先執行產生ApplicationBuilder實體的任務,如上圖,此時體會傳入GenericWebHostService.Options.ConfigureApplication,再利用 ConfigurationBuilder.Build去執行Startup中的Configure函式。這個函式可以供開發者利用建構好的ApplicaitonBuilder去加入一些MiddleWare,依照順序執行。

以上是 Dot Net Core 在 Host 建立與設定時,與專案 Startup 類別的互動關係。

內文亦收錄於
https://czxdas.medium.com/dot-net-core-host-start-with-startup-class-outline-diagram-of-framework-operation-5baf8c61765a


上一篇
[Dot Net Core](圖解系列) (常用套件)1. 簡介
下一篇
[Dot Net Core](圖解系列) 3. IOC - 牽動框架設計的重要環節 - An important part of system design-an IOC overview
系列文
[Dot Net Core](圖解系列與常用套件)30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言