第12章 委托与事件

Posted 2021-11-30 mrfang

委托和事件在 .NET Framework 中的应用非常广泛，然而，较好地理解委托和事件对很多接触 C# 时间不长的人来说并不容易。它们就像是一道槛儿，过了这个槛的人，觉得真是太容易了，而没有过去的人每次见到委托和事件就觉得心里堵得慌，浑身不自在。本章中，我将由浅入深地讲述什么是委托、为什么要使用委托、事件的由来、.NET Framework 中的委托和事件、委托中方法异常和超时的处理、委托与异步编程、委托和事件对Observer 设计模式的意义，对它们的编译代码也做了讨论。

12.1将方法作为方法的参数

我们先不管这个标题如何的绕口，也不管委托究竟是个什么东西，来看下面这两个最简单的方法，它们不过是在屏幕上输出一句问候的话语：

示例1

class Program

{

static void Main(string[] args)

{

Program p = new Program();

p.GreetPeople("Jimmy");

}

public void GreetPeople(string name)

{

EnglishGreeting(name);

}

public void EnglishGreeting(string name)

{

Console.WriteLine("Morning, " + name);

}

}

暂且不管这两个方法有没有什么实际意义。GreetPeople用于向某人问好，当我们传递代表某人姓名的name参数，比如说"Jimmy"，进去的时候，在这个方法中，将调用EnglishGreeting方法，再次传递name参数，EnglishGreeting则用于向屏幕输出 "Morning, Jimmy"。如图12-1所示。

图12-1 欢迎语显示结果

现在假设这个程序需要进行全球化，哎呀，不好了，我是中国人，我不明白"Good Morning"是什么意思，怎么办呢？好吧，我们再加个中文版的问候方法：

public void ChineseGreeting(string name)

{

Console.WriteLine("早上好, " + name);

}

这时候，GreetPeople 也需要改一改了，不然如何判断到底用哪个版本的 Greeting 问候方法合适呢？在进行这个之前，我们最好再定义一个枚举作为判断的依据：

示例2

public enum Language

{

English, Chinese

}

public void GreetPeople(string name, Language lang)

{

switch(lang)

{

case Language.English:

EnglishGreeting(name);

break;

case Language.Chinese:

ChineseGreeting(name);

break;

}

}

修改好之后在程序入口函数中调用被重载的新方法，

public void GreetPeople(string name, Language lang)

整体代码如示例3所示：

示例3

class Program

{

static void Main(string[] args)

{

Program p = new Program();

p.GreetPeople("杰米",Language.Chinese);

}

public void GreetPeople(string name)

{

EnglishGreeting(name);

}

public void ChineseGreeting(string name)

{

Console.WriteLine("早上好, " + name);

}

public void EnglishGreeting(string name)

{

Console.WriteLine("Morning, " + name);

}

public enum Language

{

English, Chinese

}

public void GreetPeople(string name, Language lang){

switch(lang){

case Language.English:

EnglishGreeting(name);

break;

case Language.Chinese:

ChineseGreeting(name);

break;

}

}

}

结果如图12-2所示。

 

 

图12-2 欢迎语显示结果

尽管这样解决了问题，但大家也很容易想到，这个解决方案的可扩展性很差，如果日后我们需要再添加韩文版、日文版，就不得不反复修改枚举和GreetPeople()方法，以适应新的需求。

在考虑新的解决方案之前，我们先看看 GreetPeople的方法签名（方法签名包括：1.返回类型，2.参数列表，3方法名称）：

public void GreetPeople(string name, Language lang)

我们仅看 string name，在这里，string 是参数类型，name 是参数变量，当我们赋给name字符串"jimmy"时，它就代表"jimmy"这个值；当我们赋给它"张子阳"时，它又代表着"张子阳"这个值。然后，我们可以在方法体内对这个name进行其他操作。

如果你再仔细想想，假如GreetPeople()方法可以接受一个参数变量，这个变量可以代表另一个方法，当我们给这个变量赋值 EnglishGreeting的时候，它代表着 EnglsihGreeting() 这个方法；当我们给它赋值ChineseGreeting 的时候，它又代表着ChineseGreeting()方法。我们将这个参数变量命名为 MakeGreeting，那么不就可以给name赋值时一样，在调用 GreetPeople()方法的时候，给这个MakeGreeting 参数也赋上值吗(ChineseGreeting或者EnglsihGreeting等)？然后，我们在方法体内，也可以像使用别的参数一样使用MakeGreeting。但是，由于MakeGreeting代表着一个方法，它的使用方式应该和它被赋的方法(比如ChineseGreeting)是一样的，比如：MakeGreeting(name);好了，有了思路了，我们现在就来改改GreetPeople()方法，那么它应该是这个样子了：

