DI -在构造函数中自动初始化IOptions<T>

基础概念

IOptions<T> 是 .NET Core 中的一个接口，用于从配置源（如 appsettings.json 文件）中读取配置数据。IOptions<T> 接口的泛型参数 T 通常是一个配置类，该类定义了应用程序所需的配置属性。

类型

IOptions<T> 是一个接口，通常与 Options 模式一起使用。常见的实现包括：

IOptionsMonitor<T>：用于监视配置的变化。
IOptionsSnapshot<T>：用于在请求范围内提供配置快照。

应用场景

在 ASP.NET Core 应用程序中，IOptions<T> 常用于在构造函数中初始化配置对象。例如，假设我们有一个 AppSettings 配置类：

public class AppSettings
{
    public string ConnectionString { get; set; }
    public int MaxRetries { get; set; }
}

在 appsettings.json 文件中配置这些属性：

{
  "ConnectionStrings": {
    "DefaultConnection": "YourConnectionStringHere"
  },
  "AppSettings": {
    "ConnectionString": "YourConnectionStringHere",
    "MaxRetries": 3
  }
}

然后在应用程序中使用 IOptions<T> 初始化 AppSettings：

public class MyService
{
    private readonly AppSettings _appSettings;

    public MyService(IOptions<AppSettings> options)
    {
        _appSettings = options.Value;
    }

    public void DoSomething()
    {
        Console.WriteLine(_appSettings.ConnectionString);
        Console.WriteLine(_appSettings.MaxRetries);
    }
}

遇到的问题及解决方法

问题：在构造函数中无法自动初始化 `IOptions<T>`

原因：通常是因为没有正确配置 IOptions<T> 服务。

解决方法：

确保配置文件正确加载：确保 appsettings.json 文件位于正确的位置，并且内容格式正确。
注册 IOptions<T> 服务：在 Startup.cs 或 Program.cs 中注册 IOptions<T> 服务。

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.Configure<AppSettings>(Configuration.GetSection("AppSettings"));
        services.AddTransient<MyService>();
    }
}

或者在 .NET Core 5 及以上版本中：

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.ConfigureAppConfiguration((context, config) =>
                {
                    config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
                });
            })
            .ConfigureServices((hostContext, services) =>
            {
                services.Configure<AppSettings>(hostContext.Configuration.GetSection("AppSettings"));
                services.AddTransient<MyService>();
            });
}

确保依赖注入正确配置：确保 MyService 类通过构造函数注入 IOptions<T>。

public class MyService
{
    private readonly AppSettings _appSettings;

    public MyService(IOptions<AppSettings> options)
    {
        _appSettings = options.Value;
    }

    public void DoSomething()
    {
        Console.WriteLine(_appSettings.ConnectionString);
        Console.WriteLine(_appSettings.MaxRet.js);
    }
}