.NET Core技術研究-主機Host

時間 2020-04-25

標籤 core 技術研究主機 host 简体版

原文原文鏈接

前一段時間，和你們分享了 ASP.NET Core技術研究-探祕Host主機啓動過程html

可是沒有深刻說明主機的設計。今天整理了一下主機的一些知識，結合先前的博文，完整地介紹一下.NET Core的主機的設計和構建啓動過程。git

1、什麼是主機github

主機是一個封裝了應用資源的對象，即：主機封裝了一堆應用資源，封裝了哪些應用資源呢？web

依賴注入框架 DI
Logging日誌
Configuration 配置
託管服務：IHostedService服務接口的實現

2、Web主機和通用主機json

先說Web主機：即ASP.NET Core Web主機，歸納的講就是託管Web程序的Host。在低於 3.0 的 ASP.NET Core 版本中，Web 主機用於 HTTP 工做負載。windows

咱們新建一個ASP.NET Core2.2的Web應用程序，在Program類的Main函數中咱們能夠看到整個WebHost的構造、啓動過程：服務器

.NET Core提供Web主機的同時，還提供了一個通用主機的概念。架構

通用主機Host和Web主機提供了相似的架構和功能，包含依賴注入框架DI、日誌、配置、各種應用（託管服務）。通用主機的出現，給了咱們更多開發的選擇，好比說後臺處理任務場景。app

在.NET Core3.1版本後，微軟再也不建議將 Web 主機用於 Web 應用，直接使用Host通用主機來替換WebHost，框架

一句話：通用主機能夠託管任何類型的應用，包括 Web 應用。通用主機將替換 Web 主機。爲了向下兼容，WebHost依然可使用。

咱們新建一個ASP.NET Core3.1的Web應用程序，在Program類的Main函數中咱們能夠看到整個WebHost的構造、啓動過程：

接下來，咱們將以ASP.NET Core 3.1這個版本，介紹一下主機的構建過程和啓動過程

3、主機是如何構建的

從上述代碼能夠看到，Main函數中首先調用CreateHostBuilder方法，返回一個IHostBuilder。而後調用IHostBuilder.Build()方法完成

1. 經過Host.CreateDefaultBuilder(args): 構造IHostBuilder的默認實現HostBuilder

在CreateHostBuilder方法內部，首先調用了Host.CreateDefaultBuilder構造了一個HostBuilder，這個咱們先看下源碼，看看到底Host類內部作了什麼操做：

public static IHostBuilder CreateDefaultBuilder(string[] args)
        {
            var builder = new HostBuilder();
 
            builder.UseContentRoot(Directory.GetCurrentDirectory());
            builder.ConfigureHostConfiguration(config =>
            {
                config.AddEnvironmentVariables(prefix: "DOTNET_");
                if (args != null)
                {
                    config.AddCommandLine(args);
                }
            });
 
            builder.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() && !string.IsNullOrEmpty(env.ApplicationName))
                {
                    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) =>
            {
                var isWindows = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
 
                // IMPORTANT: This needs to be added *before* configuration is loaded, this lets
                // the defaults be overridden by the configuration.
                if (isWindows)
                {
                    // Default the EventLogLoggerProvider to warning or above
                    logging.AddFilter<EventLogLoggerProvider>(level => level >= LogLevel.Warning);
                }
 
                logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
                logging.AddConsole();
                logging.AddDebug();
                logging.AddEventSourceLogger();
 
                if (isWindows)
                {
                    // Add the EventLogLoggerProvider on windows machines
                    logging.AddEventLog();
                }
            })
            .UseDefaultServiceProvider((context, options) =>
            {
                var isDevelopment = context.HostingEnvironment.IsDevelopment();
                options.ValidateScopes = isDevelopment;
                options.ValidateOnBuild = isDevelopment;
            });
 
            return builder;
        }

　　從上述.NET Core源代碼中，能夠看到CreateDefaultBuilder內部構造了一個HostBuilder，同時設置了：

將內容根目錄（contentRootPath）設置爲由 GetCurrentDirectory 返回的路徑。
經過如下源加載主機配置
- 環境變量（DOTNET_前綴）配置
- 命令行參數配置
經過如下對象加載應用配置
- appsettings.json
- appsettings.{Environment}.json
- 密鑰管理器當應用在 Development 環境中運行時
- 環境變量
- 命令行參數
添加日誌記錄提供程序
- 控制檯
- 調試
- EventSource
- EventLog（ Windows環境下）

當環境爲「開發」時，啓用範圍驗證和依賴關係驗證。

以上構造完成了HostBuilder，針對ASP.NET Core應用，代碼繼續調用了HostBuilder.ConfigureWebHostDefaults方法。

