【ASP.NET Core】運行原理之創建WebHost

来源:http://www.cnblogs.com/neverc/archive/2017/12/05/7988226.html
-Advertisement-
Play Games

本節將分析 代碼。 源代碼參考.NET Core 2.0.0 "WebHostBuilder" "WebHost" "Kestrel" 問題概要 1. Hosting中有哪2個ServiceProvider，各自如何創建，以及有哪些ServiceCollection。 1. 什麼時候執行Startu ...


本節將分析WebHost.CreateDefaultBuilder(args).UseStartup<Startup>().Build();代碼。

源代碼參考.NET Core 2.0.0

問題概要

  1. Hosting中有哪2個ServiceProvider，各自如何創建，以及有哪些ServiceCollection。
  2. 什麼時候執行Startup的ConfigureServices 和 Configure方法
  3. 什麼時候註冊和使用的Server
  4. 手工模擬一個DefaultWebHost環境

WebHost.CreateDefaultBuilder(args)

該方法為WebHost類的靜態方法，內部創建1個WebHostBuilder。

  1. 參數args將作為配置項
  2. 添加了Kestrel、Configuration、Logging、IISIntegration中間件，同時配置ContentRoot和DefaultServiceProvider
public static IWebHostBuilder CreateDefaultBuilder(string[] args)
{
    var builder = new WebHostBuilder()
        .UseKestrel()
        .UseContentRoot(Directory.GetCurrentDirectory())
        .ConfigureAppConfiguration((hostingContext, config) =>
        {
            var env = hostingContext.HostingEnvironment;

            config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                    .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true);

            if (env.IsDevelopment())
            {
                var appAssembly = Assembly.Load(new AssemblyName(env.ApplicationName));
                if (appAssembly != null)
                {
                    config.AddUserSecrets(appAssembly, optional: true);
                }
            }

            config.AddEnvironmentVariables();

            if (args != null)
            {
                config.AddCommandLine(args);
            }
        })
        .ConfigureLogging((hostingContext, logging) =>
        {
            logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
            logging.AddConsole();
            logging.AddDebug();
        })
        .UseIISIntegration()
        .UseDefaultServiceProvider((context, options) =>
        {
            options.ValidateScopes = context.HostingEnvironment.IsDevelopment();
        });
    return builder;
}

UseKestrel

在UseKestrel()方法中，註冊了3個服務到List<Action<WebHostBuilderContext, IServiceCollection>>欄位上。(以供後續註冊)

public static IWebHostBuilder UseKestrel(this IWebHostBuilder hostBuilder)
{
    return hostBuilder.ConfigureServices((Action<IServiceCollection>) (services =>
    {
        services.AddSingleton<ITransportFactory, LibuvTransportFactory>();
        services.AddTransient<IConfigureOptions<KestrelServerOptions>, KestrelServerOptionsSetup>();
        services.AddSingleton<IServer, KestrelServer>();
    }));
}

public IWebHostBuilder ConfigureServices(Action<WebHostBuilderContext, IServiceCollection> configureServices)
{
    this._configureServicesDelegates.Add((_, services) => configureServices(services));
    return (IWebHostBuilder) this;
}

UseContentRoot

UseContentRoot方法則是添加到IConfiguration欄位上,這個欄位在構造函數初始化
this._config = (IConfiguration) new ConfigurationBuilder().AddEnvironmentVariables("ASPNETCORE_").Build();

public static IWebHostBuilder UseContentRoot(this IWebHostBuilder hostBuilder, string contentRoot)
{
    if (contentRoot == null)
    throw new ArgumentNullException(nameof (contentRoot));
    return hostBuilder.UseSetting(WebHostDefaults.ContentRootKey, contentRoot);
}

public IWebHostBuilder UseSetting(string key, string value)
{
    this._config[key] = value;
    return (IWebHostBuilder) this;
}

ConfigureAppConfiguration

ConfigureAppConfiguration方法是添加到List<Action<WebHostBuilderContext, IConfigurationBuilder>>欄位上
在外部添加了
AddJsonFile("appsettings.json")、AddJsonFile(string.Format("appsettings.{0}.json", (object) hostingEnvironment.EnvironmentName))
AddEnvironmentVariables()
AddCommandLine(args)

public IWebHostBuilder ConfigureAppConfiguration(Action<WebHostBuilderContext, IConfigurationBuilder> configureDelegate)
{
    this._configureAppConfigurationBuilderDelegates.Add(configureDelegate);
    return (IWebHostBuilder) this;
}

