Huomautuksia: Kuinka käyttää Microsoft.Extensions.Options

2024-07-12

Ensinnäkin tarkoitus:

Microsoft.Extensions.Options on .NET Coren kirjasto määritysasetusten käsittelyä varten. Se tarjoaa vahvasti kirjoitetun tavan lukea ja sitoa määritystietoja (kuten tietoja appsettings.json-tiedostoista, ympäristömuuttujista tai muista määrityslähteistä) ja lisätä ne sovellukseen. Tämä kirjasto on osa .NET Corea, mutta sitä voidaan käyttää myös .NET Frameworkissa tai muissa .NET-toteutuksissa.
Ydin idea

• Asetusmalli: Asetusmalli käyttää luokkia edustamaan kokoonpanotietojen ryhmiä. Nämä luokat ovat yleensä yksinkertaisia POCO:ita (Plain Old CLR Objects), jotka sisältävät muutamia ominaisuuksia, jotka vastaavat konfigurointitietojen avaimia.
• IOptions: IOptions<T> Käyttöliittymää käytetään T-tyypin konfigurointitietoihin pääsyyn. Kun olet rekisteröinyt tyypin T konfigurointitiedot, voit käyttää näitä tietoja sovelluksen muissa osissa riippuvuuslisäyksen avulla.
• IOptionsSnapshot: IOptionsSnapshot<T> Sopii skenaarioihin, joissa määritystiedot on ladattava uudelleen sovelluksen ollessa käynnissä. Se tarjoaa uuden tilannekuvan konfigurointitiedoista jokaisesta pyynnöstä.
• IOptionsMonitor: IOptionsMonitor<T> Käytetään konfigurointitietojen muutosten seuraamiseen reaaliajassa. Se tarjoaa muutosilmoitustapahtuman, joka voidaan laukaista, kun kokoonpanotiedot muuttuvat.

2. Esimerkki:

Oletetaan, että sinulla on appsettings.json-määritystiedosto, joka sisältää joitain sovellusasetuksia:


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

Määritä ensin luokka edustamaan näitä asetuksia:


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

Rekisteröi sitten tämä kokoonpanoluokka Startup.cs:n ConfigureServices-metodissa:


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

Nyt voit käyttää näitä asetuksia riippuvuuslisäyksen avulla missä tahansa tarvitset niitä:


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 tarjoaa yksinkertaisen mutta tehokkaan tavan hallita ja käyttää sovelluksen määritystietoja. Käyttämällä vahvasti kirjoitettuja konfigurointiluokkia ja riippuvuuden lisäystä, voit helposti integroida määritystiedot sovellukseesi pitäen samalla koodisi selkeänä ja ylläpidettävänä.

Teknologian jakaminen