引言
委托和事件在 .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可以代表的方法 的 参数类型和祷乩嘈汀?br /> 于是,委托出现了:它定义了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();
- }
以下为引用的内容:
- static void Main(string[] args)
- {
- GreetingDelegate delegate1, delegate2;
- delegate1 = EnglishGreeting;
- delegate2 = ChineseGreeting;
- GreetPeople("Jimmy Zhang", delegate1);
- GreetPeople("张子阳", delegate2);
- Console.ReadKey();
- }
以下为引用的内容:
- 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();
- }
注意这里,第一次用的“=”,是赋值的语法;第二次,用的是“+=”,是绑定的语法。如果第一次就使用“+=”,将出现“使用了未赋值的局部变量”的编译错误。
我们也可以使用下面的代码来这样简化这一过程:
- GreetingDelegate delegate1 = new GreetingDelegate(EnglishGreeting);
- delegate1 += ChineseGreeting; // 给此委托变量再绑定一个方法
看到这里,应该注意到,这段代码第一条语句与实例化一个类是何其的相似,你不禁想到:上面第一次绑定委托时不可以使用“+=”的编译错误,或许可以用这样的方法来避免:
- GreetingDelegate delegate1 = new GreetingDelegate();
- delegate1 += EnglishGreeting; // 这次用的是 “+=”,绑定语法。
- delegate1 += ChineseGreeting; // 给此委托变量再绑定一个方法
既然给委托可以绑定一个方法,那么也应该有办法取消对方法的绑定,很容易想到,这个语法是“-=”:
以下为引用的内容:- 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);
- }
尽管这样达到了我们要的效果,但是似乎并不美气,光是第一个方法注册用“=”,第二个用“+=”就让人觉得别扭。此时,轮到Event出场了,C# 中可以使用事件来专门完成这项工作,我们改写GreetingManager类,它变成了这个样子:
以下为引用的内容:
- public class GreetingManager
- {
- //这一次我们在这里声明一个事件
- public event GreetingDelegate MakeGreet;
- public void GreetPeople(string name, GreetingDelegate MakeGreeting)
- {
- MakeGreeting(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", gm.MakeGreet);
- //编译错误2
- }
这次,你会得到编译错误:事件“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#》等相关书籍,这里就不再讨论了。