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

2022-09-02 00:30:47 阅读：207 来源： 互联网

标签：Core GetSection 配置文件 Demo IOptionsMonitor var configuration IOptions

原文链接：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<DemoOptions>();

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

builder.Services.Configure<DemoOptions>(builder.Configuration.GetSection("Demo"));

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

private readonly DemoOptions _demoOptions;

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

如需要配置进行热更新，只需要改成注入 IOptionsMonitor<TOptions> 或者 IOptionsSnapshot<TOptions>；IOptionsSnapshot<TOptions>的生命周期是作用域（Scoped），每次请求都会重新获取一次配置；IOptionsSnapshot<TOptions> 的生命周期是单例（Singleton），与 IOptions<TOptions> 不一样的是当配置文件发生改变时，将会自动同步响应。

标签：Core,GetSection,配置文件,Demo,IOptionsMonitor,var,configuration,IOptions
来源： https://www.cnblogs.com/ysmc/p/16637781.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

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