2. IHostBuilder.ConfigureWebHostDefaults：經過GenericWebHostBuilder對HostBuilder增長ASP.NET Core的運行時設置

構造完成HostBuilder以後，針對ASP.NET Core應用，繼續調用了HostBuilder.ConfigureWebHostDefaults方法。這是一個ASP.NET Core的一個擴展方法：

咱們繼續看ConfigureWebHostDefaults擴展方法內部作了哪些事情：

ASP.NET Core源碼鏈接：https://github.com/dotnet/aspnetcore/blob/master/src/DefaultBuilder/src/GenericHostBuilderExtensions.cs

using System;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore;
 
namespace Microsoft.Extensions.Hosting
{
    /// <summary>
    /// Extension methods for configuring the IWebHostBuilder.
    /// </summary>
    public static class GenericHostBuilderExtensions
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="IWebHostBuilder"/> class with pre-configured defaults.
        /// </summary>
        /// <remarks>
        ///   The following defaults are applied to the <see cref="IWebHostBuilder"/>:
        ///     use Kestrel as the web server and configure it using the application's configuration providers,
        ///     adds the HostFiltering middleware,
        ///     adds the ForwardedHeaders middleware if ASPNETCORE_FORWARDEDHEADERS_ENABLED=true,
        ///     and enable IIS integration.
        /// </remarks>
        /// <param name="builder">The <see cref="IHostBuilder" /> instance to configure</param>
        /// <param name="configure">The configure callback</param>
        /// <returns>The <see cref="IHostBuilder"/> for chaining.</returns>
        public static IHostBuilder ConfigureWebHostDefaults(this IHostBuilder builder, Action<IWebHostBuilder> configure)
        {
            return builder.ConfigureWebHost(webHostBuilder =>
            {
                WebHost.ConfigureWebDefaults(webHostBuilder);
 
                configure(webHostBuilder);
            });
        }
    }
}
© 2020 GitHub, Inc.

　首先，經過類GenericHostWebHostBuilderExtensions，對IHostBuilder擴展一個方法：ConfigureWebHost：builder.ConfigureWebHost

在這個擴展方法中實現了對IWebHostBuilder的依賴注入：即將GenericWebHostBuilder實例傳入方法ConfigureWebHostDefaults內部

代碼鏈接：https://github.com/dotnet/aspnetcore/blob/release/3.1/src/Hosting/Hosting/src/GenericHostWebHostBuilderExtensions.cs

using System;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.DependencyInjection;
 
namespace Microsoft.Extensions.Hosting
{
    public static class GenericHostWebHostBuilderExtensions
    {
        public static IHostBuilder ConfigureWebHost(this IHostBuilder builder, Action<IWebHostBuilder> configure)
        {
            var webhostBuilder = new GenericWebHostBuilder(builder);
            configure(webhostBuilder);
            builder.ConfigureServices((context, services) => services.AddHostedService<GenericWebHostService>());
            return builder;
        }
    }
}

　經過GenericWebHostBuilder的構造函數GenericWebHostBuilder（buillder），將已有的HostBuilder增長了ASP.NET Core運行時設置。

能夠參考ASP.NET Core源代碼：https://github.com/dotnet/aspnetcore/blob/release/3.1/src/Hosting/Hosting/src/GenericHost/GenericWebHostBuilder.cs

先看到這，讓咱們回到ConfigureWebHostDefaults：

將上面兩段代碼合併一下進行理解：ConfigureWebHostDefaults作了兩件事情：

①. 擴展IHostBuilder增長ConfigureWebHost，引入IWebHostBuilder的實現GenericWebHostBuilder，將已有的HostBuilder增長ASP.NET Core運行時的設置。

② ConfigureWebHost代碼中的configure(webhostBuilder)：對注入的IWebHostBuilder，調用 WebHost.ConfigureWebDefaults(webHostBuilder)，啓用各種設置，以下代碼解讀：

