张子阳 TraceFact

Fire is the test of gold; adversity, of strong man.

  博客园 :: 首页 :: 新随笔 :: 联系 :: 订阅 订阅 :: 管理 ::
  44 随笔 :: 0 文章 :: 1018 评论 :: 56 Trackbacks
PDF 浏览:http://www.tracefact.net/Document/Delegates-and-Events-in-CSharp.pdf
源码下载:http://www.tracefact.net/sourcecode/delegates-and-events-in-csharp.rar

C# 中的委托和事件

引言

委托 和 事件在 .Net Framework中的应用非常广泛,然而,较好地理解委托和事件对很多接触C#时间不长的人来说并不容易。它们就像是一道槛儿,过了这个槛的人,觉得真是太容易了,而没有过去的人每次见到委托和事件就觉得心里别(biè)得慌,混身不自在。本文中,我将通过两个范例由浅入深地讲述什么是委托、为什么要使用委托、事件的由来、.Net Framework中的委托和事件、委托和事件对Observer设计模式的意义,对它们的中间代码也做了讨论。

将方法作为方法的参数

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

public void GreetPeople(string name) {
    // 做某些额外的事情,比如初始化之类,此处略
    EnglishGreeting(name);
}
public void EnglishGreeting(string name) {
    Console.WriteLine("Morning, " + name);
}

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

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

public void ChineseGreeting(string name){
    Console.WriteLine("早上好, " + name);
}

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

public enum Language{
    English, Chinese
}

public void GreetPeople(string name, Language lang){
    //做某些额外的事情,比如初始化之类,此处略
    swith(lang){
        case Language.English:
           EnglishGreeting(name);
           break;
       case Language.Chinese:
           ChineseGreeting(name);
           break;
    }
}

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

在考虑新的解决方案之前,我们先看看 GreetPeople的方法签名:

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参数应该是什么类型的?

NOTE:这里已不再需要枚举了,因为在给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参数的类型。

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

本例中委托的定义:

public delegate void GreetingDelegate(string name);

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

现在,让我们再次改动GreetPeople()方法,如下所示:

public void GreetPeople(string name, GreetingDelegate MakeGreeting){
    MakeGreeting(name);
}

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

using System;
using System.Collections.Generic;
using System.Text;

namespace Delegate {
     //定义委托,它定义了可以代表的方法的类型
     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);
               Console.ReadKey();
           }
        }
    }

输出如下:
Morning, Jimmy Zhang
早上好, 张子阳

我们现在对委托做一个总结:

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

将方法绑定到委托

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

static void Main(string[] args) {
    string name1, name2;
    name1 = "Jimmy Zhang";
    name2 = "张子阳";

     GreetPeople(name1, EnglishGreeting);
     GreetPeople(name2, ChineseGreeting);
    Console.ReadKey();
}

而既然委托GreetingDelegate 和 类型 string 的地位一样,都是定义了一种参数类型,那么,我是不是也可以这么使用委托?

static void Main(string[] args) {
    GreetingDelegate delegate1, delegate2;
    delegate1 = EnglishGreeting;
    delegate2 = ChineseGreeting;

    GreetPeople("Jimmy Zhang", delegate1);
        GreetPeople("张子阳", delegate2);
        Console.ReadKey();
}

如你所料,这样是没有问题的,程序一如预料的那样输出。这里,我想说的是委托不同于string的一个特性:可以将多个方法赋给同一个委托,或者叫将多个方法绑定到同一个委托,当调用这个委托的时候,将依次调用其所绑定的方法。在这个例子中,语法如下:

static void Main(string[] args) {
    GreetingDelegate delegate1;
    delegate1 = EnglishGreeting; // 先给委托类型的变量赋值
    delegate1 += ChineseGreeting;   // 给此委托变量再绑定一个方法

     // 将先后调用 EnglishGreeting 与 ChineseGreeting 方法
    GreetPeople("Jimmy Zhang", delegate1); 
    Console.ReadKey();
}

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

实际上,我们可以也可以绕过GreetPeople方法,通过委托来直接调用EnglishGreeting和ChineseGreeting:

static void Main(string[] args) {
    GreetingDelegate delegate1;
    delegate1 = EnglishGreeting; // 先给委托类型的变量赋值
    delegate1 += ChineseGreeting;   // 给此委托变量再绑定一个方法

    // 将先后调用 EnglishGreeting 与 ChineseGreeting 方法
    delegate1 ("Jimmy Zhang");  
    Console.ReadKey();
}

 