public void GreetPeople(string name, *** MakeGreeting)

{

MakeGreeting(name);

}

注意到 *** ，这个位置通常放置的应该是参数的类型，但到目前为止，我们仅仅是想到应该有个可以代表方法的参数，并按这个思路去改写GreetPeople方法，现在就出现了一个大问题：这个代表着方法的MakeGreeting参数应该是什么类型的？

注意：这里已不再需要枚举了，因为在给MakeGreeting赋值的时候动态地决定使用哪个方法，是ChineseGreeting还是 EnglishGreeting，而在这两个方法内部，已经对使用"morning"还是"早上好"作了区分。

聪明的你应该已经想到了，现在是委托该出场的时候了，但讲述委托之前，我们再看看MakeGreeting参数所能代表的 ChineseGreeting()和EnglishGreeting()方法的签名：

public void EnglishGreeting(string name)

public void ChineseGreeting(string name)

如同name可以接受String类型的"true"和"1"，但不能接受bool类型的true和int类型的1一样。MakeGreeting的参数类型定义应该能够确定 MakeGreeting可以代表的方法种类，再进一步讲，就是MakeGreeting可以代表的方法的参数类型和返回类型。

于是，委托出现了：它定义了MakeGreeting参数所能代表的方法的种类，也就是MakeGreeting参数的类型。

注意：如果上面这句话比较绕口，我们就把它翻译成这样：string 定义了name参数所能代表的值的种类，也就是name参数的类型。

委托的定义：

public delegate void GreetingDelegate(string name);

可以与上面EnglishGreeting()方法的签名对比一下，除了加入delegate关键字以外，其余的是不是完全一样？

现在，让我们再次改动GreetPeople()方法，如示例4所示：

示例4

public delegate void GreetingDelegate(string name);

public void GreetPeople(string name, GreetingDelegate makeGreeting){

makeGreeting(name);

}

如你所见，委托GreetingDelegate出现的位置与 string相同，string是一个类型，那么GreetingDelegate应该也是一个类型，或者叫类(Class)。但是委托的声明方式和类却完全不同，这是怎么一回事？实际上，委托在编译的时候确实会编译成类。因为Delegate是一个类，所以在任何可以声明类的地方都可以声明委托。更多的内容将在下面讲述，现在，请看看这个范例的完整代码：

示例5

//定义委托，它定义了可以代表的方法的类型

public delegate void GreetingDelegate(string name);

   

class Program

{

private static void EnglishGreeting(string name)

{

Console.WriteLine("Morning, " +name);

}

private static void ChineseGreeting(string name)

{

Console.WriteLine("早上好, " +name);

}

//注意此方法，它接受一个GreetingDelegate类型的方法作为参数

private static void GreetPeople(string name,

GreetingDelegate MakeGreeting)

{

MakeGreeting(name);

}

static void Main(string[] args)

{

GreetPeople("Jimmy Zhang",EnglishGreeting);

GreetPeople("张子阳",ChineseGreeting);

}

}

运行结构如图12-3所示。

 

 

图12-3 示例5运行结果

我们现在对委托做一个总结： 委托是一个类，它定义了方法的类型，使得可以将方法当作另一个方法的参数来进行传递，这种将方法动态地赋给参数的做法，可以避免在程序中大量使用if-else(switch)语句，同时使得程序具有更好的可扩展性。

将方法绑定到委托，到这里，是不是有那么点如梦初醒的感觉？于是，你是不是在想：在上面的例子中，我不一定要直接在GreetPeople()方法中给 name参数赋值，我可以像这样使用变量：

示例6

static void Main(string[] args)

{

string name1, name2; //声明

name1 = "Jimmy Funy"; //赋值

name2 = "王小毛";

GreetPeople(name1, EnglishGreeting);

GreetPeople(name2, ChineseGreeting);

}

而既然委托GreetingDelegate 和类型 string 的地位一样，都是定义了一种参数类型，那么，我们是不是也可以这么使用委托？答案是肯定的，如实例7所示。

示例7

GreetingDelegate delegate1, delegate2; //声明

delegate1 = EnglishGreeting; //赋值

delegate2 = ChineseGreeting;

   

GreetPeople("Jimmy Funy", delegate1);

GreetPeople("王小毛", delegate2);

