Σημειώσεις: Πώς να χρησιμοποιήσετε το Microsoft.Extensions.Options

2024-07-12

Πρώτον, ο σκοπός:

Το Microsoft.Extensions.Options είναι μια βιβλιοθήκη στο .NET Core για το χειρισμό των επιλογών διαμόρφωσης. Παρέχει έναν έντονα πληκτρολογημένο τρόπο ανάγνωσης και δέσμευσης δεδομένων διαμόρφωσης (όπως δεδομένα από αρχεία appsettings.json, μεταβλητές περιβάλλοντος ή άλλες πηγές διαμόρφωσης) και την έγχυσή τους στην εφαρμογή. Αυτή η βιβλιοθήκη είναι μέρος του .NET Core, αλλά μπορεί επίσης να χρησιμοποιηθεί στο .NET Framework ή σε άλλες υλοποιήσεις .NET.
Βασική ιδέα

• Μοτίβο επιλογών: Το μοτίβο επιλογών χρησιμοποιεί κλάσεις για να αναπαραστήσει ομαδοποιήσεις δεδομένων διαμόρφωσης. Αυτές οι κλάσεις είναι συνήθως απλά POCO (απλά παλιά αντικείμενα CLR) που περιέχουν μερικές ιδιότητες που αντιστοιχούν σε κλειδιά για δεδομένα διαμόρφωσης.
• IOptions: IOptions<T> Η διεπαφή χρησιμοποιείται για πρόσβαση σε δεδομένα διαμόρφωσης τύπου T. Αφού καταχωρίσετε δεδομένα διαμόρφωσης τύπου T, μπορείτε να αποκτήσετε πρόσβαση σε αυτά τα δεδομένα σε άλλα μέρη της εφαρμογής μέσω της ένεσης εξάρτησης.
• IOptionsSnapshot: IOptionsSnapshot<T> Κατάλληλο για σενάρια όπου τα δεδομένα διαμόρφωσης πρέπει να επαναφορτωθούν ενώ εκτελείται η εφαρμογή. Παρέχει ένα νέο στιγμιότυπο των δεδομένων διαμόρφωσης για κάθε αίτημα.
• IOptionsMonitor: IOptionsMonitor<T> Χρησιμοποιείται για την παρακολούθηση αλλαγών στα δεδομένα διαμόρφωσης σε πραγματικό χρόνο. Παρέχει ένα συμβάν ειδοποίησης αλλαγής που μπορεί να ενεργοποιηθεί όταν αλλάζουν τα δεδομένα διαμόρφωσης.

2. Παράδειγμα:

Ας υποθέσουμε ότι έχετε ένα αρχείο διαμόρφωσης appsettings.json που περιέχει ορισμένες ρυθμίσεις εφαρμογής:


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

Αρχικά, ορίστε μια κλάση που θα αντιπροσωπεύει αυτές τις ρυθμίσεις:


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

Στη συνέχεια, καταχωρήστε αυτήν την κλάση διαμόρφωσης στη μέθοδο ConfigureServices του Startup.cs:


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

Τώρα μπορείτε να έχετε πρόσβαση σε αυτές τις ρυθμίσεις μέσω της ένεσης εξάρτησης όπου τις χρειάζεστε:


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 παρέχει έναν απλό αλλά ισχυρό τρόπο διαχείρισης και πρόσβασης στα δεδομένα διαμόρφωσης μιας εφαρμογής. Χρησιμοποιώντας αυστηρά πληκτρολογημένες κλάσεις διαμόρφωσης και ένεση εξάρτησης, μπορείτε εύκολα να ενσωματώσετε δεδομένα διαμόρφωσης στην εφαρμογή σας, διατηρώντας τον κώδικά σας καθαρό και διατηρήσιμο.

Κοινή χρήση τεχνολογίας