Zrozumieć C# Set Flag Enum: Przypisywanie flag
Zarządzanie konfiguracją jest kluczowym aspektem budowy skalowalnych i łatwych w utrzymaniu aplikacji w C#. Jednym z najskuteczniejszych sposobów obsługi ustawień konfiguracji jest użycie wzorca opcji. W swoim filmie, The Options Pattern in C# in 10 Minutes or Less, Tim Corey dostarcza zwięzłego ale wnikliwego wyjaśnienia tego wzorca i jak go efektywnie zaimplementować. W tym artykułe zbadamy wzorzec opcji poprzez wyjaśnienia i demonstracje Tima z jego filmu.
Wprowadzenie
Tim rozpoczyna, przedstawiając wzorzec opcji jako potężny lecz prosty sposób na uzyskanie informacji z plików konfiguracyjnych i wstrzyknięcie ich do zależności (DI). Podkreśla on kilka zalet tego wzorca, takich jak:
- Możliwość zarządzania zmianami wartości podczas działania.
- Wsparcie dla walidacji danych.
- Kompatybilność z różnymi typami projektów w C#, w tym aplikacjami Blazor.
Tim podkreśla, że mimo iż zazwyczaj dostarcza dogłębnego szkolenia technicznego, ten film jest zaprojektowany jako przewodnik szybkiego startu do implementacji wzorca opcji.
Konfiguracja projektu
Tim zaczyna od otwarcia Visual Studio z aplikacją Web Blazor (tylko renderowanie po stronie serwera). Dokonał już kilku modyfikacji, aby przyspieszyć demonstrację. Kluczowe ustawienie obejmuje:
- Tworzenie pliku
appsettings.jsonz sekcją CloudInfo zawierającą trzy pary klucz-wartość. - Użycie modelu Plain Old CLR Object (POCO) o nazwie
CloudInfoOptions, który odwzorowuje te wartości konfiguracji.
Plik konfiguracyjny
Plik appsettings.json zawiera następującą sekcję:
{
"CloudInfo": {
"Storage": "Azure Storage",
"Website": "Azure Static Web Apps",
"API": "Azure Web App"
}
}
Tim wyjaśnia, że chociaż używa appsettings.json, wartości konfiguracji mogą również pochodzić z:
appsettings.Development.jsonsecrets.json- Zmiennych środowiskowych
Wiązanie konfiguracji z opcjami
Teraz Tim wyjaśnia, jak powiązać wartości konfiguracji z klasą CloudInfoOptions i zaimplementować je w DI.
Rejestrowanie opcji w Program.cs
W Program.cs Tim dodaje następującą linię wewnątrz builder.Services:
builder.Services.Configure<CloudInfoOptions>(builder.Configuration.GetSection("CloudInfo"));
builder.Services.Configure<CloudInfoOptions>(builder.Configuration.GetSection("CloudInfo"));
To wiąże sekcję CloudInfo z appsettings.json z klasą CloudInfoOptions. Tim zauważa, że ten krok zapewnia dostępność wartości w wstrzykiwaniu zależności.
Wstrzykiwanie opcji w komponencie Razor
Tim przechodzi do komponentu strony głównej (Index.razor) i modyfikuje go, aby dynamicznie wyświetlał wartości konfiguracji.
Wprowadza interfejs IOptions do komponentu:
@inject IOptions<CloudInfoOptions> CloudInfoOptions
Aby uzyskać rzeczywiste wartości, przypisuje je wewnątrz OnInitialized:
protected override void OnInitialized()
{
CloudInfo = CloudInfoOptions.Value;
}
protected override void OnInitialized()
{
CloudInfo = CloudInfoOptions.Value;
}
Tim wyjaśnia, że IOptions<t> dostarcza instancję Singleton wartości konfiguracji, co oznacza, że pozostaje ona niezmienna przez cały okres życia aplikacji. Gdy aplikacja działa, wartości konfiguracji poprawnie pojawiają się na stronie.
Badanie różnych interfejsów opcji
Tim przedstawia trzy różne sposoby użycia wzorca opcji:
1. Opcje singleton
Domyślnie IOptions<t> dostarcza instancję Singleton. Tim pokazuje, że jeśli plik konfiguracyjny zostanie zaktualizowany, gdy aplikacja jest uruchomiona, zmiany nie są odzwierciedlone dopóki aplikacja nie zostanie zrestartowana.
2. Opcje zakresowe - Użycie IOptionsSnapshot<t>
Aby umożliwić aktualizacje na żądanie, Tim modyfikuje wstrzykiwanie do:
@inject IOptionsSnapshot<CloudInfoOptions> CloudInfoOptions
To zapewnia, że każde nowe żądanie HTTP otrzymuje nowe wartości konfiguracji. Tim testuje to, modyfikując appsettings.json, odświeżając stronę i pokazując, że zaktualizowane wartości pojawiają się teraz natychmiast.
Wyjaśnia, że IOptionsSnapshot<t> jest przydatne w scenariuszach, w których zmiany muszą być odzwierciedlone bez ponownego uruchamiania aplikacji, ale nie wymagają ciągłego monitorowania.
3. Monitorowanie zmian - Użycie IOptionsMonitor<t>
Na koniec Tim przedstawia IOptionsMonitor<t>, który umożliwia wykrywanie zmian w czasie rzeczywistym. Aktualizuje wstrzykiwanie do:
@inject IOptionsMonitor<CloudInfoOptions> CloudInfoOptions
W przeciwieństwie do IOptionsSnapshot, który aktualizuje się na żądanie, IOptionsMonitor<t> może uruchamiać zdarzenia, gdy wartości konfiguracji się zmienią. Jest to szczególnie przydatne, gdy trzeba reagować na zmiany konfiguracji dynamicznie.
Tim zauważa, że IOptionsMonitor<t> jest wspierany przez singleton, ale może dynamicznie odświeżać wartości, gdy zmienia się podstawowy plik konfiguracji.
Wnioski
Tim kończy film podsumowując kluczowe różnice między trzema podejściami:
| Interfejs | Czas trwania | Aktualizuje się przy zmianie |
|---|---|---|
IOptions<t> |
Singleton | Nie |
IOptionsSnapshot<t> |
Ograniczony | Na żądanie |
IOptionsMonitor<t> |
Singleton | Tak |
Podkreśla on, że chociaż wzorzec opcji upraszcza zarządzanie konfiguracją, zrozumienie tych różnych wariantów pomaga wybrać odpowiednie podejście w zależności od wymagań projektu.
Podążając za podejściem Tima, programiści mogą efektywnie zarządzać ustawieniami aplikacji, zapewniać płynne wstrzykiwanie zależności i skutecznie obsługiwać zmiany konfiguracji w czasie działania. Aby lepiej zrozumieć, obejrzyj cały film i odwiedź jego kanał po więcej wnikliwych filmów o C#.