internal static void ConfigureWebDefaults(IWebHostBuilder builder)
       {
           builder.ConfigureAppConfiguration((ctx, cb) =>
           {
               if (ctx.HostingEnvironment.IsDevelopment())
               {
                   StaticWebAssetsLoader.UseStaticWebAssets(ctx.HostingEnvironment, ctx.Configuration);
               }
           });
           builder.UseKestrel((builderContext, options) =>
           {
               options.Configure(builderContext.Configuration.GetSection("Kestrel"));
           })
           .ConfigureServices((hostingContext, services) =>
           {
               // Fallback
               services.PostConfigure<HostFilteringOptions>(options =>
               {
                   if (options.AllowedHosts == null || options.AllowedHosts.Count == 0)
                   {
                       // "AllowedHosts": "localhost;127.0.0.1;[::1]"
                       var hosts = hostingContext.Configuration["AllowedHosts"]?.Split(new[] { ';' }, StringSplitOptions.RemoveEmptyEntries);
                       // Fall back to "*" to disable.
                       options.AllowedHosts = (hosts?.Length > 0 ? hosts : new[] { "*" });
                   }
               });
               // Change notification
               services.AddSingleton<IOptionsChangeTokenSource<HostFilteringOptions>>(
                           new ConfigurationChangeTokenSource<HostFilteringOptions>(hostingContext.Configuration));
 
               services.AddTransient<IStartupFilter, HostFilteringStartupFilter>();
 
               if (string.Equals("true", hostingContext.Configuration["ForwardedHeaders_Enabled"], StringComparison.OrdinalIgnoreCase))
               {
                   services.Configure<ForwardedHeadersOptions>(options =>
                   {
                       options.ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto;
                       // Only loopback proxies are allowed by default. Clear that restriction because forwarders are
                       // being enabled by explicit configuration.
                       options.KnownNetworks.Clear();
                       options.KnownProxies.Clear();
                   });
 
                   services.AddTransient<IStartupFilter, ForwardedHeadersStartupFilter>();
               }
 
               services.AddRouting();
           })
           .UseIIS()
           .UseIISIntegration();
       }

　　其內部實現了：

前綴爲 ASPNETCORE_ 的環境變量加載主機配置。
將 Kestrel做爲默認的Web服務器
添加HostFiltering中間件（主機篩選中間件）
若是ASPNETCORE_FORWARDEDHEADERS_ENABLED=true，添加轉接頭中間件ForwardedHeaders
啓用IIS集成

3. 返回ConfigureWebHostDefaults代碼中的configure(webHostBuilder)：執行Program類中的webBuilder.UseStartup<Startup>();

以上過程完成了IHostBuilder.ConfigureWebHostDefaults，經過GenericWebHostBuilder對HostBuilder增長ASP.NET Core的運行時設置。

接下來就是主機的Build過程了：

4. CreateHostBuilder(args).Build()

CreateHostBuilder返回的IHostBuilder，咱們經過代碼Debug，看一下具體的類型：Microsoft.Extensions.Hosting.HostBuilder。

具體的Build過程是怎麼樣的？先看下Build的源碼：https://github.com/dotnet/extensions/blob/release/3.1/src/Hosting/Hosting/src/HostBuilder.cs

主機Build的過程主要完成了：

BuildHostConfiguration：構造配置系統，初始化 IConfiguration _hostConfiguration;
CreateHostingEnvironment：構建主機HostingEnvironment環境信息，包含ApplicationName、EnvironmentName、ContentRootPath等
CreateHostBuilderContext：建立主機Build上下文HostBuilderContext，上下文中包含：HostingEnvironment和Configuration
BuildAppConfiguration：構建應用程序配置
CreateServiceProvider：建立依賴注入服務提供程序，即依賴注入容器

4、主機是如何啓動運行的

咱們先經過Debug，看一下Host的信息：Microsoft.Extensions.Hosting.Internal.Host

這個Run方法也是一個擴展方法：HostingAbstractionsHostExtensions.Run

ASP.NET Core源代碼連接：https://github.com/dotnet/extensions/blob/release/3.1/src/Hosting/Abstractions/src/HostingAbstractionsHostExtensions.cs

其實內部轉調的仍是Host.StartAsync方法，在內部啓動了DI依賴注入容器中全部註冊的服務。

.NET Core代碼連接：https://github.com/dotnet/extensions/blob/release/3.1/src/Hosting/Hosting/src/Internal/Host.cs

5、主機中註冊一個託管服務

以一個後臺自更新（每隔5s 檢查一次程序變動、進行輸出）場景做爲Demo，咱們看一下如何在主機中註冊一個託管服務。

自更新服務UpdateService，須要繼承接口IHostService。

 public class UpdateService : IHostedService
    {
        Task updateTask = null;

        CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();

        public Task StartAsync(CancellationToken cancellationToken)
        {
            updateTask = Task.Run(() =>
            {
                while (cancellationTokenSource.Token.IsCancellationRequested==false)
                {
                    //Check new data...
                    Console.WriteLine(DateTime.Now + ": Executed");
                    Task.Delay(5000).Wait();
                }
            });

            return Task.CompletedTask;
        }

        public Task StopAsync(CancellationToken cancellationToken)
        {
            cancellationTokenSource.Cancel();

            return Task.CompletedTask;
        }
    }

　　同時，咱們須要在ConfigureServices方法中，將UpdateService添加到IoC服務容器中

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddSingleton<IHostedService, UpdateService>();
            services.AddControllers();
        }

　　程序啓動後，能夠看到如下輸出：

以上是對.NET Core主機的概念、設計初衷、構建過程、啓動運行過程、服務註冊的整理和分享。

周國慶

2020/4/18