C#delegate用法和用户自定义事件

Delegate
委托可以理解为c#中函数类，命名空间下的所有属性和字段都是封装在类中的，具有相同签名的函数也可以归纳为一个类，这就是委托的作用，delegate指定一个签名实际就是指定此签名函数所属类的名称，有了类名 就可以声明一个实例对象，初始化对象可以使用任意一个相同签名的函数名，调用这个实例对象就可以调用对应的函数。委托绑定“+=”在函数有形参和返回值的情况下作用不大，因为他对所有的函数传入的是同一个实参，这个功能多用于无返回无实参的情况，还有就是事件结构
delegate是C#中的一种类型，它实际上是一个能够持有对某个方法的引用的类。与其它的类不同，delegate类能够拥有一个签名（signature），并且它"只能持有与它的签名相匹配的方法的引用"。它所实现的功能与C/C++中的函数指针十分相似。它允许你传递一个类A的方法m给另一个类B的对象，使得类B的对象能够调用这个方法m。但与函数指针相比，delegate有许多函数委托和事件在 .Net Framework中的应用非常广泛指针不具备的优点。首先，函数指针只能指向静态函数，而delegate既可以引用静态函数，又可以引用非静态成员函数。在引用非静态成员函数时，delegate不但保存了对此函数入口指针的引用，而且还保存了调用此函数的类实例的引用。其次，与函数指针相比，delegate是面向对象、类型安全、可靠的受控（managed）对象。也就是说，runtime能够保证delegate指向一个有效的方法，你无须担心delegate会指向无效地址或者越界地址。

实现一个delegate是很简单的，通过以下3个步骤即可实现一个delegate：
1． 声明一个delegate对象，它应当与你想要传递的方法具有相同的参数和返回值类型。
2． 创建delegate对象，并"将你想要传递的函数作为参数传入"。
3． 在要实现异步调用的地方，通过上一步创建的对象来调用方法。
using System;

public class MyDelegateTest
{
// 步骤1，声明delegate对象
public delegate void MyDelegate(string name);

// 这是我们欲传递的方法，它与MyDelegate具有相同的参数和返回值类型
public static void MyDelegateFunc(string name)
{
Console.WriteLine("Hello, ", name);
}
public static void Main()
{
// 步骤2，创建delegate对象(实例？？)
MyDelegate md = new MyDelegate(MyDelegateTest.MyDelegateFunc);
// 步骤3，调用delegate
md("sam1111");
}
}
输出结果是：Hello, sam1111

了解了delegate，下面我们来看看，在C#中对事件是如何处理的。

C#中的事件处理实际上是一种具有特殊签名的delegate，象下面这个样子：
public delegate void MyEventHandler(object sender, MyEventArgs e);
其中的两个参数，sender代表事件发送者，e是事件参数类。MyEventArgs类用来包含与事件相关的数据，所有的事件参数类都必须从System.EventArgs类派生。当然，如果你的事件不含参数，那么可以直接用System.EventArgs类作为参数。

就是这么简单，结合delegate的实现，我们可以将自定义事件的实现归结为以下几步：
1．定义delegate对象类型，它有两个参数，第一个参数是事件发送者对象，第二个参数是事件参数类对象。
2．定义事件参数类，此类应当从System.EventArgs类派生。如果事件不带参数，这一步可以省略。
3．定义"事件处理方法，它应当与delegate对象具有相同的参数和返回值类型"。
4．用event关键字定义事件对象，它同时也是一个delegate对象。
5．用+=操作符添加事件到事件队列中（-=操作符能够将事件从队列中删除）。
6．在需要触发事件的地方用调用delegate的方式写事件触发方法。一般来说，此方法应为protected访问限制，既不能以public方式调用，但可以被子类继承。名字是OnEventName。
7． 在适当的地方调用事件触发方法触发事件。

下面是一个简单的例子：

using System;
public class EventTest
{
// 步骤1，定义delegate对象
public delegate void MyEventHandler(object sender, System.EventArgs e);
// 步骤2（定义事件参数类）省略
public class MyEventCls
{
// 步骤3，定义事件处理方法，它与delegate对象具有相同的参数和返回值类型
public void MyEventFunc(object sender, System.EventArgs e)
{
Console.WriteLine("My event is ok!");
}
}
// 步骤4，用event关键字定义事件对象
private event MyEventHandler myevent;
private MyEventCls myecls;
public EventTest()
{
myecls = new MyEventCls();
// 步骤5，用+=操作符将事件添加到队列中
this.myevent += new MyEventHandler(myecls.MyEventFunc);
}
// 步骤6，以调用delegate的方式写事件触发函数
protected void OnMyEvent(System.EventArgs e)
{
if(myevent != null)
myevent(this, e);
}
public void RaiseEvent()
{
EventArgs e = new EventArgs();
// 步骤7，触发事件
OnMyEvent(e);
}
public static void Main()
{
EventTest et = new EventTest();
Console.Write("Please input ''a'':");
string s = Console.ReadLine();
if(s == "a")
{
et.RaiseEvent();
}
else
{
Console.WriteLine("Error");
}
}
}
输出结果如下，红色为用户的输入：
Please input ‘a’: a
My event is ok!

