委托、事件与Observer设计模式

范例说明

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

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

现在我们需要写个程序来模拟这个烧水的过程,我们将定义一个类来代表热水器,我们管它叫:Heater,它有代表水温的字段,叫做temperature;当然,还有必不可少的给水加热方法BoilWater(),一个发出语音警报的方法MakeAlert(),一个显示水温的方法,ShowMsg()。
  1. namespace Delegate {   
  2.        class Heater {   
  3.               private int temperature; // 水温   
  4.   
  5.               // 烧水   
  6.               public void BoilWater() {   
  7.                      for (int i = 0; i <= 100; i++) {   
  8.                             temperature = i;   
  9.   
  10.                             if (temperature > 95) {   
  11.                                    MakeAlert(temperature);   
  12.                                    ShowMsg(temperature);   
  13.                             }   
  14.                      }   
  15.               }   
  16.   
  17.               // 发出语音警报   
  18.               private void MakeAlert(int param) {   
  19.                      Console.WriteLine("Alarm:嘀嘀嘀,水已经 {0} 度了:" , param);   
  20.               }   
  21.                  
  22.               // 显示水温   
  23.               private void ShowMsg(int param) {   
  24.                      Console.WriteLine("Display:水快开了,当前温度:{0}度。" , param);   
  25.               }   
  26.        }   
  27.   
  28.        class Program {   
  29.               static void Main() {   
  30.                      Heater ht = new Heater();   
  31.                      ht.BoilWater();   
  32.               }   
  33.        }   
  34. }  

Observer设计模式简介

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

这时候,上面的例子就应该变成这个样子:       
  1. // 热水器   
  2. public class Heater {          
  3.               private int temperature;   
  4.                         
  5.               // 烧水   
  6.               private void BoilWater() {   
  7.                      for (int i = 0; i <= 100; i++) {   
  8.                             temperature = i;   
  9.                      }   
  10.               }   
  11.        }   
  12.   
  13.        // 警报器   
  14.        public class Alarm{   
  15.               private void MakeAlert(int param) {   
  16.                      Console.WriteLine("Alarm:嘀嘀嘀,水已经 {0} 度了:" , param);   
  17.               }   
  18.        }   
  19.   
  20.        // 显示器   
  21.        public class Display{   
  22.               private void ShowMsg(int param) {   
  23.                      Console.WriteLine("Display:水已烧开,当前温度:{0}度。" , param);   
  24.               }   
  25. }  

这里就出现了一个问题:如何在水烧开的时候通知报警器和显示器?在继续进行之前,我们先了解一下Observer设计模式,Observer设计模式中主要包括如下两类对象:

Subject:监视对象,它往往包含着其他对象所感兴趣的内容。在本范例中,热水器就是一个监视对象,它包含的其他对象所感兴趣的内容,就是temprature字段,当这个字段的值快到100时,会不断把数据发给监视它的对象。

Observer:监视者,它监视Subject,当Subject中的某件事发生的时候,会告知Observer,而Observer则会采取相应的行动。在本范例中,Observer有警报器和显示器,它们采取的行动分别是发出警报和显示水温。
在本例中,事情发生的顺序应该是这样的:
1.       警报器和显示器告诉热水器,它对它的温度比较感兴趣(注册)。
2.       热水器知道后保留对警报器和显示器的引用。
3.       热水器进行烧水这一动作,当水温超过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的编码规范:

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

再做一下说明:

1.委托声明原型中的Object类型的参数代表了Subject,也就是监视对象,在本例中是 Heater(热水器)。回调函数(比如Alarm的MakeAlert)可以通过它访问触发事件的对象(Heater)。
2.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, BoliedEventArgs e);   
  13.               public event BoiledEventHandler Boiled;       //声明事件   
  14.   
  15.               // 定义BoliedEventArgs类,传递给Observer所感兴趣的信息   
  16.               public class BoliedEventArgs : EventArgs {   
  17.                      public readonly int temperature;   
  18.                      public BoliedEventArgs(int temperature) {   
  19.                             this.temperature = temperature;   
  20.                      }   
  21.               }   
  22.   
  23.               // 可以供继承自 Heater 的类重写,以便继承类拒绝其他对象对它的监视   
  24.               protected virtual void OnBolied(BoliedEventArgs 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.                                    //建立BoliedEventArgs 对象。   
  36.                                    BoliedEventArgs e = new BoliedEventArgs(temperature);   
  37.                                    OnBolied(e);       // 调用 OnBolied方法   
  38.                             }   
  39.                      }   
  40.               }   
  41.        }   
  42.   
  43.        // 警报器   
  44.        public class Alarm {   
  45.               public void MakeAlert(Object sender, Heater.BoliedEventArgs 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.        // 显示器   
  56.        public class Display {   
  57.               public static void ShowMsg(Object sender, Heater.BoliedEventArgs e) {       //静态方法   
  58.                      Heater heater = (Heater)sender;   
  59.                      Console.WriteLine("Display:{0} - {1}: ", heater.area, heater.type);   
  60.                      Console.WriteLine("Display:水快烧开了,当前温度:{0}度。", e.temperature);   
  61.                      Console.WriteLine();   
  62.               }   
  63.        }   
  64.   
  65.        class Program {   
  66.               static void Main() {   
  67.                      Heater heater = new Heater();   
  68.                      Alarm alarm = new Alarm();   
  69.   
  70.                      heater.Boiled += alarm.MakeAlert;       //注册方法   
  71.                      heater.Boiled += (new Alarm()).MakeAlert;              //给匿名对象注册方法   
  72.                      heater.Boiled += new Heater.BoiledEventHandler(alarm.MakeAlert);       //也可以这么注册   
  73.                      heater.Boiled += Display.ShowMsg;              //注册静态方法   
  74.   
  75.                      heater.BoilWater();       //烧水,会自动调用注册过对象的方法   
  76.               }   
  77.        }   
  78. }  

输出为:
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度。
// 省略 ...