Zdarzenia#
Zdarzenie (ang. event) to mechanizm pozwalający klasie lub obiektowi (wydawcy) na powiadamianie innych klas lub obiektów (subskrybentów) o wystąpieniu określonej akcji. Jest to implementacja wzorca projektowego Obserwator, która umożliwia tworzenie luźno powiązanych komponentów.
W C# zdarzenie jest w praktyce zwykłym delegatem z dodatkową enkapsulacją. Słowo kluczowe event ogranicza dostęp do delegatu, pozwalając jedynie na dodawanie (+=) i usuwanie (-=) subskrybentów, co zapobiega niepożądanym modyfikacjom z zewnątrz.
Implementacja zdarzenia#
Typowy schemat implementacji zdarzenia obejmuje trzy elementy:
- Klasę
EventArgs: Obiekt przechowujący informacje o zdarzeniu. - Wydawcę (Publisher): Klasę, która deklaruje zdarzenie i je wywołuje.
- Subskrybentów (Subscribers): Klasy, które reagują na zdarzenie.
1. Definicja danych zdarzenia#
Dobrą praktyką jest stworzenie dedykowanej klasy dziedziczącej po System.EventArgs, za pomocą której możemy przekazywać dodatkowe informacje o zdarzeniu. Oprócz informacji o tym, że zdarzenie miało miejsce, możemy na przykład dowiedzieć się, jaka była stara cena, albo w którym miejscu nastąpiło kliknięcie i którym przyciskiem.
public class PriceChangedEventArgs : EventArgs
{
public decimal OldPrice { get; }
public decimal NewPrice { get; }
public PriceChangedEventArgs(decimal oldPrice, decimal newPrice)
{
OldPrice = oldPrice;
NewPrice = newPrice;
}
}2. Deklaracja i wywołanie w wydawcy#
Wydawca deklaruje zdarzenie przy użyciu słowa kluczowego event i jakiegoś delegatu, najczęściej korzysta się z systemowego delegatu EventHandler<T>. Wywołanie zdarzenia powinno odbywać się w dedykowanej, chronionej metodzie wirtualnej On..., co pozwala klasom dziedziczącym na modyfikację zachowania związanego z wywoływaniem zdarzenia.
public class Product
{
public event EventHandler<PriceChangedEventArgs>? PriceChanged;
public required string Name { get; init; }
private decimal _price;
public decimal Price
{
get => _price;
set
{
if (value == _price) return;
decimal oldPrice = _price;
_price = value;
OnPriceChanged(new PriceChangedEventArgs(oldPrice, value));
}
}
protected virtual void OnPriceChanged(PriceChangedEventArgs e)
{
PriceChanged?.Invoke(this, e);
}
}Definicja systemowego delegatu
EventHandler<TEventArgs>:public delegate void EventHandler<TEventArgs>(object? sender, TEventArgs e);
3. Subskrypcja w subskrybencie#
Subskrybent definiuje metodę zgodną z sygnaturą delegatu.
public class Notifier
{
// Event handler, with matching signature:
public void HandlePriceChanged(object? sender, PriceChangedEventArgs e)
{
if (sender is Product product)
{
Console.WriteLine($"Price of {product.Name} changed. {e.OldPrice:C} -> {e.NewPrice:C}");
}
}
}Następnie używa operatora += do rozpoczęcia nasłuchiwania:
var product = new Product { Name = "Laptop", Price = 1199.90m };
var notifier = new Notifier();
product.PriceChanged += notifier.HandlePriceChanged;
product.Price -= 200.0m;
// Unsubscribing, to avoid memory leaks:
product.PriceChanged -= notifier.HandlePriceChanged;Rola słowa kluczowego event#
Powyższy przykład zadziała identycznie, bez względu na to, czy użyjemy słowa kluczowego event.
Słowo kluczowe event ma zasadnicze znaczenie dla enkapsulacji. Gdybyśmy wystawili publicznie sam delegat:
public EventHandler<PriceChangedEventArgs> PriceChanged;…każdy zewnętrzny kod mógłby:
- Wywołać zdarzenie:
product.PriceChanged(null, null); - Wyzerować listę subskrybentów:
product.PriceChanged = null;
Słówko event ogranicza te możliwości, udostępniając z zewnątrz jedynie operacje += i -=. Gwarantuje to, że tylko klasa-właściciel może wywołać zdarzenie.
Akcesory zdarzeń#
Deklaracja zdarzenia w stylu pola (field-like event), taka jak PriceChanged powyżej, jest tłumaczona przez kompilator na prywatne pole delegatu oraz parę publicznych akcesorów add i remove, wywoływanych przez += i -= (wygenerowane akcesory są bezpieczne wątkowo). Podobnie jak w przypadku właściwości, możemy napisać te akcesory samodzielnie, np. aby przechowywać subskrybentów w innym miejscu albo logować subskrypcje. Takiego zdarzenia nie można jednak wywołać bezpośrednio – klasa-właściciel musi wywołać delegat, który się pod nim kryje. Ponadto, w przeciwieństwie do wygenerowanych akcesorów, poniższe nie są bezpieczne wątkowo.
public class Product
{
private EventHandler<PriceChangedEventArgs>? _priceChanged;
public event EventHandler<PriceChangedEventArgs>? PriceChanged
{
add
{
Console.WriteLine("New subscriber");
_priceChanged += value;
}
remove => _priceChanged -= value;
}
protected virtual void OnPriceChanged(PriceChangedEventArgs e)
{
_priceChanged?.Invoke(this, e);
}
}Zdarzenia częściowe (C# 14)#
Od C# 14 zdarzenia mogą być częściowe (partial), tak samo jak metody, właściwości (C# 13) i konstruktory (C# 14). Jedna część klasy częściowej zawiera deklarację definiującą w stylu pola, a druga – deklarację implementującą z akcesorami add i remove. Ta funkcjonalność jest przeznaczona głównie dla generatorów kodu źródłowego (source generators), które mogą dostarczyć implementację zdarzenia zadeklarowanego przez programistę.
public partial class Product
{
public partial event EventHandler<PriceChangedEventArgs>? PriceChanged;
}
// E.g., in a file generated by a source generator:
public partial class Product
{
private EventHandler<PriceChangedEventArgs>? _priceChanged;
public partial event EventHandler<PriceChangedEventArgs>? PriceChanged
{
add => _priceChanged += value;
remove => _priceChanged -= value;
}
}Programowanie sterowane zdarzeniami#
Programowanie sterowane zdarzeniami to paradygmat, w którym przepływ sterowania aplikacji jest determinowany przez asynchronicznie występujące zdarzenia. W odróżnieniu od programowania proceduralnego, gdzie program wykonuje się w liniowej, z góry zdefiniowanej sekwencji, w programowaniu sterowanym zdarzeniami główna logika aplikacji jest pasywna i oczekuje na zdarzenia, aby wykonać odpowiednie reakcje.
Programowanie sterowane zdarzeniami to podstawa działania wszystkich interfejsów użytkownika. Akcje, takie jak kliknięcie przycisku czy zmiana tekstu, generują zdarzenia, które modyfikują wewnętrzny stan aplikacji. Zmiana tego stanu może następnie wyzwolić kolejne zdarzenia, powodując automatyczną aktualizację interfejsu, aby odzwierciedlić nowy stan.
Przykład#
Poniższy diagram ilustruje przepływ zdarzeń w przykładowym systemie:
- Klasa
Productjest głównym wydawcą – informuje o zmianach swojej ceny oraz stanu magazynowego. NotifieriShoppingCartto subskrybenci zdarzeń zProduct.Notifierreaguje na zmiany w magazynie, aShoppingCartna zmiany cen, aby przeliczyć swoją wartość.ShoppingCartjest jednocześnie wydawcą dla klasyDisplay. Po każdej zmianie w koszyku informuje onDisplayo konieczności odświeżenia widoku.
Tworzy to łańcuch reakcji: zmiana w Product powoduje aktualizację ShoppingCart, która z kolei wyzwala aktualizację Display.
classDiagram
direction LR
class Product {
+PriceChanged
+StockChanged
+Name
+Price
}
class ShoppingCart {
+CartUpdated
+TotalPrice
+AddItem()
}
class Notifier {
+Subscribe(Product)
}
class Display {
+Subscribe(ShoppingCart)
}
Product ..> PriceChangedEventArgs : uses
Product ..> StockChangedEventArgs : uses
ShoppingCart ..> Product : Subscribes
Notifier ..> Product : Subscribes
Display ..> ShoppingCart : Subscribes