使用委托 (C# 编程指南)

委托是一种安全封装方法的类型,类似于 C 和 C++ 中的函数指针。 与 C 函数指针不同的是,委托是面向对象的、类型安全的和可靠的。 以下示例声明了一个名为 Callback 的委托,该委托可以封装一个方法,该方法接受 字符串 作为参数,并返回 void

public delegate void Callback(string message);

委托对象通常通过指定委托所包装的方法名称,或使用 lambda 表达式来构造。 一旦以这种方式实例化,就可以调用委托。 调用委托会调用附加到委托实例的方法。 调用方传递到委托的参数将传递到该方法。 委托对象从方法中返回返回值(如果有)。 例如:

// Create a method for a delegate.
public static void DelegateMethod(string message)
{
    Console.WriteLine(message);
}
// Instantiate the delegate.
Callback handler = DelegateMethod;

// Call the delegate.
handler("Hello World");

委托类型派生自 Delegate .NET 中的类。 委托类型是密封的类型,不能从中继承,也无法从派生自定义类。 由于实例化委托是一个对象,因此它可以作为参数传递或分配给属性。 方法可以接受委托作为参数,并在稍后调用委托。 这称为异步回调,是一种在长时间进程完成时通知调用方的常见方法。 以这种方式使用委托时,使用委托的代码不需要对所使用的方法的实现有任何了解。 此功能类似于封装接口提供的。

回调的另一个常见用途是定义自定义比较方法,并将该委托传递给排序方法。 它允许调用方的代码成为排序算法的一部分。 以下示例方法使用 Del 类型作为参数:

public static void MethodWithCallback(int param1, int param2, Callback callback)
{
    callback("The number is: " + (param1 + param2).ToString());
}

然后,可以将在前面的示例中创建的委托传递给该方法:

MethodWithCallback(1, 2, handler);

并将以下输出接收到控制台:

The number is: 3

MethodWithCallback 不需要直接调用控制台,记住,其不必设计为具有控制台。 MethodWithCallback 的作用是准备一个字符串并将该字符串传递给另一方法。 委托方法可以使用任意数量的参数。

当委托构造为封装实例方法时,委托将同时引用实例和方法。 委托不知道除其所封装方法以外的实例类型。 委托可以引用任何类型的对象,只要该对象上有与委托签名匹配的方法。 创建委托以封装静态方法时,它仅引用该方法。 请考虑以下声明:

public class MethodClass
{
    public void Method1(string message) { }
    public void Method2(string message) { }
}

除了前面所示的静态 DelegateMethod 之外,我们现在有三个方法,您可以将它们包装在 Del 实例中。

当被调用时,委托可以调用多个方法,称为多播。 若要向委托的方法列表(调用列表)添加其他方法,只需使用加法运算符或加法赋值运算符(“+”或“+=”)添加两个委托。 例如:

var obj = new MethodClass();
Callback d1 = obj.Method1;
Callback d2 = obj.Method2;
Callback d3 = DelegateMethod;

//Both types of assignment are valid.
Callback allMethodsDelegate = d1 + d2;
allMethodsDelegate += d3;

allMethodsDelegate调用列表中包含三个方法,Method1Method2以及DelegateMethod。 原来的三个 d1代表, d2d3,保持不变。 当调用 allMethodsDelegate 时,会按顺序调用所有三种方法。 如果委托使用引用参数,则依次将引用传递给这三种方法中的每个方法,并且一种方法的任何更改对下一个方法都可见。 当任何方法引发未在方法内捕获到的异常时,该异常将传递到委托的调用方。 调用列表中没有调用后续方法。 如果委托具有返回值和/或输出参数,它将返回上次调用方法的返回值和参数。 若要从调用列表中删除方法,请使用 减法或减法赋值运算符--=)。 例如:

//remove Method1
allMethodsDelegate -= d1;

// copy AllMethodsDelegate while removing d2
Callback oneMethodDelegate = (allMethodsDelegate - d2)!;

由于委托类型派生自 System.Delegate,因此可以在委托上调用该类定义的方法和属性。 例如,若要在委托的调用列表中查找方法数,可以编写:

int invocationCount = d1.GetInvocationList().GetLength(0);

调用列表中具有多个方法的委托派生自 MulticastDelegate,该类属于 System.Delegate 的子类。 上述代码在任一情况下都有效,因为两个类都支持 GetInvocationList

多播委托广泛用于事件处理中。 事件源对象向注册以接收该事件的收件人对象发送事件通知。 为了注册事件,收件人会创建一个用于处理事件的方法,然后为该方法创建一个委托,并将委托传递给事件源。 事件发生时,源调用委托。 然后,委托将对接收方调用事件处理方法,从而提供事件数据。 事件源定义给定事件的委托类型。 有关详细信息,请参阅 事件

比较在编译时分配的两种不同类型的委托会导致编译错误。 如果委托实例是静态类型的 System.Delegate,则允许比较,但在运行时返回 false。 例如:

delegate void Callback1();
delegate void Callback2();

static void method(Callback1 d, Callback2 e, System.Delegate f)
{
    // Compile-time error.
    Console.WriteLine(d == e);

    // OK at compile-time. False if the run-time type of f
    // is not the same as that of d.
    Console.WriteLine(d == f);
}

另请参阅