Udostępnij za pomocą

Używanie wariancji w delegatach (C#)

Podczas przypisywania metody do delegata kowariancja i kontrawariancja zapewniają elastyczność dopasowania typu delegata z podpisem metody. Kowariancja zezwala metodzie na zwracanie typu, który jest bardziej wyspecjalizowany niż zdefiniowany w delegacie. Kontrawariancja umożliwia zastosowanie metody, której typy parametrów są mniej złożone niż te w typie delegata.

Przykład 1: Kowariancja

Opis

W tym przykładzie pokazano, jak delegaty mogą być używane z metodami, które mają typy zwracane będące pochodnymi typu zwracanego określonego w podpisie delegata. Typ danych zwracany przez DogsHandler to Dogs, który pochodzi od typu Mammals, zdefiniowanego w delegacie.

Code

class Mammals {}  
class Dogs : Mammals {}  
  
class Program  
{  
    // Define the delegate.  
    public delegate Mammals HandlerMethod();  
  
    public static Mammals MammalsHandler()  
    {  
        return null;  
    }  
  
    public static Dogs DogsHandler()  
    {  
        return null;  
    }  
  
    static void Test()  
    {  
        HandlerMethod handlerMammals = MammalsHandler;  
  
        // Covariance enables this assignment.  
        HandlerMethod handlerDogs = DogsHandler;  
    }  
}

Przykład 2. Kontrawariancja

Opis

W tym przykładzie pokazano, jak delegaty mogą być używane z metodami, które mają parametry, których typy są podstawowymi typami parametrów sygnatury delegata. W przypadku kontrawariancji można użyć jednej procedury obsługi zdarzeń zamiast oddzielnych procedur obsługi. W poniższym przykładzie użyto dwóch delegatów:

  • Delegat niestandardowy KeyEventHandler , który definiuje podpis zdarzenia klucza. Jego podpis to:

    public delegate void KeyEventHandler(object sender, KeyEventArgs e)

  • Niestandardowy delegat MouseEventHandler, który definiuje podpis zdarzenia myszy. Jego podpis to:

    public delegate void MouseEventHandler(object sender, MouseEventArgs e)

W przykładzie zdefiniowano program obsługi zdarzeń z parametrem EventArgs i używa go do obsługi zdarzeń zarówno klawiszy, jak i myszy. Działa to, ponieważ EventArgs jest podstawowym typem zarówno klas niestandardowych KeyEventArgs , jak i MouseEventArgs zdefiniowanych w przykładzie. Kontrawariancja pozwala używać metod, które akceptują parametry typu podstawowego, do obsługi zdarzeń z parametrami typu pochodnego.

Jak działa kontrawariancja w tym przykładzie

Gdy subskrybujesz zdarzenie, kompilator sprawdza, czy metoda obsługi zdarzeń jest zgodna z podpisem delegata zdarzenia. Z kontrawariancją:

  1. Zdarzenie KeyDown oczekuje metody, która przyjmuje KeyEventArgs.
  2. Zdarzenie MouseClick oczekuje metody, która przyjmuje MouseEventArgs.
  3. Metoda MultiHandler przyjmuje typ EventArgspodstawowy .
  4. Ponieważ zarówno KeyEventArgs jak i MouseEventArgs dziedziczą z klasy EventArgs, można je bezpiecznie przekazać do metody oczekującej na EventArgs.
  5. Kompilator dopuszcza to przypisanie, ponieważ jest ono bezpieczne — MultiHandler może współpracować z dowolnym EventArgs wystąpieniem.

Jest to kontrawariancja w działaniu: można użyć metody z parametrem "mniej specyficznym" (typu podstawowego), gdzie oczekiwany jest parametr "bardziej szczegółowy" (typu pochodnego).

Code

// Custom EventArgs classes to demonstrate the hierarchy
public class KeyEventArgs(string keyCode) : EventArgs
{
    public string KeyCode { get; set; } = keyCode;
}

public class MouseEventArgs(int x, int y) : EventArgs  
{
    public int X { get; set; } = x;
    public int Y { get; set; } = y;
}

// Define delegate types that match the Windows Forms pattern
public delegate void KeyEventHandler(object sender, KeyEventArgs e);
public delegate void MouseEventHandler(object sender, MouseEventArgs e);

// A simple class that demonstrates contravariance with events
public class Button
{
    // Events that expect specific EventArgs-derived types
    public event KeyEventHandler? KeyDown;
    public event MouseEventHandler? MouseClick;

    // Method to simulate key press
    public void SimulateKeyPress(string key)
    {
        Console.WriteLine($"Simulating key press: {key}");
        KeyDown?.Invoke(this, new KeyEventArgs(key));
    }

    // Method to simulate mouse click  
    public void SimulateMouseClick(int x, int y)
    {
        Console.WriteLine($"Simulating mouse click at ({x}, {y})");
        MouseClick?.Invoke(this, new MouseEventArgs(x, y));
    }
}

public class Form1
{
    private Button button1;

    public Form1()
    {
        button1 = new Button();
        
        // Event handler that accepts a parameter of the base EventArgs type.
        // This method can handle events that expect more specific EventArgs-derived types
        // due to contravariance in delegate parameters.
        
        // You can use a method that has an EventArgs parameter,
        // although the KeyDown event expects the KeyEventArgs parameter.
        button1.KeyDown += MultiHandler;

        // You can use the same method for an event that expects 
        // the MouseEventArgs parameter.
        button1.MouseClick += MultiHandler;
    }

    // Event handler that accepts a parameter of the base EventArgs type.
    // This works for both KeyDown and MouseClick events because:
    // - KeyDown expects KeyEventHandler(object sender, KeyEventArgs e)
    // - MouseClick expects MouseEventHandler(object sender, MouseEventArgs e)  
    // - Both KeyEventArgs and MouseEventArgs derive from EventArgs
    // - Contravariance allows a method with a base type parameter (EventArgs)
    //   to be used where a derived type parameter is expected
    private void MultiHandler(object sender, EventArgs e)
    {
        Console.WriteLine($"MultiHandler called at: {DateTime.Now:HH:mm:ss.fff}");
        
        // You can check the actual type of the event args if needed
        switch (e)
        {
            case KeyEventArgs keyArgs:
                Console.WriteLine($"  - Key event: {keyArgs.KeyCode}");
                break;
            case MouseEventArgs mouseArgs:
                Console.WriteLine($"  - Mouse event: ({mouseArgs.X}, {mouseArgs.Y})");
                break;
            default:
                Console.WriteLine($"  - Generic event: {e.GetType().Name}");
                break;
        }
    }

    public void DemonstrateEvents()
    {
        Console.WriteLine("Demonstrating contravariance in event handlers:");
        Console.WriteLine("Same MultiHandler method handles both events!\n");
        
        button1.SimulateKeyPress("Enter");
        button1.SimulateMouseClick(100, 200);
        button1.SimulateKeyPress("Escape");
        button1.SimulateMouseClick(50, 75);
    }
}

Kluczowe kwestie dotyczące kontrawariancji

// Demonstration of how contravariance works with delegates:
// 
// 1. KeyDown event signature: KeyEventHandler(object sender, KeyEventArgs e)
//    where KeyEventArgs derives from EventArgs
//
// 2. MouseClick event signature: MouseEventHandler(object sender, MouseEventArgs e)  
//    where MouseEventArgs derives from EventArgs
//
// 3. Our MultiHandler method signature: MultiHandler(object sender, EventArgs e)
//
// 4. Contravariance allows us to use MultiHandler (which expects EventArgs)
//    for events that provide more specific types (KeyEventArgs, MouseEventArgs)
//    because the more specific types can be safely treated as their base type.
//
// This is safe because:
// - The MultiHandler only uses members available on the base EventArgs type
// - KeyEventArgs and MouseEventArgs can be implicitly converted to EventArgs
// - The compiler knows that any EventArgs-derived type can be passed safely

Po uruchomieniu tego przykładu będziesz mógł zobaczyć, że ta sama MultiHandler metoda pomyślnie obsługuje zdarzenia klawiatury i myszy, pokazując, jak kontrawariancja umożliwia bardziej elastyczny i wielokrotnego użycia kod do obsługi zdarzeń.

Zobacz także

  • Last updated on