ConfigureLogging

ConfigureLogging註冊Log到ServiceCollection上
在外部添加了3個ILoggerProvider
logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
logging.AddConsole();
logging.AddDebug();

public static IWebHostBuilder ConfigureLogging(this IWebHostBuilder hostBuilder, Action<WebHostBuilderContext, ILoggingBuilder> configureLogging)
{
    return hostBuilder.ConfigureServices((context, services) => services.AddLogging(builder => configureLogging(context, builder));
}

public IWebHostBuilder ConfigureServices(Action<WebHostBuilderContext, IServiceCollection> configureServices)
{
    this._configureServicesDelegates.Add(configureServices);
    return (IWebHostBuilder) this;
}

UseDefaultServiceProvider

UseDefaultServiceProvider配置和替換服務

var options = new ServiceProviderOptions { ValidateScopes = context.HostingEnvironment.IsDevelopment()};
services.Replace(ServiceDescriptor.Singleton<IServiceProviderFactory<IServiceCollection>>((IServiceProviderFactory<IServiceCollection>) new DefaultServiceProviderFactory(options)));

UseStartup

UseStartup相當於註冊了一個IStartup服務。

public static IWebHostBuilder UseStartup(this IWebHostBuilder hostBuilder, Type startupType)
{
    string name = startupType.GetTypeInfo().Assembly.GetName().Name;
    return hostBuilder.UseSetting(WebHostDefaults.ApplicationKey, name).ConfigureServices((Action<IServiceCollection>) (services =>
    {
    if (typeof (IStartup).GetTypeInfo().IsAssignableFrom(startupType.GetTypeInfo()))
        ServiceCollectionServiceExtensions.AddSingleton(services, typeof (IStartup), startupType);
    else
        ServiceCollectionServiceExtensions.AddSingleton(services, typeof (IStartup), (Func<IServiceProvider, object>) (sp =>
        {
        IHostingEnvironment requiredService = sp.GetRequiredService<IHostingEnvironment>();
        return (object) new ConventionBasedStartup(StartupLoader.LoadMethods(sp, startupType, requiredService.EnvironmentName));
        }));
    }));
}

根據Startup是否繼承IStartup，來決定註冊的方式。未繼承的時候，會使用ConventionBasedStartup來封裝自定義的Startup。

Build

Build方法是WebHostBuilder最終的目的，將構造一個WebHost返回。

同時初始化WebHost對象，WebHostBuilder.Build代碼：

public IWebHost Build()
{
    var hostingServices = BuildCommonServices(out var hostingStartupErrors);
    var applicationServices = hostingServices.Clone();
    var hostingServiceProvider = hostingServices.BuildServiceProvider();

    AddApplicationServices(applicationServices, hostingServiceProvider);

    var host = new WebHost(
        applicationServices,
        hostingServiceProvider,
        _options,
        _config,
        hostingStartupErrors);

    host.Initialize();

    return host;
}

在Build方法中，BuildCommonServices最為重要,將構造第一個ServiceCollection。這裡我們稱為hostingServices。
將包含hostEnv、Config、ApplicationBuilder、Logging、StartupFilter、Startup、Server。參考BuildCommonServices

private IServiceCollection BuildCommonServices(out AggregateException hostingStartupErrors)
{
    if (!this._options.PreventHostingStartup)
    {
        foreach (string hostingStartupAssembly in (IEnumerable<string>) this._options.HostingStartupAssemblies)
        {
            foreach (HostingStartupAttribute customAttribute in Assembly.Load(new AssemblyName(hostingStartupAssembly)).GetCustomAttributes<HostingStartupAttribute>())
                ((IHostingStartup) Activator.CreateInstance(customAttribute.HostingStartupType)).Configure((IWebHostBuilder) this);
        }
    }
    ServiceCollection services = new ServiceCollection();
    // hostEnv
    _hostingEnvironment.Initialize(this._options.ApplicationName, this.ResolveContentRootPath(this._options.ContentRootPath, AppContext.BaseDirectory), this._options);
    services.AddSingleton<IHostingEnvironment>(this._hostingEnvironment);
    // config
    IConfigurationBuilder configurationBuilder = new ConfigurationBuilder().SetBasePath(this._hostingEnvironment.ContentRootPath).AddInMemoryCollection(this._config.AsEnumerable());
    foreach (Action<WebHostBuilderContext, IConfigurationBuilder> configurationBuilderDelegate in this._configureAppConfigurationBuilderDelegates)
        configurationBuilderDelegate(this._context, configurationBuilder);
    IConfigurationRoot configurationRoot = configurationBuilder.Build();
    services.AddSingleton<IConfiguration>((IConfiguration) configurationRoot);
    services.AddOptions();
    // application
    services.AddTransient<IApplicationBuilderFactory, ApplicationBuilderFactory>();
    services.AddTransient<IHttpContextFactory, HttpContextFactory>();
    services.AddScoped<IMiddlewareFactory, MiddlewareFactory>();
    // log
    services.AddLogging();
    services.AddTransient<IStartupFilter, AutoRequestServicesStartupFilter>();
    services.AddTransient<IServiceProviderFactory<IServiceCollection>, DefaultServiceProviderFactory>();
    // 配置的StartupType
    if (!string.IsNullOrEmpty(this._options.StartupAssembly))
    {
        Type startupType = StartupLoader.FindStartupType(this._options.StartupAssembly, this._hostingEnvironment.EnvironmentName);
        if (typeof (IStartup).GetTypeInfo().IsAssignableFrom(startupType.GetTypeInfo()))
            ServiceCollectionServiceExtensions.AddSingleton(services, typeof (IStartup), startupType);
        else
            ServiceCollectionServiceExtensions.AddSingleton(services, typeof (IStartup), new ConventionBasedStartup(StartupLoader.LoadMethods(startupType)));
    }
    // UseStartup、UseKestrel、ConfigureLogging
    foreach (Action<WebHostBuilderContext, IServiceCollection> servicesDelegate in this._configureServicesDelegates)
        servicesDelegate(this._context, (IServiceCollection) services);
    return (IServiceCollection) services;
}

當 hostingServices 創建完成後，會馬上拷貝一份applicationServices提供給WebHost使用，同時創建第一個ServiceProvider hostingServiceProvider。

host.Initialize()該方法則是初始化WebHost

  1. 生成第二個ServiceProvider _applicationServices(微軟的內部欄位命名，感覺不太規範);
  2. 初始化Server，讀取綁定的地址。
  3. 創建Application管道，生成RequestDelegate。
public void Initialize()
{
    _startup = _hostingServiceProvider.GetService<IStartup>();
    _applicationServices = _startup.ConfigureServices(_applicationServiceCollection);
    EnsureServer();
    var builderFactory = _applicationServices.GetRequiredService<IApplicationBuilderFactory>();
    var builder = builderFactory.CreateBuilder(Server.Features);
    builder.ApplicationServices = _applicationServices;

    var startupFilters = _applicationServices.GetService<IEnumerable<IStartupFilter>>();
    Action<IApplicationBuilder> configure = _startup.Configure;
    foreach (var filter in startupFilters.Reverse())
    {
        configure = filter.Configure(configure);
    }
    configure(builder);

    this._application = builder.Build();    // RequestDelegate
}

WebHost.Run

創建完 WebHost 之後，便調用它的 Run 方法，而 Run 方法會去調用 WebHost 的 StartAsync 方法

  1. 調用Server.Start，將Initialize方法創建的Application管道傳入以供處理消息
  2. 執行HostedServiceExecutor.StartAsync方法
public static void Run(this IWebHost host)
{
    await host.RunAsync(cts.Token, "Application started. Press Ctrl+C to shut down.");
}

private static async Task RunAsync(this IWebHost host, CancellationToken token, string shutdownMessage)
{
    await host.StartAsync(token);
    var hostingEnvironment = host.Services.GetService<IHostingEnvironment>();
    Console.WriteLine($"Hosting environment: {hostingEnvironment.EnvironmentName}");
    Console.WriteLine($"Content root path: {hostingEnvironment.ContentRootPath}");
    var serverAddresses = host.ServerFeatures.Get<IServerAddressesFeature>()?.Addresses;

    if (serverAddresses != null)
        foreach (var address in serverAddresses)
            Console.WriteLine($"Now listening on: {address}");

    if (!string.IsNullOrEmpty(shutdownMessage))
        Console.WriteLine(shutdownMessage);
}

public virtual async Task StartAsync(CancellationToken cancellationToken = default (CancellationToken))
{
    Initialize();
    _applicationLifetime = _applicationServices.GetRequiredService<IApplicationLifetime>() as ApplicationLifetime;
    _hostedServiceExecutor = _applicationServices.GetRequiredService<HostedServiceExecutor>();
    var httpContextFactory = _applicationServices.GetRequiredService<IHttpContextFactory>();
    var hostingApp = new HostingApplication(_application, _logger, diagnosticSource, httpContextFactory);
    await Server.StartAsync(hostingApp, cancellationToken).ConfigureAwait(false);

    _applicationLifetime?.NotifyStarted();
    await _hostedServiceExecutor.StartAsync(cancellationToken).ConfigureAwait(false);
}

問題解答

  1. hostingServices(WebHostBuilder) 和 _applicationServices(WebHost)。區別是_applicationServices中比hostingServices多處Startup方法註冊的服務。
  2. 都是WebHost中執行的。ConfigureServices在_applicationServices生成前，Configure在_applicationServices生成後。
  3. 最初的註冊在WebHostBuilder的UseKestrel，使用在WebHost的Run方法

手工模擬一個DefaultWebHost環境

new WebHostBuilder()
    .UseKestrel()                                       // 使用Kestrel伺服器
    .UseContentRoot(Directory.GetCurrentDirectory())    // 配置根目錄 會在ConfigurationBuilder、 IHostingEnvironment(後續其他中間件) 和 WebHostOptions(WebHost)用到。
    .ConfigureAppConfiguration((context, builder) => builder.AddJsonFile("appsetting.json", true, true))    // 添加配置源
    .ConfigureLogging(builder => builder.AddConsole())  // 添加日誌適配器
    .UseStartup<Startup>()                              // 選擇Startup
    .Build().Run();                                     // 生成WebHost 並 啟動

本文鏈接：http://neverc.cnblogs.com/p/7988226.html


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Python標準庫inspect
    inspect模塊用於收集python對象的信息，可以獲取類或函數的參數的信息，源碼，解析堆棧，對對象進行類型檢查等等，有幾個好用的方法： getargspec(func) 返回一個命名元組ArgSpect(args, varargs, keywords, defaults)，args是函數位置參數 ...
  • python和json數據相互轉換,json讀取和寫入,repr和eval()使用
    python數據轉換json 將json轉換為pathon數據 repr 和 eval用法 json讀取和寫入 總結: 數據轉換 第一步: 引入json包: import json 第二步: 使用 json.dumps(pythonObj) 把python數據轉換json數據 第三步: 使用json ...
  • 初學者易上手的SSH-整合
    許久沒更新博客了！ spring還有一章aop(面向切麵)，我就沒講述了，你們可以去看下代理模式。 那麼我們開始整合:struts2 2.3.4 ,hibernate 5.2.10 ,spring 4.3.10 ，一直以來用到的xml式，那麼整合也不例外，就是有些麻煩。另外註解式想瞭解請留言(雖然s ...
  • 讀取本地json文件,解析json
    模擬用戶登錄 ...
  • 整合SSH時，遇到了org.springframework.beans.factory.BeanCreationException錯誤
    整合SSH時，遇到了org.springframework.beans.factory.BeanCreationException錯誤 ...
  • 重構手法之處理概括關係【1】
    返回總目錄 本小節目錄 Pull Up Field（欄位上移） Pull Up Method（函數上移） Pull Up Constructor Body（構造函數本體上移） 1Pull Up Field（欄位上移） 概要 兩個子類擁有相同的欄位。將該欄位移至基類。 動機 如果各個子類是分別開發的， ...
  • Nginx集群之SSL證書的WebApi令牌驗證
    Nginx在WebApi集群，除了OAUTH身份驗證外，針對移動端的手機、平板電腦等，還經常使用Token令牌驗證，通過伺服器授權發出有效期的Token，客戶端通過此Token在當前有效期內，進行訪問獲取信息數據。Token驗證在很多方面都廣泛應用，舉一個實際應用場景：A客戶想通過接收郵件或者簡訊網... ...
  • 泛型介面的斜變與抗變
    1.名詞解釋 （1）協變：父類的對象用子類代替 （2）抗變：子類的對象用父類代替 如方法的參數是協變的，而返回值是抗變的。 2.泛型介面的協變與抗變 （1）協變：IDemo<out T> 》IDemo<out ParentT> 泛型類型T只能作為IDemo中方法或屬性的返回值 （2）抗變：IDemo ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類