Notas: Como usar Microsoft.Extensions.Options

2024-07-12

Primeiro, o propósito:

Microsoft.Extensions.Options é uma biblioteca no .NET Core para lidar com opções de configuração. Ele fornece uma maneira fortemente digitada de ler e vincular dados de configuração (como dados de um arquivo appsettings.json, variáveis de ambiente ou outras fontes de configuração) e injetá-los no aplicativo. Esta biblioteca faz parte do .NET Core, mas também pode ser usada no .NET Framework ou em outras implementações do .NET.
Ideia central

• Padrão de opções: o padrão de opções utiliza classes para representar agrupamentos de dados de configuração. Essas classes geralmente são POCOs (Plain Old CLR Objects) simples contendo algumas propriedades que correspondem a chaves para dados de configuração.
• IOptions: IOptions<T> A interface é usada para acessar dados de configuração do tipo T. Após registrar dados de configuração do tipo T, você poderá acessar esses dados em outras partes da aplicação por meio de injeção de dependência.
• IOptionsSnapshot: IOptionsSnapshot<T> Adequado para cenários em que os dados de configuração precisam ser recarregados enquanto o aplicativo está em execução. Ele fornece um novo instantâneo dos dados de configuração em cada solicitação.
• IOptionsMonitor: IOptionsMonitor<T> Usado para monitorar alterações nos dados de configuração em tempo real. Ele fornece um evento de notificação de alteração que pode ser acionado quando os dados de configuração são alterados.

2. Exemplo:

Suponha que você tenha um arquivo de configuração appsettings.json que contém algumas configurações do aplicativo:


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

Primeiro, defina uma classe para representar estas configurações:


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

Em seguida, registre esta classe de configuração no método ConfigureServices de Startup.cs:


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

Agora você pode acessar essas configurações via injeção de dependência sempre que necessário:


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 fornece uma maneira simples, porém poderosa, de gerenciar e acessar os dados de configuração de um aplicativo. Usando classes de configuração fortemente tipadas e injeção de dependência, você pode integrar facilmente dados de configuração em seu aplicativo, mantendo seu código claro e fácil de manter.

Compartilhamento de tecnologia