分分钟用上C#中的委托和事件

每一个初学C#的程序猿，在刚刚碰到委托和事件的概念时，估计都是望而却步，茫然摸不到头脑的。百度一搜，关于概念介绍的文章大把大把的，当然也不乏深入浅出的好文章。可看完这些文章，大多数新手，估计也只是信心满满的觉得自己看懂了，一旦要在自己的程序中用上委托和事件，就傻眼了，根本不知道什么情况下该用，也不知道具体怎么用。本文没有任何概念介绍，旨在帮助同学们快速用上委托和事件，进入C#的更高境界。首先，我们需要知道，到底在什么情况下必须使用委托和事件呢？
请看下面的场景：首领A要搞一场鸿门宴，吩咐部下B和C各自带队埋伏在屏风两侧，约定以杯为令：若左手举杯，则B带队杀出；若右手举杯，则C带队杀出；若直接摔杯，则B和C同时杀出。B和C袭击的具体方法，首领A并不关心。(完整代码在全文最后。)有脑子反应快的同学，马上说，这个逻辑，用一个IF条件判断语句不就搞定了吗：

1 if(左手举杯)
2 {
3   B带队杀出;
4 }
5 else if(右手举杯)
6 {
7   C带队杀出;
8 }
9 else if(直接摔杯)
10 {
11   B带队杀出;
12   C带队杀出;
13 }
14 else
15 {
16   按兵不动
17 }

如果真这么简单，那我还写这篇文章干嘛呢。请这位同学认真想想：首领A会什么时候发出信号呢？估计连他自己都不知道。那么上面这段伪码，你打算插入到哪里呢？难道B和C就一直不停的用While循环做上述判断吗？显然不合适吧。更重要的，如果扩展一下，部下不止B和C，而是B、C、D、E等等，每个人都有自己不同的响应领导号召的方法，那么对首领A而言，要分别去跟每个部下打交道，上述的伪码，会进行无尽的扩展和完善，显然也不是我们所希望的。正确的逻辑应该是，B和C不管宴席上发生的任何其他事情，只等首领发出举杯或者摔杯的信号，一旦首领A发出信号，相当于通知了所有部下，凡是约定好的部下，都立马各自行动！我们定义三个类，分别模拟首领A和部下B、C：

/// <summary>
/// 首领A
/// </summary>
public class A
{

}
/// <summary>
/// 部下B
/// </summary>
public class B
{

}
/// <summary>
/// 部下C
/// </summary>
public class C
{

}

首领A的类有举杯和摔杯两种方法，其中，举杯方法带有一个形参，用于传递是左手举杯，还是右手举杯。部下B和C的类，各自有一种攻击方法。

/// <summary>
/// 首领A
/// </summary>
public class A
{
/// <summary>
/// 举杯
/// </summary>
/// <param name="hand">手：左、右</param>
public void Raise(string hand)
{
Console.WriteLine("首领A{0}手举杯", hand);
}
/// <summary>
/// 摔杯
/// </summary>
public void Fall()
{
Console.WriteLine("首领A摔杯");
}
}
/// <summary>
/// 部下B
/// </summary>
public class B
{
/// <summary>
/// 攻击
/// </summary>
public void Attack()
{
Console.WriteLine("部下B发起攻击");
}
}
/// <summary>
/// 部下C
/// </summary>
public class C
{
/// <summary>
/// 攻击
/// </summary>
public void Attack()
{
Console.WriteLine("部下C发起攻击");
}
}

至此，三个独立的类，构造完毕。那么，怎么让部下B和C，根据首领的暗语才去相应的行动呢？
我们需要在首领A类中，采用一种方法，把其意图传递出去。在首领A类之前，分别定义一个带形参的举杯委托RaiseEventHandler和一个不带形参的摔杯委托FallEventHandler。命名规则是在准备传递的方法名后加上EventHandler，不要问我为什么，介绍为什么的文章多得是，大家大可以去查阅。本文的宗旨是，教会大家如何快速的使用委托和事件。当然，你也可以不遵循此命名规则，对程序的运行没有任何影响，只是会增加自己或他人日后阅读代码的难度。

delegate void RaiseEventHandler(string hand);
delegate void FallEventHandler();

然后，在首领A类中，定义两个事件。这个类似于大家在WinForm中拖放一个Button后，双击该Button，即可编辑其事件。

/// <summary>
/// 首领A举杯事件
/// </summary>
public event RaiseEventHandler RaiseEvent;
/// <summary>
/// 首领A摔杯事件
/// </summary>
public event FallEventHandler FallEvent;

好了，做完上面两个步骤后，就可以在首领A的举杯和摔杯方法中，调用上述两个事件了。这样，如果B和C中订阅该事件，便可自动执行了。

