Catatan: Cara menggunakan Microsoft.Extensions.Options

2024-07-12

Pertama, tujuannya:

Microsoft.Extensions.Options adalah perpustakaan di .NET Core untuk menangani opsi konfigurasi. Ini menyediakan cara yang sangat diketik untuk membaca dan mengikat data konfigurasi (seperti data dari file appsettings.json, variabel lingkungan, atau sumber konfigurasi lainnya) dan memasukkannya ke dalam aplikasi. Pustaka ini adalah bagian dari .NET Core, tetapi juga dapat digunakan dalam .NET Framework atau implementasi .NET lainnya.
Ide inti

• Pola opsi: Pola opsi menggunakan kelas untuk mewakili pengelompokan data konfigurasi. Kelas-kelas ini biasanya berupa POCO sederhana (Plain Old CLR Objects) yang berisi beberapa properti yang sesuai dengan kunci untuk data konfigurasi.
• Opsi I: Opsi I<T> Antarmuka digunakan untuk mengakses data konfigurasi tipe T. Setelah Anda mendaftarkan data konfigurasi tipe T, Anda dapat mengakses data ini di bagian lain aplikasi melalui injeksi ketergantungan.
• IOptionsSnapshot: IOptionsSnapshot<T> Cocok untuk skenario ketika data konfigurasi perlu dimuat ulang saat aplikasi sedang berjalan. Ini memberikan snapshot baru dari data konfigurasi pada setiap permintaan.
• IOptionsMonitor: IOptionsMonitor<T> Digunakan untuk memantau perubahan data konfigurasi secara real time. Ini memberikan peristiwa pemberitahuan perubahan yang dapat dipicu ketika data konfigurasi berubah.

2. Contoh:

Misalkan Anda memiliki file konfigurasi appsettings.json yang berisi beberapa pengaturan aplikasi:


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

Pertama, tentukan kelas untuk mewakili pengaturan berikut:


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

Kemudian, daftarkan kelas konfigurasi ini dalam metode ConfigureServices di Startup.cs:


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

Sekarang Anda dapat mengakses pengaturan ini melalui injeksi ketergantungan di mana pun Anda membutuhkannya:


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 menyediakan cara sederhana namun ampuh untuk mengelola dan mengakses data konfigurasi aplikasi. Dengan menggunakan kelas konfigurasi yang sangat diketik dan injeksi ketergantungan, Anda dapat dengan mudah mengintegrasikan data konfigurasi ke dalam aplikasi Anda sambil menjaga kode Anda tetap jelas dan mudah dikelola.

Berbagi teknologi