Notas: Cómo utilizar Microsoft.Extensions.Options

2024-07-12

Primero, el propósito:

Microsoft.Extensions.Options es una biblioteca en .NET Core para manejar opciones de configuración. Proporciona una forma fuertemente tipada de leer y vincular datos de configuración (como datos de archivos appsettings.json, variables de entorno u otras fuentes de configuración) e inyectarlos en la aplicación. Esta biblioteca es parte de .NET Core, pero también se puede usar en .NET Framework u otras implementaciones de .NET.
Idea principal

• Patrón de opciones: el patrón de opciones utiliza clases para representar agrupaciones de datos de configuración. Estas clases suelen ser POCO (objetos CLR antiguos y simples) simples que contienen algunas propiedades que corresponden a claves para los datos de configuración.
• Opciones I: Opciones I<T> La interfaz se utiliza para acceder a datos de configuración de tipo T. Después de registrar datos de configuración de tipo T, puede acceder a estos datos en otras partes de la aplicación mediante la inyección de dependencia.
• Instantánea de IOptions: Instantánea de IOptions<T> Adecuado para escenarios en los que es necesario recargar los datos de configuración mientras se ejecuta la aplicación. Proporciona una nueva instantánea de los datos de configuración en cada solicitud.
• IOptionsMonitor: IOptionsMonitor<T> Se utiliza para monitorear cambios en los datos de configuración en tiempo real. Proporciona un evento de notificación de cambio que se puede activar cuando cambian los datos de configuración.

2. Ejemplo:

Suponga que tiene un archivo de configuración appsettings.json que contiene algunas configuraciones de la aplicación:


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

Primero, defina una clase para representar estas configuraciones:


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

Luego, registre esta clase de configuración en el método ConfigureServices de Startup.cs:


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

Ahora puedes acceder a estas configuraciones mediante la inyección de dependencias donde las necesites:


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 proporciona una forma sencilla pero potente de administrar y acceder a los datos de configuración de una aplicación. Al utilizar clases de configuración fuertemente tipadas e inyección de dependencia, puede integrar fácilmente datos de configuración en su aplicación mientras mantiene su código claro y fácil de mantener.

Compartir tecnología