ASP.NET Core 5.0中的Host.CreateDefaultBuilder執行過程

語言: CN / TW / HK

通過Rider除錯的方式看了下ASP.NET Core 5.0的Web API預設專案,重點關注Host.CreateDefaultBuilder(args)中的執行過程,主要包括主機配置、應用程式配置、日誌配置和依賴注入配置這4個部分。由於水平和篇幅有限,先整體理解、建立框架,後面再逐步細化,對每個配置部分再詳細拆解。

一.建立預設主機Host.CreateDefaultBuilder

1.建立主機構建器CreateHostBuilder(args)

基於ASP.NET Core 5.0構建的Web API專案的Program.cs檔案大家應該都很熟悉:

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

2.建立預設構建器Host.CreateDefaultBuilder(args)

本文重點講解下Host.CreateDefaultBuilder(args)的執行過程,Microsoft.Extensions.Hosting.Host是一個靜態類,包含2個方法:

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

上面的方法最終呼叫的還是下面的方法,下面的方法主要包括幾個部分:主機配置ConfigureHostConfiguration,應用程式配置ConfigureAppConfiguration,日誌配置ConfigureLogging,依賴注入配置UseDefaultServiceProvider。

二.主機配置ConfigureHostConfiguration

主機配置ConfigureHostConfiguration相關原始碼如下:

builder.UseContentRoot(Directory.GetCurrentDirectory());
builder.ConfigureHostConfiguration(config =>
{
    config.AddEnvironmentVariables(prefix: "DOTNET_");
    if (args != null)
    {
        config.AddCommandLine(args);
    }
});

1.記憶體配置源

Directory.GetCurrentDirectory() 當前目錄指的就是 D:\SoftwareProject\C#Program\WebApplication3\WebApplication3

2.環境變數配置源

config.AddEnvironmentVariables(prefix: "DOTNET_") 添加了字首為 DOTNET_ 的環境變數。

3.命令列配置源

最開始認為引數args為null,經過除錯發現args的值string[0],並且 args != null ,所以會有命令列配置源CommandLineConfigurationSource。

三.應用程式配置ConfigureAppConfiguration

應用程式配置ConfigureAppConfiguration相關原始碼如下:

builder.ConfigureAppConfiguration((hostingContext, config) =>
{
    IHostEnvironment env = hostingContext.HostingEnvironment;
    bool reloadOnChange = hostingContext.Configuration.GetValue("hostBuilder:reloadConfigOnChange", defaultValue: true);

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

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

1.程式執行的主機環境

hostingContext.HostingEnvironment表示執行程式的主機環境,比如開發環境或者生產環境。IHostEnvironment介面的資料結構為:

public interface IHostEnvironment
{
    // Development
    string EnvironmentName { get; set; }
    // WebApplication3
    string ApplicationName { get; set; }
    // D:\SoftwareProject\C#Program\WebApplication3\WebApplication3
    string ContentRootPath { get; set; }
    // PhysicalFileProvider
    IFileProvider ContentRootFileProvider { get; set; }
}

2.載入json配置檔案

接下來就是通過AddJsonFile()來新增配置檔案了,如下所示:

(1)Path(string):json檔案的相對路徑位置。

(2)Optional(bool):指定檔案是否是必須的,如果為false,那麼如果找不到檔案就會丟擲檔案找不到異常。

(3)ReloadOnchange(bool):如果為true,那麼當改變配置檔案,應用程式也會隨之更改而無需重啟。

在該專案中總共有2個配置檔案,分別是appsettings.json和appsettings.Development.json。

3.新增使用者祕鑰配置源

config.AddUserSecrets(appAssembly, optional: true) 主要是在開發的過程中,用來保護配置檔案中的敏感資料的,比如密碼等。因為平時在開發中很少使用,所以在此不做深入討論,如果感興趣可參考[3]。

四.日誌配置ConfigureLogging

日誌配置ConfigureLogging相關原始碼如下:

.ConfigureLogging((hostingContext, logging) =>
{
    bool isWindows = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
    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();
    }

    logging.Configure(options =>
    {
        options.ActivityTrackingOptions = ActivityTrackingOptions.SpanId
                                            | ActivityTrackingOptions.TraceId
                                            | ActivityTrackingOptions.ParentId;
    });
})

1.Windows日誌級別

從上述程式碼中可以看到是 LogLevel.Warning 及以上。

2.日誌的配置

ILoggerProvider不同的實現方式有: ConsoleLoggerProviderDebugLoggerProviderEventSourceLoggerProviderEventLogLoggerProviderTraceSourceLoggerProvider自定義 。下面是日誌配置涉及的相關程式碼:

logging.AddConsole(); //將日誌輸出到控制檯
logging.AddDebug(); //將日誌輸出到除錯視窗
logging.AddEventSourceLogger();
logging.AddEventLog();

說明:這一部分詳細的日誌分析可以參考[6]。

3.ActivityTrackingOptions

public enum ActivityTrackingOptions
{
  None = 0, //No traces will be included in the log
  SpanId = 1, //The record will contain the Span identifier
  TraceId = 2, //The record will contain the tracking identifier
  ParentId = 4, //The record will contain the parent identifier
  TraceState = 8, //The record will contain the tracking status
  TraceFlags = 16, //The log will contain trace flags
}

在最新的.NET 7 Preview6中又增加了Tags(32)和Baggage(64)。

五.依賴注入配置UseDefaultServiceProvider

依賴注入配置UseDefaultServiceProvider相關原始碼如下:

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

UseDefaultServiceProvider主要是設定預設的依賴注入容器。

參考文獻:

[1].NET Source Browser: https://source.dot.net/

[2]Safe storage of app secrets in development in ASP.NET Core: https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-6.0&tabs=windows

[3]認識ASP.NET Core/Host及其配置解析: https://zhuanlan.zhihu.com/p/343312339

[4]原始碼解析.Net中Host主機的構建過程: https://www.cnblogs.com/snailZz/p/15240616.html

[5].NET Core通用Host原始碼分析: https://www.cnblogs.com/yingbiaowang/p/15048495.html

[6]基於.NetCore3.1系列--日誌記錄之日誌配置揭祕: https://www.cnblogs.com/i3yuan/p/13411793.html

[7]基於.NetCore3.1系列--日誌記錄之日誌核心要素揭祕: https://www.cnblogs.com/i3yuan/p/13442509.html

[8].NET5中Host.CreateDefaultBuilder(args)詳解: https://blog.csdn.net/qbc12345678/article/details/122983855

[9]ASP.NET啟動和執行機制: https://www.jianshu.com/p/59cfaba4e2cb

[10]ASP.Net Core解讀通用主機和託管服務: https://www.cnblogs.com/qtiger/p/12976207.html