Sdílet prostřednictvím


Použití varianty v delegátech (C#)

Když přiřadíte metodu delegátovi, kovariance a kontravariance poskytují flexibilitu pro porovnávání typu delegáta s podpisem metody. Kovariance umožňuje, aby metoda měla návratový typ, který je odvozenější než ten definovaný v delegátu. Kontravariance umožňuje metodu, která má typy parametrů, které jsou méně odvozené než ty v typu delegáta.

Příklad 1: Kovariance

Popis

Tento příklad ukazuje, jak lze delegáty použít s metodami, které mají návratové typy odvozené od návratového typu v podpisu delegáta. Datový typ vrácený typem DogsHandler je typu Dogs, který je odvozen od Mammals typu, který je definován v delegátu.

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;  
    }  
}  

Příklad 2: Kontravariance

Popis

Tento příklad ukazuje, jak lze delegáty použít s metodami, které mají parametry, jejichž typy jsou základní typy typu parametru podpisu delegáta. Při kontravarianci můžete místo samostatných obslužných rutin použít jednu obslužnou rutinu události. Následující příklad používá dva delegáty:

  • Vlastní KeyEventHandler delegát, který definuje podpis klíčové události. Jeho podpis je:

    public delegate void KeyEventHandler(object sender, KeyEventArgs e)
    
  • Vlastní MouseEventHandler delegát, který definuje signaturu události myši. Jeho podpis je:

    public delegate void MouseEventHandler(object sender, MouseEventArgs e)
    

Příklad definuje obslužnou rutinu události s parametrem EventArgs a používá ji ke zpracování událostí klíče i myši. To funguje, protože EventArgs je základním typem vlastních KeyEventArgs i MouseEventArgs tříd definovaných v příkladu. Kontravariance umožňuje metodu, která přijímá parametr základního typu, který se má použít pro události, které poskytují odvozené parametry typu.

Jak funguje kontravariance v tomto příkladu

Když se přihlásíte k odběru události, kompilátor zkontroluje, jestli je metoda obslužné rutiny události kompatibilní s podpisem delegáta události. S kontravariancí:

  1. Událost KeyDown očekává metodu, která přebírá KeyEventArgs.
  2. Událost MouseClick očekává metodu, která přebírá MouseEventArgs.
  3. Vaše MultiHandler metoda přebírá základní typ EventArgs.
  4. Vzhledem k tomu, že KeyEventArgs a MouseEventArgs oba dědí z EventArgs, mohou být bezpečně předány do metody, která očekává EventArgs.
  5. Kompilátor toto přiřazení umožňuje, protože je bezpečné – MultiHandler může pracovat s libovolnou EventArgs instancí.

To je kontravariance v akci: můžete použít metodu s parametrem "méně specifického" (základního typu), kde se očekává parametr "konkrétnější" (odvozený typ).

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);
    }
}

Klíčové body týkající se kontravariance

// 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

Když spustíte tento příklad, uvidíte, že stejná MultiHandler metoda úspěšně zpracovává události klíče i myši a ukazuje, jak kontravariance umožňuje flexibilnější a opakovaně použitelný kód zpracování událostí.

Viz také