委托还有不同于string的一个特性：可以将多个方法赋给同一个委托，或者叫将多个方法绑定到同一个委托。当调用这个委托的时候，将依次调用其所绑定的方法。语法如下：

示例8

static void Main(string[] args)

{

GreetingDelegate delegate1;

delegate1 = EnglishGreeting;

delegate1 += ChineseGreeting; //绑定第二个方法

   

GreetPeople("Jimmy Funy", delegate1);

Console.ReadKey();

}

运行结果如图12-4所示。

 

 

图12-4 委托绑定多个方法

实际上，我们还可以跳过GreetPeople方法，通过委托来直接调用EnglishGreeting和ChineseGreeting并且与之传参。如示例9所示。

示例9

static void Main(string[] args)

{

GreetingDelegate delegate1;

delegate1 = EnglishGreeting; // 先给委托类型的变量赋值

delegate1 += ChineseGreeting; // 给此委托变量再绑定一个方法

// 将先后调用 EnglishGreeting 与ChineseGreeting方法

delegate1("Jimmy Funy");

Console.ReadKey();

}

运行结果同图12-4。

注意：

再示例9中，第一次用的"="，是赋值的语法；第二次，用的是"+="，是绑定的语法。如果第一次就使用"+="，将出现"使用了未赋值的局部变量"的编译错误。可以通过下面语句给委托初始化。

GreetingDelegate delegate1 = new GreetingDelegate(EnglishGreeting);

既然给委托可以绑定一个方法，那么也应该有办法取消对方法的绑定，很容易想到，这个语法是"－＝"。如示例10所示。

示例10

static void Main(string[] args)

{

GreetingDelegate delegate1 = new GreetingDelegate(EnglishGreeting);

delegate1 += ChineseGreeting; // 给此委托变量再绑定一个方法

   

// 将先后调用 EnglishGreeting 与 ChineseGreeting 方法

GreetPeople("Jimmy Funy", delegate1);

Console.WriteLine();

   

delegate1 -= EnglishGreeting; //取消对EnglishGreeting方法的绑定

// 将仅调用 ChineseGreeting

GreetPeople("王小毛", delegate1);

Console.ReadKey();

}

12.2 事件

12.2.1 事件的由来

我们继续思考上面的程序：上面的三个方法都定义在Programe类中，这样做是为了理解的方便，实际应用中，通常都是 GreetPeople 在一个类中，ChineseGreeting和 EnglishGreeting 在另外的类中。现在你已经对委托有了初步了解，应该对上面的例子做一些改进了。假设我们将GreetingPeople()放在一个叫GreetingManager的类中，那么新程序应该是这个样子的？

示例11

namespace Delegate

{

//定义委托，它定义了可以代表的方法的类型

public delegate void GreetingDelegate(string name);

//新建的GreetingManager类

public class GreetingManager

{

public void GreetPeople(string name, GreetingDelegate MakeGreeting)

{

MakeGreeting(name);

}

}

class Program

{

private static void EnglishGreeting(string name)

{

Console.WriteLine("Morning, " + name);

}

private static void ChineseGreeting(string name)

{

Console.WriteLine("早上好, " + name);

}

static void Main(string[] args)

{

GreetingManager gm = new GreetingManager();

GreetingDelegate delegate1;

//绑定多个方法

delegate1 = EnglishGreeting;

delegate1 += ChineseGreeting;

//调用方法

gm.GreetPeaple("Jimmy Funy", delegate1);

}

}

}

运行结果如图12-4所示。

到了这里，我们不禁想到：面向对象设计，讲究的是对象的封装，既然可以声明委托类型的变量(在上例中是delegate1)，我们何不将这个变量封装到 GreetManager类中？在这个类的客户端中使用不是更方便么？于是，我们改写GreetManager类，像这样：

示例12

//新建的GreetingManager类

class GreetingManager

{

//在GreetingManager类的内部声明delegate1变量

public GreetingDelegate delegate1;

public void GreetingPeaple(string name)

{

//如果有方法注册委托变量

if (delegate1 != null)

{

delegate1(name); //通过委托调用方法

}

}

}

//测试类Main（）方法

static void Main(string[] args)

{

GreetingManager gm = new GreetingManager();

gm.delegate1 = EnglishGreeting;

gm.delegate1 += ChineseGreeting;

   

gm.GreetPeople("Jimmy Zhang");

}

尽管这样达到了我们要的效果，但是还是存在着问题：

