.Net Core 配置文件读取 - IOptions、IOptionsMonitor、IOptionsSnapshot

合集 - .NET(21)

1..NET Core 环境搭建2022-03-162..Net Core IOC DI（依赖注入）2022-03-163..NET Core 读取配置技巧 - IOptions 接口2022-05-254..Net Core 依赖注入（IOC） 一些简单的使用技巧2022-05-065..Net Core 可为Null的类型2022-04-026..Net Core 配置文件 appsettings.json2022-03-257..NET 反向代理-YARP 部署Https（SSL）2022-09-218..NET 反向代理-YARP 根据域名转发2022-09-219..NET 7 来了！！！2022-09-1910..NET 反向代理-YARP2022-09-07

11..Net Core 配置文件读取 - IOptions、IOptionsMonitor、IOptionsSnapshot2022-09-02

12..NET Core 实现后台任务（定时任务）Longbow.Tasks 组件（三）2022-07-2313..NET Core 实现后台任务（定时任务）BackgroundService（二）2022-07-1314..NET Core 实现后台任务（定时任务）IHostedService（一）2022-07-0815..Net WebApi 中的 FromBody FromForm FromQuery FromHeader FromRoute2022-10-0716..NET 反向代理 YARP 代理 GRPC2022-09-2817..Net 7 C#11 原始字符串2022-09-2618..NET 反向代理 YARP 跨域请求 CORS2022-09-2619..NET 反向代理 YARP 自定义配置提供程序（Configuration Providers）2022-09-2520..NET 反向代理 YARP 通过编码方式配置域名转发2022-09-2421..NET 部署 多域名 Https（SSL）通过代码方式2022-09-23

收起

原文链接：https://www.cnblogs.com/ysmc/p/16637781.html

　　众所周知，appsetting.json 配置文件是.Net 的重大革新之心，抛开了以前繁杂的xml文件，使用了更简洁易懂的json方式，简直不要太舒服了！东西虽然好，但怎么在程序中读取这个配置呢，是每个新手必须要跨过去的坑（当然也是包括我这个菜狗子）。

　　遇事不明上注入，只要是遇到不知道怎么办的事，首先要往注入方便想，框架有了这个配置文件，必然配备了简单直接的读取API，按照我的习惯，直接上代码：

首先，我们在配置文件中，增加 Demo 配置节点：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "Demo": {
    "Value1": "1",
    "Value2": "2",
    "Value3": "3",
    "Value4": "4"
  }
}

在需要用到配置文件的地方，注入 IConfiguration 服务接口

private readonly IConfiguration _configuration;

public ValuesController(IConfiguration configuration)
{
    _configuration = configuration;
}

通常，我们比较直接的方式是通过 GetSection 获取对应的配置节点，然后再获取对应的配置项

var section = _configuration.GetSection("Demo");
var value1 = section.GetValue("Value1", "1");

如果 Demo 节点内还有更深的节点，GetSection 可以通过 : 深入到对应的下一个节点

appsetting.json 

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "Demo": {
    "Value1": "1",
    "Value2": "2",
    "Value3": "3",
    "Value4": "4",
    "Model" {
      "Name": "小二",
      "Phone": "12345678911"
    }
  }
}

var model = _configuration.GetSection("Demo:Model");

有些小伙伴可能就会问了，那我每个需要用到的地方都需要直接以字符串作为参数去读取配置，以后要是突然改了配置项，岂不是非常麻烦；

这点小伙伴们大可放心，你可以定义一个实体类，然后绑定上去，以后有什么更改了，直接重命名对应的属性就行了，实例代码

方法一：

var options = new DemoOptions();
_configuration.GetSection("Demo").Bind(options);

方法二：

var options2 = _configuration.GetSection("Demo").Get();

方法三：在 Startup.cs、.Net 6 以上在 Program.cs- 中使用依赖注入方式，以下是 .Net 6 

builder.Services.Configure(builder.Configuration.GetSection("Demo"));

在需要使用的地方注入  IOptions 即可获取到配置值，需要注意的是，IOptions 是单例（Singleton）服务，即在应用启动时进行注册，后续更改配置文件，该 IOptions 将不会同步更新，依然还是旧值 

private readonly DemoOptions _demoOptions;

public ValuesController(IOptions options)
{
    _demoOptions = options.Value;
}

如需要配置进行热更新，只需要改成注入 IOptionsMonitor 或者 IOptionsSnapshot；

IOptionsSnapshot的生命周期是作用域（Scoped），每次请求都会重新获取一次配置；

IOptionsMonitor 的生命周期是单例（Singleton），与 IOptions 不一样的是它会监听配置文件发生的更新，并且自动同步响应。