文章詳情頁

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

瀏覽：69日期：2022-06-04 15:01:19

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

通過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不同的實現方式有：ConsoleLoggerProvider，DebugLoggerProvider，EventSourceLoggerProvider，EventLogLoggerProvider，TraceSourceLoggerProvider，自定義。下面是日志配置涉及的相關代碼：

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

到此這篇關于ASP.NET Core 5.0中的Host.CreateDefaultBuilder執行過程解析的文章就介紹到這了,更多相關ASP.NET Core 5.0 Host.CreateDefaultBuilder執行過程內容請搜索以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持！

ASP

上一條：選擇模式 - XSL教程 - 2下一條：源碼分析MinimalApi是如何在Swagger中展示

排行榜

					
					Java基礎之Object類詳解
利用CSS3新特性創建透明邊框三角
python GUI庫圖形界面開發之PyQt5滑塊條控件QSlider詳細使用方法與實例
基于python計算滾動方差(標準差)talib和pd.rolling函數差異詳解
python使用ctypes庫調用DLL動態鏈接庫
使用UML編寫Java應用程序 (1)
ASP.NET MVC實現橫向展示購物車
原生JS實現pc端輪播圖效果
PHP?redis?Sorted?Set實現字符串去重代碼示例
Python中使用aiohttp模擬服務器出現錯誤
python自動化調用百度api解決驗證碼
				