Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

System.EventHandler<TEventArgs> i System.EventArgs

Dobierz delegat do zdarzenia z danymi lub bez danych i zobacz, jak bezpiecznie odłączyć procedurę obsługi.

Wersja: C# 12 and .NET 8; later runtimes may add compatible features

Składnia

// .NET 8 delegate signatures in namespace System (already provided by .NET):
public delegate void EventHandler<TEventArgs>(object? sender, TEventArgs e);
public delegate void EventHandler(object? sender, EventArgs e);

// In a publisher class, with using System; and a custom MessageEventArgs : EventArgs:
public event EventHandler<MessageEventArgs>? MessagePublished;
public event EventHandler? Flushed;

// Inside an instance method of that publisher:
MessagePublished?.Invoke(this, new MessageEventArgs("Build complete"));
Flushed?.Invoke(this, EventArgs.Empty);

System.EventHandler<TEventArgs> to typ delegata używany do deklarowania zdarzeń z danymi. Procedura obsługi zwraca void i otrzymuje object? sender, czyli zwykle obiekt zgłaszający zdarzenie (może to być null), oraz TEventArgs e. System.EventArgs to klasa bazowa danych zdarzenia, a nie delegat. W C# 12 na .NET 8 delegat nie wymaga dziedziczenia TEventArgs po EventArgs, ale jest to standardowa konwencja .NET dla własnych klas argumentów.

W agregatorze powiadomień zadeklaruj MessagePublished jako EventHandler<MessageEventArgs>. Klasa MessageEventArgs : EventArgs udostępnia właściwość Message tylko do odczytu, więc procedura obsługi może odczytać e.Message bez rzutowania. Dla Flushed użyj odrębnego, niegenerycznego typu System.EventHandler: drugi parametr nadal ma typ EventArgs, a publikujący przekazuje EventArgs.Empty, współdzieloną instancję bez dodatkowych danych, zamiast null.

Kod zewnętrzny subskrybuje zdarzenie operatorem += i usuwa subskrypcję operatorem -=, ale nie może wywołać go bezpośrednio. Klasa deklarująca zdarzenie wywołuje je przez ?.Invoke(this, e), które pomija wywołanie, gdy nie ma subskrybentów. Zwykłe wywołanie delegata jest synchroniczne. Jeśli procedura obsługi zgłosi nieprzechwycony wyjątek, wyjątek trafia do wywołującego, a dalsze procedury z listy nie zostaną wywołane.

Użyj tej samej metody zarówno przy subskrypcji, jak i przy jej usuwaniu; w przypadku lambdy zachowaj delegat użyty do subskrypcji. Usuń subskrypcję, gdy nie jest już potrzebna, szczególnie jeśli publikujący żyje dłużej: jego delegat może podtrzymywać przy życiu obiekt subskrybenta.

Przykłady

#nullable enable
using System;

var hub = new NotificationHub();
hub.MessagePublished += OnMessagePublished;
hub.Flushed += OnFlushed;

hub.Publish("Build complete");
hub.Flush();

hub.MessagePublished -= OnMessagePublished;
hub.Flushed -= OnFlushed;

hub.Publish("Not printed");
hub.Flush();

static void OnMessagePublished(object? sender, MessageEventArgs e)
    => Console.WriteLine(e.Message);

static void OnFlushed(object? sender, EventArgs e)
    => Console.WriteLine("Flushed");

sealed class MessageEventArgs : EventArgs
{
    public MessageEventArgs(string message) => Message = message;

    public string Message { get; }
}

sealed class NotificationHub
{
    public event EventHandler<MessageEventArgs>? MessagePublished;
    public event EventHandler? Flushed;

    public void Publish(string message)
        => MessagePublished?.Invoke(this, new MessageEventArgs(message));

    public void Flush()
        => Flushed?.Invoke(this, EventArgs.Empty);
}

Wynik

Build complete
Flushed

`NotificationHub` udostępnia dwa niezależne zdarzenia. Pierwsze wywołania `Publish` i `Flush` wypisują odpowiednio `Build complete` i `Flushed`. Po odłączeniu obu procedur kolejne wywołania niczego nie wypisują.

Powiązane lekcje

  • C# · Lekcja 23 · Średniozaawansowany · Wersja: 2
  • C# · Lekcja 24 · Średniozaawansowany · Wersja: 2
  • C# · Lekcja 25 · Średniozaawansowany · Wersja: 2

Źródła