NOTE:这在本例中是没有问题的,但回头看下上面GreetPeople()的定义,在它之中可以做一些对于EnglshihGreeting和ChineseGreeting来说都需要进行的工作,为了简便我做了省略。

注意这里,第一次用的“=”,是赋值的语法;第二次,用的是“+=”,是绑定的语法。如果第一次就使用“+=”,将出现“使用了未赋值的局部变量”的编译错误。

我们也可以使用下面的代码来这样简化这一过程:

GreetingDelegate delegate1 = new GreetingDelegate(EnglishGreeting);
delegate1 += ChineseGreeting;   // 给此委托变量再绑定一个方法

看到这里,应该注意到,这段代码第一条语句与实例化一个类是何其的相似,你不禁想到:上面第一次绑定委托时不可以使用“+=”的编译错误,或许可以用这样的方法来避免:

GreetingDelegate delegate1 = new GreetingDelegate();
delegate1 += EnglishGreeting;   // 这次用的是 “+=”,绑定语法。
delegate1 += ChineseGreeting;   // 给此委托变量再绑定一个方法

但实际上,这样会出现编译错误: “GreetingDelegate”方法没有采用“0”个参数的重载。尽管这样的结果让我们觉得有点沮丧,但是编译的提示:“没有0个参数的重载”再次让我们联想到了类的构造函数。我知道你一定按捺不住想探个究竟,但再此之前,我们需要先把基础知识和应用介绍完。

既然给委托可以绑定一个方法,那么也应该有办法取消对方法的绑定,很容易想到,这个语法是“-=”:

static void Main(string[] args) {
    GreetingDelegate delegate1 = new GreetingDelegate(EnglishGreeting);
    delegate1 += ChineseGreeting;   // 给此委托变量再绑定一个方法

    // 将先后调用 EnglishGreeting 与 ChineseGreeting 方法
    GreetPeople("Jimmy Zhang", delegate1); 
    Console.WriteLine();

    delegate1 -= EnglishGreeting; //取消对EnglishGreeting方法的绑定
    // 将仅调用 ChineseGreeting
    GreetPeople("张子阳", delegate1);
    Console.ReadKey();
}
输出为:
Morning, Jimmy Zhang
早上好, Jimmy Zhang
早上好, 张子阳

让我们再次对委托作个总结:

使用委托可以将多个方法绑定到同一个委托变量,当调用此变量时(这里用“调用”这个词,是因为此变量代表一个方法),可以依次调用所有绑定的方法。

事件的由来

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

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) {
           // ... ...
        }
    }
}

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

static void Main(string[] args) {
    GreetingManager gm = new  GreetingManager();
    gm.GreetPeople("Jimmy Zhang", EnglishGreeting);
    gm.GreetPeople("张子阳", ChineseGreeting);
}

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

Morning, Jimmy Zhang

早上好, 张子阳

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

static void Main(string[] args) {
    GreetingManager gm = new  GreetingManager();
    GreetingDelegate delegate1;
    delegate1 = EnglishGreeting;
    delegate1 += ChineseGreeting;

    gm.GreetPeople("Jimmy Zhang", delegate1);
}

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

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

public class GreetingManager{
    //在GreetingManager类的内部声明delegate1变量
    public GreetingDelegate delegate1; 

    public void GreetPeople(string name, GreetingDelegate MakeGreeting) {
       MakeGreeting(name);
    }
}

现在,我们可以这样使用这个委托变量:

static void Main(string[] args) {
    GreetingManager gm = new  GreetingManager();
    gm.delegate1 = EnglishGreeting;
    gm.delegate1 += ChineseGreeting;

    gm.GreetPeople("Jimmy Zhang", gm.delegate1);
}

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

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

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

既然如此,我们何不修改 GreetingManager 类成这样:

public class GreetingManager{
    //在GreetingManager类的内部声明delegate1变量
    public GreetingDelegate delegate1; 

    public void GreetPeople(string name) {
        if(delegate1!=null){     //如果有方法注册委托变量
          delegate1(name);      //通过委托调用方法
       }
    }
}

在客户端,调用看上去更简洁一些:

