文章詳情頁

ASP.NET Core 5.0中的Host.CreateDefaultBuilder執(zhí)行過程解析

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

ASP.NET Core 5.0中的Host.CreateDefaultBuilder執(zhí)行過程

通過Rider調(diào)試的方式看了下ASP.NET Core 5.0的Web API默認(rèn)項(xiàng)目，重點(diǎn)關(guān)注Host.CreateDefaultBuilder(args)中的執(zhí)行過程，主要包括主機(jī)配置、應(yīng)用程序配置、日志配置和依賴注入配置這4個(gè)部分。由于水平和篇幅有限，先整體理解、建立框架，后面再逐步細(xì)化，對每個(gè)配置部分再詳細(xì)拆解

一.創(chuàng)建默認(rèn)主機(jī)Host.CreateDefaultBuilder

1.創(chuàng)建主機(jī)構(gòu)建器CreateHostBuilder(args)

基于ASP.NET Core 5.0構(gòu)建的Web API項(xiàng)目的Program.cs文件大家應(yīng)該都很熟悉：

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.創(chuàng)建默認(rèn)構(gòu)建器Host.CreateDefaultBuilder(args)

本文重點(diǎn)講解下Host.CreateDefaultBuilder(args)的執(zhí)行過程，Microsoft.Extensions.Hosting.Host是一個(gè)靜態(tài)類，包含2個(gè)方法：

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

上面的方法最終調(diào)用的還是下面的方法，下面的方法主要包括幾個(gè)部分：主機(jī)配置ConfigureHostConfiguration，應(yīng)用程序配置ConfigureAppConfiguration，日志配置ConfigureLogging，依賴注入配置UseDefaultServiceProvider。

二.主機(jī)配置ConfigureHostConfiguration

主機(jī)配置ConfigureHostConfiguration相關(guān)源碼如下：

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

1.內(nèi)存配置源

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

2.環(huán)境變量配置源

config.AddEnvironmentVariables(prefix: "DOTNET_")添加了前綴為DOTNET_的環(huán)境變量。

3.命令行配置源

最開始認(rèn)為參數(shù)args為null，經(jīng)過調(diào)試發(fā)現(xiàn)args的值string[0]，并且args != null，所以會有命令行配置源CommandLineConfigurationSource。

三.應(yīng)用程序配置ConfigureAppConfiguration

應(yīng)用程序配置ConfigureAppConfiguration相關(guān)源碼如下：

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.程序運(yùn)行的主機(jī)環(huán)境

hostingContext.HostingEnvironment表示運(yùn)行程序的主機(jī)環(huán)境，比如開發(fā)環(huán)境或者生產(chǎn)環(huán)境。IHostEnvironment接口的數(shù)據(jù)結(jié)構(gòu)為：

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，那么當(dāng)改變配置文件，應(yīng)用程序也會隨之更改而無需重啟。
在該項(xiàng)目中總共有2個(gè)配置文件，分別是appsettings.json和appsettings.Development.json。

3.添加用戶秘鑰配置源

config.AddUserSecrets(appAssembly, optional: true)主要是在開發(fā)的過程中，用來保護(hù)配置文件中的敏感數(shù)據(jù)的，比如密碼等。因?yàn)槠綍r(shí)在開發(fā)中很少使用，所以在此不做深入討論，如果感興趣可參考[3]。

四.日志配置ConfigureLogging

日志配置ConfigureLogging相關(guān)源碼如下：

.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不同的實(shí)現(xiàn)方式有：ConsoleLoggerProvider，DebugLoggerProvider，EventSourceLoggerProvider，EventLogLoggerProvider，TraceSourceLoggerProvider，自定義。下面是日志配置涉及的相關(guān)代碼：

logging.AddConsole(); //將日志輸出到控制臺
logging.AddDebug(); //將日志輸出到調(diào)試窗口
logging.AddEventSourceLogger();
logging.AddEventLog();

說明：這一部分詳細(xì)的日志分析可以參考[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相關(guān)源碼如下：

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

UseDefaultServiceProvider主要是設(shè)置默認(rèn)的依賴注入容器。

參考文獻(xiàn)：
[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]認(rèn)識ASP.NET Core/Host及其配置解析：https://zhuanlan.zhihu.com/p/343312339
[4]源碼解析.Net中Host主機(jī)的構(gòu)建過程：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啟動和運(yùn)行機(jī)制：https://www.jianshu.com/p/59cfaba4e2cb
[10]ASP.Net Core解讀通用主機(jī)和托管服務(wù)：https://www.cnblogs.com/qtiger/p/12976207.html

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

ASP

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

排行榜

					
					SpringBoot整合log4j日志與HashMap的底層原理解析
java實(shí)現(xiàn)簡單猜數(shù)字
JAVA中String介紹及常見面試題小結(jié)
python GUI庫圖形界面開發(fā)之PyQt5滑塊條控件QSlider詳細(xì)使用方法與實(shí)例
python使用ctypes庫調(diào)用DLL動態(tài)鏈接庫
ASP.NET MVC實(shí)現(xiàn)橫向展示購物車
thinkphp如何傳遞GET參數(shù)方法詳解
Vue3中Cesium地圖初始化及地圖控件配置方法
python 在服務(wù)器上調(diào)用數(shù)據(jù)庫特別慢的解決過程
Python和Selenium-未知錯(cuò)誤：在點(diǎn)（663，469）元素不可單擊其他元素將獲得點(diǎn)擊：
詳解python數(shù)據(jù)結(jié)構(gòu)和算法
				