转载

goodwangLib 2018-01-27

展开全文

C#事件的使用和讲解

事件的由来

在上一篇幅博客中http://www.cnblogs.com/JiYF/p/6867081.html 对委托讲解的比较细致

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

1 namespace Delegate { 2 //定义委托，它定义了可以代表的方法的类型 3 public delegate void GreetingDelegate(string name); 4 5 //新建的GreetingManager类 6 public class GreetingManager{ 7 public void GreetPeople(string name, GreetingDelegate MakeGreeting) { 8 MakeGreeting(name); 9 }10 }11 12 class Program {13 private static void EnglishGreeting(string name) {14 Console.WriteLine('Morning, ' + name);15 }16 17 private static void ChineseGreeting(string name) {18 Console.WriteLine('早上好, ' + name);19 }20 21 static void Main(string[] args) {22 // ... ...23 }24 }25 }

这个时候，如果要实现前面演示的输出效果，Main方法我想应该是这样的：

1 static void Main(string[] args) {2 GreetingManager gm = new GreetingManager();3 gm.GreetPeople('Jimmy Zhang', EnglishGreeting);4 gm.GreetPeople('张子阳', ChineseGreeting);5 }

我们运行这段代码，嗯，没有任何问题。程序一如预料地那样输出了：

Morning, Jimmy Zhang

早上好, 张子阳

现在，假设我们需要使用上一节学到的知识，将多个方法绑定到同一个委托变量，该如何做呢？让我们再次改写代码：

1 static void Main(string[] args) {2 GreetingManager gm = new GreetingManager();3 GreetingDelegate delegate1;4 delegate1 = EnglishGreeting;5 delegate1 += ChineseGreeting;6 7 gm.GreetPeople('Jimmy Zhang', delegate1);8 }

输出：
Morning, Jimmy Zhang
早上好, Jimmy Zhang

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

1 public class GreetingManager{2 //在GreetingManager类的内部声明delegate1变量3 public GreetingDelegate delegate1; 4 5 public void GreetPeople(string name, GreetingDelegate MakeGreeting) {6 MakeGreeting(name);7 }8 }

现在，我们可以这样使用这个委托变量：

1 static void Main(string[] args) {2 GreetingManager gm = new GreetingManager();3 gm.delegate1 = EnglishGreeting;4 gm.delegate1 += ChineseGreeting;5 6 gm.GreetPeople('Jimmy Zhang', gm.delegate1);7 }

输出为：
Morning, Jimmy Zhang
早上好, Jimmy Zhang

尽管这样做没有任何问题，但我们发现这条语句很奇怪。在调用gm.GreetPeople方法的时候，再次传递了gm的delegate1字段：

gm.GreetPeople('Jimmy Zhang', gm.delegate1);

既然如此，我们何不修改 GreetingManager 类成这样：

1 public class GreetingManager{ 2 //在GreetingManager类的内部声明delegate1变量 3 public GreetingDelegate delegate1; 4 5 public void GreetPeople(string name) { 6 if(delegate1!=null){ //如果有方法注册委托变量 7 delegate1(name); //通过委托调用方法 8 } 9 }10 }

在客户端，调用看上去更简洁一些：

1 static void Main(string[] args) {2 GreetingManager gm = new GreetingManager();3 gm.delegate1 = EnglishGreeting;4 gm.delegate1 += ChineseGreeting;5 6 gm.GreetPeople('Jimmy Zhang'); //注意，这次不需要再传递 delegate1变量7 }

输出为：
Morning, Jimmy Zhang
早上好, Jimmy Zhang

事件的出现

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

在这里，delegate1和我们平时用的string类型的变量没有什么分别，而我们知道，并不是所有的字段都应该声明成public，合适的做法是应该public的时候public，应该private的时候private。

我们先看看如果把 delegate1 声明为 private会怎样？结果就是：这简直就是在搞笑。因为声明委托的目的就是为了把它暴露在类的客户端进行方法的注册，你把它声明为private了，客户端对它根本就不可见，那它还有什么用？

再看看把delegate1 声明为 public 会怎样？结果就是：在客户端可以对它进行随意的赋值等操作，严重破坏对象的封装性。

最后，第一个方法注册用“=”，是赋值语法，因为要进行实例化，第二个方法注册则用的是“+=”。但是，不管是赋值还是注册，都是将方法绑定到委托上，除了调用时先后顺序不同，再没有任何的分别，这样不是让人觉得很别扭么？

现在我们想想，如果delegate1不是一个委托类型，而是一个string类型，你会怎么做？答案是使用属性对字段进行封装。

于是，Event出场了，它封装了委托类型的变量，使得：在类的内部，不管你声明它是public还是protected，它总是private的。在类的外部，注册“+=”和注销“-=”的访问限定符与你在声明事件时使用的访问符相同。

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

1 public class GreetingManager{2 //这一次我们在这里声明一个事件3 public event GreetingDelegate MakeGreet;4 5 public void GreetPeople(string name) {6 MakeGreet(name);7 }8 }

很容易注意到：MakeGreet 事件的声明与之前委托变量delegate1的声明唯一的区别是多了一个event关键字。看到这里，在结合上面的讲解，你应该明白到：事件其实没什么不好理解的，声明一个事件不过类似于声明一个进行了封装的委托类型的变量而已。

为了证明上面的推论，如果我们像下面这样改写Main方法：

1 static void Main(string[] args) {2 GreetingManager gm = new GreetingManager();3 gm.MakeGreet = EnglishGreeting; // 编译错误14 gm.MakeGreet += ChineseGreeting;5 6 gm.GreetPeople('Jimmy Zhang');7 }

会得到编译错误：事件“Delegate.GreetingManager.MakeGreet”只能出现在 += 或 -= 的左边(从类型“Delegate.GreetingManager”中使用时除外)。

事件和委托的编译代码

这时候，我们注释掉编译错误的行，然后重新进行编译，再借助Reflactor来对 event的声明语句做一探究，看看为什么会发生这样的错误：

public event GreetingDelegate MakeGreet;

可以看到，实际上尽管我们在GreetingManager里将 MakeGreet 声明为public，但是，实际上MakeGreet会被编译成私有字段，难怪会发生上面的编译错误了，因为它根本就不允许在GreetingManager类的外面以赋值的方式访问，从而验证了我们上面所做的推论。

我们再进一步看下MakeGreet所产生的代码：

1 private GreetingDelegate MakeGreet; //对事件的声明实际是声明一个私有的委托变量 2 3 [MethodImpl(MethodImplOptions.Synchronized)] 4 public void add_MakeGreet(GreetingDelegate value){ 5 this.MakeGreet = (GreetingDelegate) Delegate.Combine(this.MakeGreet, value); 6 } 7 8 [MethodImpl(MethodImplOptions.Synchronized)] 9 public void remove_MakeGreet(GreetingDelegate value){10 this.MakeGreet = (GreetingDelegate) Delegate.Remove(this.MakeGreet, value);11 }

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

在add_MakeGreet()方法内部，实际上调用了System.Delegate的Combine()静态方法，这个方法用于将当前的变量添加到委托链表中。我们前面提到过两次，说委托实际上是一个类，在我们定义委托的时候：

1 public delegate void GreetingDelegate(string name);

当编译器遇到这段代码的时候，会生成下面这样一个完整的类：

1 public sealed class GreetingDelegate:System.MulticastDelegate{2 public GreetingDelegate(object @object, IntPtr method);3 public virtual IAsyncResult BeginInvoke(string name, AsyncCallback callback, object @object);4 public virtual void EndInvoke(IAsyncResult result);5 public virtual void Invoke(string name);6 }

关于这个类的更深入内容，可以参阅《CLR Via C#》等相关书籍，这里就不再讨论了。

委托、事件与Observer设计模式

范例说明

上面的例子已不足以再进行下面的讲解了，我们来看一个新的范例，因为之前已经介绍了很多的内容，所以本节的进度会稍微快一些：

假设我们有个高档的热水器，我们给它通上电，当水温超过95度的时候：1、扬声器会开始发出语音，告诉你水的温度；2、液晶屏也会改变水温的显示，来提示水已经快烧开了。

现在我们需要写个程序来模拟这个烧水的过程，我们将定义一个类来代表热水器，我们管它叫：Heater，它有代表水温的字段，叫做temperature；当然，还有必不可少的给水加热方法BoilWater()，一个发出语音警报的方法MakeAlert()，一个显示水温的方法，ShowMsg()。

1 namespace Delegate { 2 class Heater { 3 private int temperature; // 水温 4 // 烧水 5 public void BoilWater() { 6 for (int i = 0; i <=>100; i++) { 7 temperature = i; 8 9 if (temperature > 95) {10 MakeAlert(temperature);11 ShowMsg(temperature);12 }13 }14 }15 16 // 发出语音警报17 private void MakeAlert(int param) {18 Console.WriteLine('Alarm：嘀嘀嘀，水已经 {0} 度了：' , param);19 }20 21 // 显示水温22 private void ShowMsg(int param) {23 Console.WriteLine('Display：水快开了，当前温度：{0}度。' , param);24 }25 }26 27 class Program {28 static void Main() {29 Heater ht = new Heater();30 ht.BoilWater();31 }32 }33 }

Observer设计模式简介

上面的例子显然能完成我们之前描述的工作，但是却并不够好。现在假设热水器由三部分组成：热水器、警报器、显示器，它们来自于不同厂商并进行了组装。那么，应该是热水器仅仅负责烧水，它不能发出警报也不能显示水温；在水烧开时由警报器发出警报、显示器显示提示和水温。

这时候，上面的例子就应该变成这个样子：

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

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

警报器和显示器告诉热水器，它对它的温度比较感兴趣(注册)。
热水器知道后保留对警报器和显示器的引用。
热水器进行烧水这一动作，当水温超过95度时，通过对警报器和显示器的引用，自动调用警报器的MakeAlert()方法、显示器的ShowMsg()方法。

类似这样的例子是很多的，GOF对它进行了抽象，称为Observer设计模式：Observer设计模式是为了定义对象间的一种一对多的依赖关系，以便于当一个对象的状态改变时，其他依赖于它的对象会被自动告知并更新。Observer模式是一种松耦合的设计模式。

实现范例的Observer设计模式

我们之前已经对委托和事件介绍很多了，现在写代码应该很容易了，现在在这里直接给出代码，并在注释中加以说明。

1 using System; 2 using System.Collections.Generic; 3 using System.Text; 4 5 namespace Delegate { 6 // 热水器 7 public class Heater { 8 private int temperature; 9 public delegate void BoilHandler(int param); //声明委托10 public event BoilHandler BoilEvent; //声明事件11 12 // 烧水13 public void BoilWater() {14 for (int i = 0; i <=>100; i++) {15 temperature = i;16 17 if (temperature > 95) {18 if (BoilEvent != null) { //如果有对象注册19 BoilEvent(temperature); //调用所有注册对象的方法20 }21 }22 }23 }24 }25 26 // 警报器27 public class Alarm {28 public void MakeAlert(int param) {29 Console.WriteLine('Alarm：嘀嘀嘀，水已经 {0} 度了：', param);30 }31 }32 33 // 显示器34 public class Display {35 public static void ShowMsg(int param) { //静态方法36 Console.WriteLine('Display：水快烧开了，当前温度：{0}度。', param);37 }38 }39 40 class Program {41 static void Main() {42 Heater heater = new Heater();43 Alarm alarm = new Alarm();44 45 heater.BoilEvent += alarm.MakeAlert; //注册方法46 heater.BoilEvent += (new Alarm()).MakeAlert; //给匿名对象注册方法47 heater.BoilEvent += Display.ShowMsg; //注册静态方法48 49 heater.BoilWater(); //烧水，会自动调用注册过对象的方法50 }51 }52 }

输出为：
Alarm：嘀嘀嘀，水已经 96 度了：
Alarm：嘀嘀嘀，水已经 96 度了：
Display：水快烧开了，当前温度：96度。
// 省略...

.Net Framework中的委托与事件

尽管上面的范例很好地完成了我们想要完成的工作，但是我们不仅疑惑：为什么.Net Framework 中的事件模型和上面的不同？为什么有很多的EventArgs参数？

在回答上面的问题之前，我们先搞懂 .Net Framework的编码规范：

委托类型的名称都应该以EventHandler结束。
委托的原型定义：有一个void返回值，并接受两个输入参数：一个Object 类型，一个 EventArgs类型(或继承自EventArgs)。
事件的命名为委托去掉 EventHandler之后剩余的部分。
继承自EventArgs的类型应该以EventArgs结尾。

再做一下说明：

委托声明原型中的Object类型的参数代表了Subject，也就是监视对象，在本例中是 Heater(热水器)。回调函数(比如Alarm的MakeAlert)可以通过它访问触发事件的对象(Heater)。
EventArgs 对象包含了Observer所感兴趣的数据，在本例中是temperature。

上面这些其实不仅仅是为了编码规范而已，这样也使得程序有更大的灵活性。比如说，如果我们不光想获得热水器的温度，还想在Observer端(警报器或者显示器)方法中获得它的生产日期、型号、价格，那么委托和方法的声明都会变得很麻烦，而如果我们将热水器的引用传给警报器的方法，就可以在方法中直接访问热水器了。

现在我们改写之前的范例，让它符合 .Net Framework 的规范：

1 using System; 2 using System.Collections.Generic; 3 using System.Text; 4 5 namespace Delegate { 6 // 热水器 7 public class Heater { 8 private int temperature; 9 public string type = 'RealFire 001'; // 添加型号作为演示10 public string area = 'China Xian'; // 添加产地作为演示11 //声明委托12 public delegate void BoiledEventHandler(Object sender, BoiledEventArgs e);13 public event BoiledEventHandler Boiled; //声明事件14 15 // 定义BoiledEventArgs类，传递给Observer所感兴趣的信息16 public class BoiledEventArgs : EventArgs {17 public readonly int temperature;18 public BoiledEventArgs(int temperature) {19 this.temperature = temperature;20 }21 }22 23 // 可以供继承自 Heater 的类重写，以便继承类拒绝其他对象对它的监视24 protected virtual void OnBoiled(BoiledEventArgs e) {25 if (Boiled != null) { // 如果有对象注册26 Boiled(this, e); // 调用所有注册对象的方法27 }28 }29 30 // 烧水。31 public void BoilWater() {32 for (int i = 0; i <=>100; i++) {33 temperature = i;34 if (temperature > 95) {35 //建立BoiledEventArgs 对象。36 BoiledEventArgs e = new BoiledEventArgs(temperature);37 OnBoiled(e); // 调用 OnBolied方法38 }39 }40 }41 }42 43 // 警报器44 public class Alarm {45 public void MakeAlert(Object sender, Heater.BoiledEventArgs e) {46 Heater heater = (Heater)sender; //这里是不是很熟悉呢？47 //访问 sender 中的公共字段48 Console.WriteLine('Alarm：{0} - {1}: ', heater.area, heater.type);49 Console.WriteLine('Alarm: 嘀嘀嘀，水已经 {0} 度了：', e.temperature);50 Console.WriteLine();51 }52 }53 54 // 显示器55 public class Display {56 public static void ShowMsg(Object sender, Heater.BoiledEventArgs e) { //静态方法57 Heater heater = (Heater)sender;58 Console.WriteLine('Display：{0} - {1}: ', heater.area, heater.type);59 Console.WriteLine('Display：水快烧开了，当前温度：{0}度。', e.temperature);60 Console.WriteLine();61 }62 }63 64 class Program {65 static void Main() {66 Heater heater = new Heater();67 Alarm alarm = new Alarm();68 69 heater.Boiled += alarm.MakeAlert; //注册方法70 heater.Boiled += (new Alarm()).MakeAlert; //给匿名对象注册方法71 heater.Boiled += new Heater.BoiledEventHandler(alarm.MakeAlert); //也可以这么注册72 heater.Boiled += Display.ShowMsg; //注册静态方法73 74 heater.BoilWater(); //烧水，会自动调用注册过对象的方法75 }76 }77 }

输出为：
Alarm：China Xian - RealFire 001:
Alarm: 嘀嘀嘀，水已经 96 度了：
Alarm：China Xian - RealFire 001:
Alarm: 嘀嘀嘀，水已经 96 度了：
Alarm：China Xian - RealFire 001:
Alarm: 嘀嘀嘀，水已经 96 度了：
Display：China Xian - RealFire 001:
Display：水快烧开了，当前温度：96度。
// 省略 ...