鳕鱼天空

This is Mr Wang's Tech Blog.

如何使用Microsoft.Extensions.Options

一、目的:

        Microsoft.Extensions.Options 是 .NET Core 中用于处理配置选项的一个库。它提供了一种强类型的方式来读取和绑定配置数据(例如来自 appsettings.json 文件、环境变量或其他配置源的数据),并将其注入到应用程序中。这个库是 .NET Core 的一部分,但也可以在 .NET Framework 或其他 .NET 实现中使用。

需要添加:Microsoft.Extensions.Options.ConfigurationExtensions 包


核心概念


•    选项模式:选项模式使用类来表示配置数据的分组。这些类通常是简单的 POCO(Plain Old CLR Objects),包含一些属性,这些属性对应于配置数据的键。
•    IOptions:IOptions<T> 接口用于访问 T 类型的配置数据。当你注册了 T 类型的配置数据后,可以通过依赖注入在应用程序的其他部分访问这些数据。
•    IOptionsSnapshot:IOptionsSnapshot<T> 适用于需要在应用程序运行时重新加载配置数据的场景。它在每个请求时提供配置数据的新快照。
•    IOptionsMonitor:IOptionsMonitor<T> 用于实时监控配置数据的变化。它提供了一个变更通知事件,可以在配置数据发生变化时触发。

二、示例:


假设你有一个 appsettings.json 配置文件,其中包含了一些应用程序设置:
 

{
  "MySettings": {
    "SettingA": "value1",
    "SettingB": "value2"
  }
}

首先,定义一个类来表示这些设置:

   

public class MySettings
{
  public string SettingA { get; set; }
  public string SettingB { get; set; }
}

然后,在 Startup.cs 的 ConfigureServices 方法中注册这个配置类:

   

public void ConfigureServices(IServiceCollection services)
{
  // 绑定配置
  services.Configure<MySettings>(Configuration.GetSection("MySettings"));
        
  // 其他服务注册...
}

现在,你可以在需要的地方通过依赖注入来访问这些设置:

 

   public class MyService
    {
        private readonly MySettings _mySettings;
     
        public MyService(IOptions<MySettings> options)
        {
            _mySettings = options.Value;
        }
     
        public void DoSomething()
        {
            Console.WriteLine(_mySettings.SettingA);
            // 使用 _mySettings...
        }
    }

 Microsoft.Extensions.Options 提供了一种简单而强大的方式来管理和访问应用程序的配置数据。通过使用强类型的配置类和依赖注入,你可以轻松地将配置数据集成到你的应用程序中,同时保持代码的清晰和可维护性。

Add comment

Loading