• 在GreetingManager类中，delegate1成员被声明为public，这意味着调用者可以对它进行随意的赋值等操作，严重破坏对象的封装性。但如果声明为private，客户端对它根本就不可见，那它还有什么用？
• 在Main（）方法中，第一个方法注册用"="，是赋值语法，因为要进行实例化，第二个方法注册则用的是"+="。但是，不管是赋值还是注册，都是将方法绑定到委托上，除了调用时先后顺序不同，再没有任何的分别，这样让人觉得很别扭。
• 对上面两个问题，我们自然会想到用对delegate1进行封装的方式来解决。那么如何对委托进行封装呢？答案是使用事件。

  12.2.2 什么是事件

  事件是对委托的封装。声明事件的语法如下：

  访问修饰符 event 委托类型 事件名；

  我们改写GreetingManager类，它变成了这个样子：

  示例13

  public class GreetingManager

  {

  //声明事件

  public event GreetingDelegate MakeGreet;

  public void GreetPeople(string name)

  {

  MakeGreet(name);

  }

  }

  我们发现，MakeGreet 事件的声明与之前委托变量 delegate1 的声明唯一的区别是多了一个 event 关键字。那它是如何对委托进行封装的呢？我们借助 Reflactor 工具来对 event 的声明语句进行反编译，得到以下代码：

  private GreetingDelegate MakeGreet;

  [MethodImpl(MethodImplOptions.Synchronized)]

  public void add_MakeGreet(GreetingDelegate value)

  {

  this.MakeGreet = (GreetingDelegate) Delegate.Combine(this.MakeGreet, value);

  }

  [MethodImpl(MethodImplOptions.Synchronized)]

  public void remove_MakeGreet(GreetingDelegate value)

  {

  this.MakeGreet = (GreetingDelegate) Delegate.Remove(this.MakeGreet, value);

  }

  通过反编译代码能明确：MakeGreet 事件确实是一个GreetingDelegate 类型的委托，只不过不管是不是声明为public，它总是被声明为private。另外，它还有两个方法，分别是add_MakeGreet和remove_MakeGreet，这两个方法分别用于注册委托类型的方法和取消注册。实际上也就是："+= "对应 add_MakeGreet，"-="对应remove_MakeGreet。而这两个方法的访问限制取决于声明事件时的访问限制符。

  12.2.2 事件限制类型的能力

  使用事件不仅能获得比委托更好的封装性以外，还能限制含有事件的类型的能力。这是什么意思呢？它的意思是说：事件应该由事件发布者触发，而不应该由事件的客户端（客户程序）来触发。请看示例14。

  示例14

  // 定义委托

  public delegate void NumberChangedEventHandler(int count);

  // 事件发布者类

  public class Publishser

  {

  private int count;

  // 声明委托变量

  public NumberChangedEventHandler NumberChanged;

  // 声明一个事件

  //public event NumberChangedEventHandler NumberChanged;

     

  public void DoSomething()

  {

  // 在这里完成一些工作 ...

  if (NumberChanged != null) // 触发事件

  {

  count++;

  NumberChanged(count);

  }

  }

  }

  // 事件订阅者类

  public class Subscriber

  {

  public void OnNumberChanged(int count)

  {

  Console.WriteLine("Subscriber notified: count = {0}", count);

  }

  }

  //测试类Main（）方法

  static void Main(string[] args)

  {

  Publishser pub = new Publishser(); //发布者对象

  Subscriber sub = new Subscriber(); //订阅者对象

  pub.NumberChanged += new NumberChangedEventHandler(sub.OnNumberChanged);

  pub.DoSomething(); // 应该通过DoSomething()来触发事件

  pub.NumberChanged(100); // 但可以被这样直接调用，对委托变量的不恰当使用

  }

  上面代码定义了一个NumberChangedEventHandler 委托，然后我们创建了事件的发布者Publisher 和订阅者Subscriber。当使用委托变量时，客户端可以直接通过委托变量触发事件，也就是直接调用pub.NumberChanged(100)，这将会影响到所有注册了该委托的订阅者。而事件的本意应该为在事件发布者在其本身的某个行为中触发，比如说在方法DoSomething()中满足某个条件后触发。通过添加event 关键字来发布事件，事件发布者的封装性会更好，事件仅仅是供其他类型订阅，而客户端不能直接触发事件（语句pub.NumberChanged(100)无法通过编译），事件只能在事件发布者Publisher 类的内部触发（比如在方法pub.DoSomething()中），换言之，就是NumberChanged(100)语句只能在Publisher 内部被调用。大家可以尝试一下，将委托变量的声明那行代码注释掉，然后取消下面事件声明的注释。此时程序是无法编译的，当你使用了event 关键字之后，直接在客户端触发事件这种行为，也就是直接调用pub.NumberChanged(100)，是被禁止的。事件只能通过调用DoSomething() 来触发。这样才是事件的本意，事件发布者的封装才会更好。

  就好像如果我们要定义一个数字类型，我们会使用int 而不是使用object 一样，给予对象过多的能力并不见得是一件好事，应该是越合适越好。尽管直接使用委托变量通常不会有什么问题，但它给了客户端不应具有的能力，而使用事件，可以限制这一能力，更精确地对类型进行封装。

  约定

  这里还有一个约定俗称的规定，就是订阅事件的方法的命名，通常为"On 事件名"，比如这里的OnNumberChanged。

  12.3 Observer 设计模式

  现在假设我们有个高档的热水器，热水器由三部分组成：热水器、警报器、显示器，它们来自于不同厂商并进行了组装。给热水器通上电，当水温超过95度的时候：扬声器会开始发出语音，告诉你水的温度；液晶屏也会改变水温的显示，来提示水已经快烧开了。

  现在我们需要写个程序来模拟这个烧水的过程。

  通过对上面需求的分析，我们会定义热水器、警报器和显示器三个类。如示例15所示。

  示例15

  // 热水器类

  public class Heater

  {

  private int temperature; //温度

  // 烧水

  private void BoilWater()

  {

  for (int i = 0; i <= 100; i++)

  {

  temperature = i;

  }

  }

  }

  // 警报器类

  public class Alarm

  {

  // 发出语言警报方法

  private void MakeAlert(int param)

  {

  Console.WriteLine("Alarm：嘀嘀嘀，水已经 {0} 度了：", param);

  }

  }

     

  // 显示器类

  public class Display

  {

  // 显示温度方法

  private void ShowMsg(int param)

  {

  Console.WriteLine("Display：水已烧开，当前温度：{0}度。", param);

  }

  }

  这里就出现了一个问题：如何在水烧开的时候通知报警器和显示器？

  在继续进行之前，我们先了解一下Observer设计模式（观察者模式），Observer 设计模式中主要包括如下两类对象：

