乐趣区

关于程序员:ASPNET-Core-50中的HostCreateDefaultBuilder执行过程

jiezi

  通过 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…
[3]意识 ASP.NET Core/Host 及其配置解析：https://zhuanlan.zhihu.com/p/…
[4]源码解析.Net 中 Host 主机的构建过程：https://www.cnblogs.com/snail…
[5].NET Core 通用 Host 源码剖析：https://www.cnblogs.com/yingb…
[6]基于.NetCore3.1 系列 – 日志记录之日志配置揭秘：https://www.cnblogs.com/i3yua…
[7]基于.NetCore3.1 系列 – 日志记录之日志外围因素揭秘：https://www.cnblogs.com/i3yua…
[8].NET5 中 Host.CreateDefaultBuilder(args)详解：https://blog.csdn.net/qbc1234…
[9]ASP.NET 启动和运行机制：https://www.jianshu.com/p/59c…
[10]ASP.Net Core 解读通用主机和托管服务：https://www.cnblogs.com/qtige…

本文由 mdnice 多平台公布

退出移动版