static void Main(string[] args) {
    GreetingManager gm = new  GreetingManager();
    gm.delegate1 = EnglishGreeting;
    gm.delegate1 += ChineseGreeting;

    gm.GreetPeople("Jimmy Zhang");      //注意,这次不需要再传递 delegate1变量
}

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

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

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

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

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

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

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

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

我们改写GreetingManager类,它变成了这个样子:

public class GreetingManager{
    //这一次我们在这里声明一个事件
    public event GreetingDelegate MakeGreet;

    public void GreetPeople(string name) {
        MakeGreet(name);
    }
}

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

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

static void Main(string[] args) {
    GreetingManager gm = new  GreetingManager();
    gm.MakeGreet = EnglishGreeting;         // 编译错误1
    gm.MakeGreet += ChineseGreeting;

    gm.GreetPeople("Jimmy Zhang");
}

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

事件和委托的编译代码

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

public event GreetingDelegate MakeGreet;

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

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

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。而这两个方法的访问限制取决于声明事件时的访问限制符。

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

public delegate void GreetingDelegate(string name);

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

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

 

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

委托、事件与Observer设计模式

范例说明

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

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

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

namespace Delegate {
    class Heater {
    private int temperature; // 水温
    // 烧水
    public void BoilWater() {
        for (int i = 0; i <= 100; i++) {
           temperature = i;

           if (temperature > 95) {
               MakeAlert(temperature);
               ShowMsg(temperature);
            }
        }
    }

    // 发出语音警报
    private void MakeAlert(int param) {
       Console.WriteLine("Alarm:嘀嘀嘀,水已经 {0} 度了:" , param);
    }
   
    // 显示水温
    private void ShowMsg(int param) {
       Console.WriteLine("Display:水快开了,当前温度:{0}度。" , param);
    }
}

class Program {
    static void Main() {
       Heater ht = new Heater();
       ht.BoilWater();
    }
}
}

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设计模式中主要包括如下两类对象:

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

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

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

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

实现范例的Observer设计模式

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

using System;
using System.Collections.Generic;
using System.Text;

namespace Delegate {
    // 热水器
    public class Heater {
       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);  //调用所有注册对象的方法
                  }
              }
           }
       }
    }

    // 警报器
    public class Alarm {
       public void MakeAlert(int param) {
           Console.WriteLine("Alarm:嘀嘀嘀,水已经 {0} 度了:", param);
       }
    }

    // 显示器
    public class Display {
       public static void ShowMsg(int param) { //静态方法
           Console.WriteLine("Display:水快烧开了,当前温度:{0}度。", param);
       }
    }
   
    class Program {
       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();   //烧水,会自动调用注册过对象的方法
       }
    }
}
输出为:
Alarm:嘀嘀嘀,水已经 96 度了:
Alarm:嘀嘀嘀,水已经 96 度了:
Display:水快烧开了,当前温度:96度。
// 省略...

.Net Framework中的委托与事件

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

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

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

再做一下说明:

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

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

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

using System;
using System.Collections.Generic;
using System.Text;

namespace Delegate {
    // 热水器
    public class Heater {
       private int temperature;
       public string type = "RealFire 001";       // 添加型号作为演示
       public string area = "China Xian";         // 添加产地作为演示
       //声明委托
       public delegate void BoiledEventHandler(Object sender, BoiledEventArgs e);
       public event BoiledEventHandler Boiled; //声明事件

       // 定义BoiledEventArgs类,传递给Observer所感兴趣的信息
       public class BoiledEventArgs : EventArgs {
           public readonly int temperature;
           public BoiledEventArgs(int temperature) {
              this.temperature = temperature;
           }
       }

       // 可以供继承自 Heater 的类重写,以便继承类拒绝其他对象对它的监视
       protected virtual void OnBoiled(BoiledEventArgs e) {
           if (Boiled != null) { // 如果有对象注册
              Boiled(this, e);  // 调用所有注册对象的方法
           }
       }
      
       // 烧水。
       public void BoilWater() {
           for (int i = 0; i <= 100; i++) {
              temperature = i;
              if (temperature > 95) {
                  //建立BoiledEventArgs 对象。
                  BoiledEventArgs e = new BoiledEventArgs(temperature);
                  OnBoiled(e);  // 调用 OnBolied方法
              }
           }
       }
    }

