Remarques : Comment utiliser Microsoft.Extensions.Options

2024-07-12

Tout d’abord, le but :

Microsoft.Extensions.Options est une bibliothèque dans .NET Core pour gérer les options de configuration. Il fournit un moyen fortement typé de lire et de lier les données de configuration (telles que les données des fichiers appsettings.json, les variables d'environnement ou d'autres sources de configuration) et de les injecter dans l'application. Cette bibliothèque fait partie de .NET Core, mais peut également être utilisée dans le .NET Framework ou d'autres implémentations .NET.
Idée de base

• Modèle d'options : le modèle d'options utilise des classes pour représenter des regroupements de données de configuration. Ces classes sont généralement de simples POCO (Plain Old CLR Objects) contenant quelques propriétés qui correspondent à des clés pour les données de configuration.
• IOptions : IOptions<T> L'interface permet d'accéder aux données de configuration de type T. Après avoir enregistré les données de configuration de type T, vous pouvez accéder à ces données dans d'autres parties de l'application via l'injection de dépendances.
• IOptionsSnapshot : IOptionsSnapshot<T> Convient aux scénarios dans lesquels les données de configuration doivent être rechargées pendant l'exécution de l'application. Il fournit un nouvel instantané des données de configuration à chaque demande.
• IOptionsMonitor : IOptionsMonitor<T> Utilisé pour surveiller les modifications des données de configuration en temps réel. Il fournit un événement de notification de modification qui peut être déclenché lorsque les données de configuration changent.

2. Exemple :

Supposons que vous disposiez d'un fichier de configuration appsettings.json qui contient certains paramètres d'application :


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

Tout d’abord, définissez une classe pour représenter ces paramètres :


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

Ensuite, enregistrez cette classe de configuration dans la méthode ConfigureServices de Startup.cs :


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

Vous pouvez désormais accéder à ces paramètres via l'injection de dépendances partout où vous en avez besoin :


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 fournit un moyen simple mais puissant de gérer et d'accéder aux données de configuration d'une application. En utilisant des classes de configuration fortement typées et l'injection de dépendances, vous pouvez facilement intégrer des données de configuration dans votre application tout en gardant votre code clair et maintenable.

Partage de technologie