/// <summary>
/// 举杯
/// </summary>
/// <param name="hand">手：左、右</param>
public void Raise(string hand)
{
Console.WriteLine("首领A{0}手举杯", hand);
// 调用举杯事件，传入左或右手作为参数
if (RaiseEvent!=null)
{
RaiseEvent(hand);
}
}
/// <summary>
/// 摔杯
/// </summary>
public void Fall()
{
Console.WriteLine("首领A摔杯");
// 调用摔杯事件
if (FallEvent!=null)
{
FallEvent();
}
}

同样，不要问为什么这样写。按照上述操作即可。一旦用熟这种方法，体会其中含义，自然就明白为何这么写了。在部下B和C心中，必须存在首领A，才能执行A的暗示吧。所以，在B类和C类中，需要声明一个A，该声明可以通过B和C的构造函数进行实例化。实例化之后，便可在类B和类C中订阅类A的事件了。完整代码如下：

1     class Program
2     {
3         static void Main(string[] args)
4         {
5             A a = new A(); // 定义首领A
6
7             B b = new B(a); // 定义部下B
8
9             C c = new C(a); // 定义部下C
10
11             // 首领A左手举杯
12             a.Raise("左");
13
14             // 首领A右手举杯
15             //a.Raise("右");
16
17             // 首领A摔杯
18             //a.Fall();
19
20             Console.ReadLine();
21             // 由于B和C订阅了A的事件，所以无需任何代码，B和C均会按照约定进行动作。
22         }
23     }
24
25     /// <summary>
26     /// 首领A举杯委托
27     /// </summary>
28     /// <param name="hand">手：左、右</param>
29     public delegate void RaiseEventHandler(string hand);
30     /// <summary>
31     /// 首领A摔杯委托
32     /// </summary>
33     public delegate void FallEventHandler();
34     /// <summary>
35     /// 首领A
36     /// </summary>
37     public class A
38     {
39         /// <summary>
40         /// 首领A举杯事件
41         /// </summary>
42         public event RaiseEventHandler RaiseEvent;
43         /// <summary>
44         /// 首领A摔杯事件
45         /// </summary>
46         public event FallEventHandler FallEvent;
47
48         /// <summary>
49         /// 举杯
50         /// </summary>
51         /// <param name="hand">手：左、右</param>
52         public void Raise(string hand)
53         {
54             Console.WriteLine("首领A{0}手举杯", hand);
55             // 调用举杯事件，传入左或右手作为参数
56             if (RaiseEvent!=null)
57             {
58                 RaiseEvent(hand);
59             }
60         }
61         /// <summary>
62         /// 摔杯
63         /// </summary>
64         public void Fall()
65         {
66             Console.WriteLine("首领A摔杯");
67             // 调用摔杯事件
68             if (FallEvent!=null)
69             {
70                 FallEvent();
71             }
72         }
73     }
74     /// <summary>
75     /// 部下B
76     /// </summary>
77     public class B
78     {
79         A a;
80
81         public B(A a)
82         {
83             this.a = a;
84             a.RaiseEvent += new RaiseEventHandler(a_RaiseEvent); // 订阅举杯事件
85             a.FallEvent += new FallEventHandler(a_FallEvent); // 订阅摔杯事件
86         }
87         /// <summary>
88         /// 首领举杯时的动作
89         /// </summary>
90         /// <param name="hand">若首领A左手举杯，则B攻击</param>
91         void a_RaiseEvent(string hand)
92         {
93             if (hand.Equals("左"))
94             {
95                 Attack();
96             }
97         }
98
99         /// <summary>
100         /// 首领摔杯时的动作
101         /// </summary>
102         void a_FallEvent()
103         {
104             Attack();
105         }
106
107         /// <summary>
108         /// 攻击
109         /// </summary>
110         public void Attack()
111         {
112             Console.WriteLine("部下B发起攻击，大喊：猛人张飞来也！");
113         }
114     }
115     /// <summary>
116     /// 部下C
117     /// </summary>
118     public class C
119     {
120         A a;
121         public C(A a)
122         {
123             this.a = a;
124             a.RaiseEvent += new RaiseEventHandler(a_RaiseEvent); // 订阅举杯事件
125             a.FallEvent += new FallEventHandler(a_FallEvent); // 订阅摔杯事件
126         }
127         /// <summary>
128         /// 首领举杯时的动作
129         /// </summary>
130         /// <param name="hand">若首领A右手举杯，则攻击</param>
131         void a_RaiseEvent(string hand)
132         {
133             if (hand.Equals("右"))
134             {
135                 Attack();
136             }
137         }
138
139         /// <summary>
140         /// 首领摔杯时的动作
141         /// </summary>
142         void a_FallEvent()
143         {
144             Attack();
145         }
146         /// <summary>
147         /// 攻击
148         /// </summary>
149         public void Attack()
150         {
151             Console.WriteLine("部下C发起攻击，一套落英神掌打得虎虎生威~");
152         }
153     }