.NET Core 3.0之深入源碼理解Host(一)

寫在前面

ASP .NET Core中的通用主機構建器是在v2.1中引入的，應用在啟動時構建主機，主機作為一個對象用於封裝應用資源以及應用程序啟動和生存期管理。其主要功能包括配置初始化(包括加載配置以及配置轉換為通用的鍵值對格式)，創建托管環境和Host通用上下文、依賴注入等。

在.NET Core 3.0中采用了IHostBuilder用於創建Host，同時也不再建議使用Web主機，而建議使用泛型主機，主要原因是原有的通用主機僅適用於非HTTP負載，為了提供更加廣泛的主機方案，需要將HTTP管道與Web主機的接口分離出來。但Web主機仍會向后兼容。

.NET Core 3.0中創建通用主機

以下代碼是V3.0中提供的模板代碼，可以看到在創建主機的過程中，已經摒棄了WebHostBuilder的創建方式

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

而在.NET Core 2.X中

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

   public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
      WebHost.CreateDefaultBuilder(args)
         .UseStartup<Startup>();
}

V3.0模板中提供的CreateHostBuilder()方法看起來非常類似於V2.X中的CreateWebHostBuilder()。

其主要區別在於對WebHost.CreateDefaultBuilder()由Host.CreateDefaultBuilder()替換。使用CreateDefaultBuilder()輔助方法可以非常輕松地從v2.x切換到v3.0。

另一個區別是關於ConfigureWebHostDefaults()的調用。由於新的主機構建器是通用主機構建器，因此我們必須讓它知道我們打算為Web主機配置默認設置。這些默認配置我們可以在ConfigureWebHostDefaults()方法中實現

CreateDefaultBuilder

該方法Microsoft.Extensions.Hosting.Host中，它是一個靜態類，里面有兩個方法，一個有參的CreateDefaultBuilder(string[] args)，一個是無參的。

無參方法源碼如下，

public static IHostBuilder CreateDefaultBuilder() =>
            CreateDefaultBuilder(args: null);

可以看到該方法實際上是設置了默認值。

IHostBuilder CreateDefaultBuilder(string[] args)方法主要有以下功能：

創建HostBuilder對象

var builder = new HostBuilder();

指定Host要使用的內容根目錄

builder.UseContentRoot(Directory.GetCurrentDirectory());

配置初始化(環境變量、appsettings.json、User Secrets)

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) =>
{
    logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
    logging.AddConsole();
    logging.AddDebug();
    logging.AddEventSourceLogger();
})

在開發環境模式下啟用作用域驗證

.UseDefaultServiceProvider((context, options) =>
{
    var isDevelopment = context.HostingEnvironment.IsDevelopment();
    options.ValidateScopes = isDevelopment;
    options.ValidateOnBuild = isDevelopment;
});

Build

Build()方法是Microsoft.Extensions.Hosting中，並且該方法只會執行一次，當然這種一次只是在同一個實例里面

public IHost Build()
{
    if (_hostBuilt)
    {
        throw new InvalidOperationException("Build can only be called once.");
    }
    _hostBuilt = true;

    BuildHostConfiguration();
    CreateHostingEnvironment();
    CreateHostBuilderContext();
    BuildAppConfiguration();
    CreateServiceProvider();

    return _appServices.GetRequiredService<IHost>();
}

該方法主要是包括以下功能：

創建HostingEnvironment

創建HostBuilderContext

配置初始化及格式標准化

DI(創建IHostEnvironment、IHostApplicationLifetime、IHostLifetime、IHost)

Run

Run方法運行應用程序並阻止調用線程，直到主機關閉

public static void Run(this IHost host)
{
    host.RunAsync().GetAwaiter().GetResult();
}

以下是RunAsync的源碼，此處可以通過設置CancellationToken的值，使應用程序自動關閉

public static async Task RunAsync(this IHost host, CancellationToken token = default)
{
    try
    {
        await host.StartAsync(token);

        await host.WaitForShutdownAsync(token);
    }
    finally
    {
#if DISPOSE_ASYNC
        if (host is IAsyncDisposable asyncDisposable)
        {
            await asyncDisposable.DisposeAsync();
        }
        else
#endif
        {
            host.Dispose();
        }

    }
}