• Subject：监视对象，它往往包含着其他对象所感兴趣的内容。
  示例15中，热水器就是一个监视对象，它包含的其他对象所感兴趣的内容，就是 temprature 字段，当这个字段的值快到100 时，会不断把数据发给监视它的对象。
• Observer：监视者，它监视Subject，当 Subject 中的某件事发生的时候，会告知Observer，而Observer 则会采取相应的行动。
  示例15中，Observer有警报器和显示器，它们采取的行动分别是发出警报和显示水温。

  在本例中，事情发生的顺序应该是这样的：

  1. 警报器和显示器告诉热水器，它对它的温度比较感兴趣(注册)。

  2. 热水器知道后保留对警报器和显示器的引用。

  3. 热水器进行烧水这一动作，当水温超过 95 度时，通过对警报器和显示器的引用，自动调用警报器的MakeAlert()方法、显示器的ShowMsg()方法。

  Observer 设计模式：

  Observer 设计模式是为了定义对象间的一种一对多的依赖关系，以便于当一个对象的状态改变时，其他依赖于它的对象会被自动告知并更新。

  按照Observer设计模式，我们对热水器类进行修改，如示例16所示。

  示例16

  // 热水器类

  public class Heate

  {

  //温度

  private int temperature;

     

  public delegate void BoilHandler(int param);

  // 定义事件

  public event BoilHandler BoilEvent;

  // 烧水

  public void BoilWater()

  {

  for (int i = 0; i <= 100; i++)

  {

  temperature = i;

  if (temperature > 95)

  {

  if (BoilEvent != null)

  BoilEvent(temperature); // 调用所有注册对象的方法

  }

  }

  }

  }

  //测试类Main（）方法

  static void Main()

  {

  Heater heater = new Heater();

  Alarm alarm = new Alarm();

  heater.BoilEvent += alarm.MakeAlert; // 注册方法

  heater.BoilEvent += (new Alarm()).MakeAlert; // 给匿名对象注册方法

  heater.BoilEvent += Display.ShowMsg; // 注册静态方法

  heater.BoilWater(); // 烧水，会自动调用注册过对象的方法

  }

  运行结果如图12-5所示。

   

   

  图12-5 热水器烧水运行结果