配置

ASP.NET Core 中的应用程序配置是使用一个或多个配置提供程序执行的。

可读取的类型

配置提供程序使用各种配置源从键值对读取配置数据：

• 设置文件，例如 appsettings.json,xml,ini,etc.等
• 环境变量
• Azure Key Vault
• Azure 应用配置
• 命令行参数
• 已安装或已创建的自定义提供程序
• 目录文件
• 内存中的 .NET 对象

在创建的 ASP.NET Core Web 应用会生成以下代码

var builder = WebApplication.CreateBuilder(args);

WebApplication.CreateBuilder(args) 方法默认创建的 WebApplication 实例会包含一个 IConfiguration 对象。在创建 WebApplication 实例时，会自动加载应用程序的配置文件并构建 IConfiguration 对象

读取的顺序优先级

按照以下顺序为应用提供默认配置（从最高优先级到最低优先级）：

1. 使用命令行配置提供程序通过命令行参数提供。
2. 使用非前缀环境变量配置提供程序通过非前缀环境变量提供。
3. 应用在 Development 环境中运行时的用户机密。
4. 使用 JSON 配置提供程序通过 appsettings.{Environment}.json 提供。 例如，appsettings.Production.json 和 Development。
5. 使用 JSON 配置提供程序通过 appsettings.json 提供。
6. 回退到下一部分所述的主机配置。

简单使用

在本地appsettings.Development.json 文件中更改

本地开发环境 例如，appsettings.Development..json ，优先于appsettings.json

{
  "Position": {
    "Title": "Editor",
    "Name": "Joe Smith"
  },
  "MyKey": "My appsettings.json Value",
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

在构造的时候接受一个 IConfiguration 对象作为参数，并将其赋值给 _configuration 变量，

然后就可以使用 _configuration["MyKey"]来获取配置MyKey的值。

多节点使用 _configuration["Position:Title"] 来获取配置Position:Title的值。

    [ApiController]
    [Route("[controller]/[action]")]
    public class WeatherForecastController : ControllerBase
    {  
        private readonly ILogger<WeatherForecastController> _logger;
        private readonly IConfiguration _configuration;
        public WeatherForecastController(ILogger<WeatherForecastController> logger, 
            IConfiguration configuration)
        {
            _logger = logger;
            _configuration = configuration;
        }
          
        [HttpGet("GetWeatherForecast")]
        public string GetSetting()
        { 
            var myKeyValue = _configuration["MyKey"];
            var title = _configuration["Position:Title"];
            var name = _configuration["Position:Name"];
            var defaultLogLevel = _configuration["Logging:LogLevel:Default"];
            return name;
        }
    }

封装的方法

完整读取静态配置的方法见下方代码

进行注册服务

// 添加静态文件读取(优先级比较高)
AppSettings.AddConfigSteup(builder.Configuration);

在需要读取静态文件的地方直接调用AppSettings.xx即可

public static class AppSettings
{
    private static IConfiguration? _configuration;

    public static IConfiguration Configuration
    {
        get
        {
            if (_configuration == null) throw new NullReferenceException(nameof(Configuration));
            return _configuration;
        }
    }


    /// <summary>
    /// 设置 Configuration 的实例
    /// </summary>
    /// <param name="configuration"></param>
    /// <exception cref="Exception"></exception>
    /// <exception cref="ArgumentNullException"></exception>
    public static void AddConfigSteup(IConfiguration? configuration)
    {
        if (_configuration != null)
        {
            throw new Exception($"{nameof(Configuration)}不可修改！");
        }
        _configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
    }
     
    #region 以下存放的全部都是静态配置
    /// <summary>
    /// 允许跨域请求列表
    /// </summary>
    public static string[] AllowCors => Configuration.GetSection("AllowCors").Get<string[]>();

    /// <summary>
    /// Jwt 配置
    /// </summary>
    public static class Jwt
    {
        public static string SecretKey => Configuration["Jwt:SecretKey"];
        public static string Issuer => Configuration["Jwt:Issuer"];
        public static string Audience => Configuration["Jwt:Audience"];
    }


    /// <summary>
    /// Redis 配置
    /// </summary>
    public static class Redis
    {
        public static bool Enabled => Configuration.GetValue<bool>("Redis:Enabled");
        public static string ConnectionString => Configuration["Redis:ConnectionString"]?? "ConnectionStringError";
        public static string Instance => Configuration["Redis:Instance"] ?? "Default";
    }
    #endregion


}

更多关于资料可查阅官方文档。