    // 警报器
    public class Alarm {
       public void MakeAlert(Object sender, Heater.BoiledEventArgs e) {
           Heater heater = (Heater)sender;     //这里是不是很熟悉呢?
           //访问 sender 中的公共字段
           Console.WriteLine("Alarm:{0} - {1}: ", heater.area, heater.type);
           Console.WriteLine("Alarm: 嘀嘀嘀,水已经 {0} 度了:", e.temperature);
           Console.WriteLine();
       }
    }

    // 显示器
    public class Display {
       public static void ShowMsg(Object sender, Heater.BoiledEventArgs e) {   //静态方法
           Heater heater = (Heater)sender;
           Console.WriteLine("Display:{0} - {1}: ", heater.area, heater.type);
           Console.WriteLine("Display:水快烧开了,当前温度:{0}度。", e.temperature);
           Console.WriteLine();
       }
    }

    class Program {
       static void Main() {
           Heater heater = new Heater();
           Alarm alarm = new Alarm();

           heater.Boiled += alarm.MakeAlert;   //注册方法
           heater.Boiled += (new Alarm()).MakeAlert;      //给匿名对象注册方法
           heater.Boiled += new Heater.BoiledEventHandler(alarm.MakeAlert);    //也可以这么注册
           heater.Boiled += Display.ShowMsg;       //注册静态方法

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

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

总结

在本文中我首先通过一个GreetingPeople的小程序向大家介绍了委托的概念、委托用来做什么,随后又引出了事件,接着对委托与事件所产生的中间代码做了粗略的讲述。

在第二个稍微复杂点的热水器的范例中,我向大家简要介绍了 Observer设计模式,并通过实现这个范例完成了该模式,随后讲述了.Net Framework中委托、事件的实现方式。

希望这篇文章能给你带来帮助。

posted on 2007-09-23 17:49 Jimmy Zhang 阅读(25940) 评论(276)  编辑 收藏 所属分类: C# Programming
评论共2页: 1 2 下一页 

评论

你比我们老师将得好多了,
谢谢
  回复  引用    

#2楼 [楼主] 2007-10-15 13:29 张子阳.      
@ckr

我把4个文件全都重新运行了一遍,没发现问题,运行环境是:VS2005(.Net Framework 2.0) + Windows Server2003

不好意思,其他人也没有出现类似情况,我也不太清楚为什么你编译会报错。


  回复  引用  查看    

#3楼 [楼主] 2007-10-15 13:33 张子阳.      
@anywhere

谢谢你对这篇文章的肯定。

关于索引器,很抱歉,我暂时不打算写,你也看到了,系列开得很多了,但大多只有个Part1或者Part2。发布《对象关系映射》后,我已经觉得很草率了。现在只想写《Asp.Net构架》这个系列 以及 有助于理解这个系列的相关文章。

  回复  引用  查看    

#4楼  2007-10-17 21:39 Q小小池 [未注册用户]
Observer模式是一种松耦合的设计模式。
在文件章里讲的不是很清楚,能更具的一体吗?能像委托一样介绍就好了。
  回复  引用    

#5楼 [楼主] 2007-10-18 10:47 张子阳.      
@Q小小池

对于Observer模式,后面热水器的范例应该算是比较清楚的了啊。关于Observer的介绍是比较简略,那是因为本文着重讲述委托和事件。
  回复  引用  查看    

#6楼  2007-10-24 16:58 jisen      
不错!觉得那个热水器的例子正中要害,谢谢搂z!
  回复  引用  查看    

#7楼  2007-10-24 19:39 yizhu2000 [未注册用户]
请教楼主是用什么工具看到delegate被编译的类的?reflector能看到IL,但是楼主可以看到c#代码,用的什么工具啊
  回复  引用    

#8楼  2007-10-24 22:11 生生 [未注册用户]
说得还可以.比较明白.看了你这篇文章对委托和事件又了解了深入一点了.
我看得很合我的品味.觉得不错.希望发点发表文章.
  回复  引用    

#9楼 [楼主] 2007-10-25 13:38 张子阳.      
@yizhu2000

我用的就是 reflector 呀。
  回复  引用  查看    

#10楼  2007-10-25 21:11 see2you [未注册用户]
前两天看到这篇文章,收藏了。今天拜读一下受益匪浅,好文章!!继续关注。谢谢,楼主!!!
  回复  引用    

#11楼  2007-11-01 10:28 光头小松鼠      
谢谢博主,我准备仔细研究,争取尽快过了这一门槛!
  回复  引用  查看    

#12楼  2007-11-01 10:45 光头小松鼠      
呵呵,我把不用委托实现问候的话给贴上来了,博主勿怪
using System;
using System.Collections.Generic;

public class DelegateEvent
{
public enum Language
{
Chinese,English
}
public static void greetPeople(string name,Language lang)
{
switch(lang.ToString())
{
case "Chinese":
ChineseGreet(name);
break;
case "English":
EnglishGreet(name);
break;
}
}

public static void EnglishGreet(string name)
{
Console.WriteLine("Hello "+name);
}

public static void ChineseGreet(string name)
{
Console.WriteLine("你好 "+name);
}

public static void Main()
{
Language lang=Language.Chinese;
greetPeople("北京",lang);
Console.ReadLine();
}
}
  回复  引用  查看    

#13楼  2007-11-01 15:00 阿多斯      
很好的文章啊。我觉得你提供pdf版下载的方法很好,毕竟不是每个人都喜欢在线阅读的,有份电子版的放在硬盘上方便得多。就怕cnblog没有这么多空间啊,吓吓...
  回复  引用  查看    

#14楼 [楼主] 2007-11-01 18:06 张子阳.      
@阿多斯

呵呵,嗯!有的人是不喜欢在线阅读。
还有就是Word排版更方便、快捷一些,在这里我只是简单粘贴一下就好了。

空间没有问题的啦,我还有ftp的。


  回复  引用  查看    

#15楼  2007-11-08 17:46 sanyecao [未注册用户]
写的很好,浅显易懂,明白了委托,多谢楼主!!!!
  回复  引用    

#16楼  2007-11-09 21:33 Peter_joe [未注册用户]
受益非浅啊!表面看还真是想不到,通过编译中的内存分析,才慢慢理解。
  回复  引用    

#17楼  2007-11-11 00:53 Ryen_lee      
写得精彩啊,解了我的燃眉之急!
  回复  引用  查看    

#18楼  2007-11-11 16:39 Lisa [未注册用户]
Hi Jimmy:
You did good job.
Thanks!
  回复  引用    

#19楼  2007-11-12 19:56 chance1 [未注册用户]
看了几次,有点感觉了。写的非常好。
  回复  引用    

#20楼  2007-11-13 16:23 Yucj [未注册用户]
博主,第一段代码,在VS2003下会报错,2005下没问题,为什么呢?
  回复  引用    

#21楼  2007-11-14 01:16 lv_Sally [未注册用户]
好文章,太有助于理解了!
  回复  引用    

#22楼 [楼主] 2007-11-14 08:25 张子阳.      
@Yucj

是热水器的第一种实现,还是问候的第一种实现,我没在vs2003下调试,编译器报得什么错呢? 把错误信息发上来好么
  回复  引用  查看    

#23楼  2007-11-14 10:08 lv_Sally [未注册用户]
WPF下的Event Mode不是这样了吧?
  回复  引用    

#24楼 [楼主] 2007-11-14 13:29 张子阳.      
@lv_Sally

WPF 还没有学习过···
  回复  引用  查看    

#25楼  2007-11-14 15:38 Yucj [未注册用户]
博主,首先感谢你的回复。
我说的编译有错,就是第一段最简单的那个早上好的例子,在VS2003下报
GreetPeople("Jimmy Zhang", EnglishGreeting); 错误:方法EnglishGreeting没有带参数

66楼的朋友也提到了。
我在2005下试没问题,但是2003下就不行。因为没用过2005,工作中用2003,所以不太了解其中的奥秘。

  回复  引用    

#26楼 [楼主] 2007-11-14 19:17 张子阳.      
@Yucj

我没有装Vs2003,所以没调试,但我估计是因为2003下不允许这样隐式的传递方法变量,必须显式地把它实例化成委托变量。

当直接写 GreetPeople("Jimmy Zhang", EnglishGreeting); 的时候,编译器不认为 EnglisghGreeting 是一个委托变量,而把当它成是一个普通的方法进行处理。此时 GreetPeople 方法认为它的第二个参数是 EnglishGreeting 的返回值。而 EnglishGreeting 这个方法的调用格式不对,它没有参数,于是告诉你:该方法没有参数。

如果想成功,我想是要这样写,你可以试一下:

GreetPeople("Jimmy Zhang", new GreetingDelegate(EnglishGreeting));


  回复  引用  查看    

#27楼  2007-11-15 10:12 Yucj [未注册用户]
非常感谢Jimmy,GreetPeople("Jimmy Zhang", new GreetingDelegate(EnglishGreeting)); 已经解决了编译出错的问题了。继续拜读你的大作了,哈哈。
  回复  引用    

#28楼  2007-11-15 19:39 jasoncs [未注册用户]
感激涕零,如果文章都这样写就好了
  回复  引用    

谢谢楼主的文章,真是太好了!!
  回复  引用    

#30楼  2007-11-16 14:03 jammon [未注册用户]
通俗易动,深入浅出..太好拉
  回复  引用    

#31楼  2007-11-16 14:48 Lisa Tian [未注册用户]
Hi Jimmy or net C# developers:
How C# project or solution deal with Garbage Collection case. Do we have to design garbage case by our self or VS 2005 auto clean.
Can you point out to very detail : How garbage come out and when we have to face to deal with it. Thanks!
  回复  引用    

能不能做一篇关于线程的的技术指导。。
  回复  引用    

#33楼 [楼主] 2007-11-20 08:35 张子阳.      
@强总是我

最近很忙,有时间了会考虑

  回复  引用  查看    

感谢回复。。文章不错我喜欢。。会常来的。。@张子阳.

  回复  引用    

#35楼  2007-11-21 13:30 夏林 [未注册用户]
谢谢,帮助很多
  回复  引用    

#36楼 [楼主] 2007-11-21 14:48 张子阳.      
@Lisa Tian

I am sorry that I do not know much about garbage collection, so I am not sure about the question you asked.

  回复  引用  查看    

#37楼  2007-11-22 10:29 jack1 [未注册用户]
大哥,写得太好了!!!!!!!!!
  回复  引用    

#38楼  2007-11-22 10:31 jack2 [未注册用户]
楼上那位说英语的朋友,你是不是闲心太多,竟操用不着的心.回收机制由framework自己管,绝大多数情况下不用我们操心的!!!!
  回复  引用    

#39楼  2007-11-22 16:00 waltor [未注册用户]
很好,有很大的帮助,谢谢拉
  回复  引用    

#40楼  2007-11-22 17:46 Lisa Tian [未注册用户]
@张子阳.
Thanks for the feedback. Me too. But I be asked the question in job interview time. I feel hard to answer it. I will check Google also.

  回复  引用    

#41楼  2007-11-22 17:54 Lisa Tian [未注册用户]
@jack2
Thanks Jack2. It is very good answer to regular case. But some case may need to work on it in application. sorry I do not have Chinese word software in my pc yet.
  回复  引用    

#42楼  2007-11-22 18:03 Lisa Tian [未注册用户]
Happy Thanksgivig to all C# Developers in here.
  回复  引用    

感谢之至,明白许多。
  回复  引用    

感谢楼主,总算稍微明白了这些是什么东东
  回复  引用    

楼主写的很好,还提供PDF版下载,中国就缺乏这样的好人才,有些人也许是大师级的人物了,这篇文章帮不了你,你也没必要出口不逊,毕竟你没有像楼主这样为菜鸟的技术进步作出了贡献!
  回复  引用    

#46楼  2007-11-26 23:07 一笑~      
写的很好.我学C#最难的就是在委托\事件这里.看了明白了很多.谢谢!
楼主再多谢点好东东,很多初学者很需要,包括在官方上都找不到澄清一些概念.你真是我们初学福音啊!
  回复  引用  查看    

C#开发网站有巨大的优势哦,我喜欢
  回复  引用    

#48楼  2007-11-27 13:29 史向平 [未注册用户]
看了这个文章后,我还是没明白为什么要使用委托
比如你提的问候的问题,很明显各种语言的问候方法你都写了,那我在调用的时候直接调用不行了,你在使用委托的时候不还是需要把各个方法对应的绑定到委托变量中去,我能找到他们作对应,就不能找到他们直接调用?
如果楼主能找个合适例子回答我这个问题,我万分感激!!!
  回复  引用    

#49楼  2007-11-27 17:25 ServerLandon      
Best article about introducing delegate and event I have ever read.

For somebody whose foot just cross the door, really really excellent.
  回复  引用  查看    

#50楼  2007-11-28 08:38 MYC [未注册用户]
namespace myTreeView
{
class TreeView : System.Windows.Forms.TreeView
{
......
public System.Windows.Forms.TreeView Tv_Tree;
......
public bool UpdateTree()
{
TreeNode RootNode = new TreeNode();
......
Tv_Tree.Nodes.Add(RootNode);
}
}
}
我有这么一个自定义组件,但是在外部程序绑定 ImageList 的时候,节点图片显示不了,我觉得是 ImageList 没绑定到 Tv_Tree 上,但是不知道该怎么做,在此请教各位热心的朋友.


  回复  引用    

#51楼  2007-11-28 19:37 葛强 [未注册用户]
写的好!
  回复  引用    

#52楼  2007-11-29 12:06 ithurricane      
很好的文章,仔细学习了

  回复  引用  查看    

文章后面部分写得不是很详细,这编文章很适合初学者,在继续EventArgs类上能否再深入点呢?还有事件和委托连的相似地方可以稍微的切入讲下吗?给我感觉事件本身就是一个委托链,去掉Event之后就成了委托链的声明了
  回复  引用    

#54楼  2007-11-30 14:21 闭上眼睛想谁-      
以前只简单应用过.Net FrameWork中的委托 对事件的应用不是很明白 重读了一遍楼主的文章 感觉深入多了
有一篇“组件和控件开发”是你写的吗 那个也不错 再详细些或做个实例供下载就好了
  回复  引用  查看    

写得非常好,搞了几天没有明白委托和事件的意思,看了博主的文章后受益非浅,希望能写出更好的文章给初学者!
  回复  引用    

#56楼 [楼主] 2007-12-02 19:45 张子阳.      
@史向平

如果在执行各个语言版本的问候之前需要都进行一系列的其他操作呢?这些操作对每个问候方法都是相同的,难道在每个语言版本的方法中把这些操作重写一遍么?就算你这么做了,如果现在要求这些公共操作每月都会有更新,你要全部重写一遍么?

你可能没看清我代码注释里的说明:

public void GreetPeople(string name, Language lang){

//做某些额外的事情,比如初始化之类,此处略 <-- 请注意这里
swith(lang){
case Language.English:
EnglishGreeting(name);
break;
case Language.Chinese:
ChineseGreeting(name);
break;
}
}

在 GreetPeople 中可以执行一些对于每个具体的问候方法都存在的额外的操作。

另外,委托并不是只有注册这种使用方式或者说功能,声明好一个委托后,你可以直接将符合此委托声明的方法当作委托类型的变量来传递到另一个方法当中!


  回复  引用  查看    

#57楼 [楼主] 2007-12-02 20:12 张子阳.      
@哎呀姐姐

个人觉得前面部分写详细些,理解了以后,后半部分是前面的一个应用和深入,不用太细致应该就能明白,所以就没有做太多文字说明,直接写到代码注释了。

EventArgs 是对于订阅者(Observer端)所感兴趣的数据进行的一个封装。可以这么想,当写某个方法时,需要给它传递若干个参数(个数不定),这样方法的声明就会很麻烦,你可能要写三个参数,或者5个,或者更多,但是如果你把这些参数封装到一个对象中,传递参数的时候,传递这个对象,那么你只需要一个参数就可以了。
你完全可以不继承EventArgs来实现这个功能,但是继承它更加符合.Net的规范。

实际上,热水器例子的委托类型完全可以不用声明,而使用.Net Framework 已经提供的声明,这个声明在System命名空间下面:
public delegate void EventHandler (Object sender,EventArgs e)

声明事件的时候,也只要这样写就可以了:public event EventHandler Boiled;

事件是对委托变量的封装,本质上并没有什么太大区别,只是使得对委托的使用更方便一些,所以你的理解并不错。



  回复  引用  查看    

#58楼 [楼主] 2007-12-02 20:13 张子阳.      
@闭上眼睛想谁-

你说的那个控件和组件开发的文章不是我写的 :-)

  回复  引用  查看    

#59楼  2007-12-03 15:07 马可香蕉      
不错的文章
  回复  引用  查看