.Net 中使用配置的几种方式

准备

PM>Install-Package Microsoft.Extensions.DependencyInjection -Version 6.0.0
PM>Install-Package Microsoft.Extensions.Options -Version 6.0.0

Json 文件：

{
  "Name": "张三",
  "Age": 18,
  "Proxy": {
    "Address": "测试地址"
  }
}

配置文件映射的类：

public class Config
{
    public string Name { get; set; }
    public int Age { get; set; }
    public Proxy Proxy { get; set; }
}

public class Proxy
{
    public string Address { get; set; }
}

调用配置的类：

internal class ConfigTest
{
    private readonly IOptionsSnapshot<Config> _configOption;  // Snapshot 在每个范围内不实时更新，下个范围更新
    private readonly IOptionsSnapshot<Proxy> _proxyConfigOption;

    public ConfigTest(IOptionsSnapshot<Config> configOption, IOptionsSnapshot<Proxy> proxyConfigOption)
    {
        this._configOption = configOption;
        this._proxyConfigOption = proxyConfigOption;
    }

    public void Test()
    {
        Config config = _configOption.Value;
        Console.WriteLine(config.Name);
        Console.WriteLine(config.Age);
        Console.WriteLine(config.Proxy?.Address);
        Console.WriteLine("*************************");
        
        Proxy proxy = _proxyConfigOption.Value;
        Console.WriteLine(proxy?.Address);
        Console.WriteLine("*************************");
    }
}

还有其他配置如：IOptions<> 不会实时更新配置的值、IOptionsMonitor<> 会立即更新配置的值。
注册调用类：

ServiceCollection serviceContainer = new ServiceCollection();
serviceContainer.AddScoped<ConfigTest>();  // 把调用类注入服务容器

Json配置文件

PM>Install-Package Microsoft.Extensions.Options -Version 6.0.0

从配置文件构建配置：

ConfigurationBuilder configBuilder = new ConfigurationBuilder();
configBuilder.AddJsonFile(path: "appsettings.json", optional: true, reloadOnChange: true);  // reloadOnChange：配置发生改变时动态更新、optional：配置是否可选
IConfigurationRoot configRoot = configBuilder.Build();

serviceContainer.AddOptions()  // 把配置注入容器
    .Configure<Config>(d => configRoot.Bind(d))
    .Configure<Proxy>(d => configRoot.GetSection("proxy").Bind(d));

使用：

using (ServiceProvider serviceProvider = serviceContainer.BuildServiceProvider())
{
    ConfigTest configTest = serviceProvider.GetRequiredService<ConfigTest>();
    configTest.Test();
}

CommandLine

PM>Install-Package Microsoft.Extensions.Configuration.CommandLine -Version 6.0.0

ConfigurationBuilder configBuilder = new ConfigurationBuilder();
configBuilder.AddCommandLine(args);
IConfigurationRoot configRoot = configBuilder.Build();

serviceContainer.AddOptions()  // 把配置注入容器
    .Configure<Config>(d => configRoot.Bind(d))
    .Configure<Proxy>(d => configRoot.GetSection("proxy").Bind(d));

参数支持的格式：server=127.0.0.1、--server=127.0.0.1、--server 127.0.0.1、/server=127.0.0.1、/server 127.0.0.1。
使用方式同上。传参：

test.exe name=张三 age=18 proxy:address=测试地址

扁平化配置

对于环境变量、命令行等简单的键值对结构，如果要进行复杂结构的配置，需要进行“扁平化处理”。对于配置的名字需要采用“层级配置”。如：a:b:c=***，如果是数组元素则通过下标指定：a:b:c:0=***、a:b:c:1=***。

EnvironmentVariables

Install-Package Microsoft.Extensions.Configuration.EnvironmentVariables -Version 6.0.0

ConfigurationBuilder configBuilder = new ConfigurationBuilder();
configBuilder.AddEnvironmentVariables("prefix_");  // 可以为环境变量指定前缀，添加指定前缀即可（放在环境变量冲突）

同样适用扁平化配置。