C#中的委托和事件2-2（转）
引言
若是你看过了 C#中的委托和事件2-1 一文，我想你对委托和事件已经有了一个基本的认识。但那些远不是委托和事件的所有内容，还有不少的地方没有涉及。本文将讨论委托和事件一些更为细节的问题，包括一些你们常问到的问题，以及事件访问器、异常处理、超时处理和异步方法调用等内容。html
为何要使用事件而不是委托变量？
在 C#中的委托和事件 中，我提出了两个为何在类型中使用事件向外部提供方法注册，而不是直接使用委托变量的缘由。主要是从封装性和易用性上去考虑，可是还漏掉了一点，事件应该由事件发布者触发，而不该该由客户端（客户程序）来触发。这句话是什么意思呢？请看下面的范例：编程
NOTE：注意这里术语的变化，当咱们单独谈论事件，咱们说发布者(publisher)、订阅者(subscriber)、客户端(client)。当咱们讨论Observer模式，咱们说主题(subject)和观察者(observer)。客户端一般是包含Main()方法的Program类。数组
class Program {
static void Main(string[] args) {
Publishser pub = new Publishser();
Subscriber sub = new Subscriber();
pub.NumberChanged += new NumberChangedEventHandler(sub.OnNumberChanged);
pub.DoSomething(); // 应该经过DoSomething()来触发事件
pub.NumberChanged(100); // 但能够被这样直接调用，对委托变量的不恰当使用
}
}
// 定义委托
public delegate void NumberChangedEventHandler(int count);
// 定义事件发布者
public class Publishser {
private int count;
public NumberChangedEventHandler NumberChanged; // 声明委托变量
//public event NumberChangedEventHandler NumberChanged; // 声明一个事件
public void DoSomething() {
// 在这里完成一些工做 ...
if (NumberChanged != null) { // 触发事件
count++;
NumberChanged(count);
}
}
}
// 定义事件订阅者
public class Subscriber {
public void OnNumberChanged(int count) {
Console.WriteLine("Subscriber notified: count = {0}", count);
}
}app
上面代码定义了一个NumberChangedEventHandler委托，而后咱们建立了事件的发布者Publisher和订阅者Subscriber。当使用委托变量时，客户端能够直接经过委托变量触发事件，也就是直接调用pub.NumberChanged(100)，这将会影响到全部注册了该委托的订阅者。而事件的本意应该为在事件发布者在其自己的某个行为中触发，好比说在方法DoSomething()中知足某个条件后触发。经过添加event关键字来发布事件，事件发布者的封装性会更好，事件仅仅是供其余类型订阅，而客户端不能直接触发事件（语句pub.NumberChanged(100)没法经过编译），事件只能在事件发布者Publisher类的内部触发（好比在方法pub.DoSomething()中），换言之，就是NumberChanged(100)语句只能在Publisher内部被调用。异步
你们能够尝试一下，将委托变量的声明那行代码注释掉，而后取消下面事件声明的注释。此时程序是没法编译的，当你使用了event关键字以后，直接在客户端触发事件这种行为，也就是直接调用pub.NumberChanged(100)，是被禁止的。事件只能经过调用DoSomething()来触发。这样才是事件的本意，事件发布者的封装才会更好。async
就好像若是咱们要定义一个数字类型，咱们会使用int而不是使用object同样，给予对象过多的能力并不见得是一件好事，应该是越合适越好。尽管直接使用委托变量一般不会有什么问题，但它给了客户端不该具备的能力，而使用事件，能够限制这一能力，更精确地对类型进行封装。异步编程
NOTE：这里还有一个约定俗称的规定，就是订阅事件的方法的命名，一般为“On事件名”，好比这里的OnNumberChanged。性能
为何委托定义的返回值一般都为void？
尽管并不是必需，可是咱们发现不少的委托定义返回值都为void，为何呢？这是由于委托变量能够供多个订阅者注册，若是定义了返回值，那么多个订阅者的方法都会向发布者返回数值，结果就是后面一个返回的方法值将前面的返回值覆盖掉了，所以，实际上只能得到最后一个方法调用的返回值。能够运行下面的代码测试一下。除此之外，发布者和订阅者是松耦合的，发布者根本不关心谁订阅了它的事件、为何要订阅，更别说订阅者的返回值了，因此返回订阅者的方法返回值大多数状况下根本没有必要。测试
class Program {
static void Main(string[] args) {
Publishser pub = new Publishser();
Subscriber1 sub1 = new Subscriber1();
Subscriber2 sub2 = new Subscriber2();
Subscriber3 sub3 = new Subscriber3();
pub.NumberChanged += new GeneralEventHandler(sub1.OnNumberChanged);
pub.NumberChanged += new GeneralEventHandler(sub2.OnNumberChanged);
pub.NumberChanged += new GeneralEventHandler(sub3.OnNumberChanged);
pub.DoSomething(); // 触发事件
}
}
// 定义委托
public delegate string GeneralEventHandler();
// 定义事件发布者
public class Publishser {
public event GeneralEventHandler NumberChanged; // 声明一个事件
public void DoSomething() {
if (NumberChanged != null) { // 触发事件
string rtn = NumberChanged();
Console.WriteLine(rtn); // 打印返回的字符串，输出为Subscriber3
}
}
}
// 定义事件订阅者
public class Subscriber1 {
public string OnNumberChanged() {
return "Subscriber1";
}
}
public class Subscriber2 { /* 略，与上相似，返回Subscriber2*/ }
public class Subscriber3 { /* 略，与上相似，返回Subscriber3*/ }this
若是运行这段代码，获得的输出是Subscriber3，能够看到，只获得了最后一个注册方法的返回值。
如何让事件只容许一个客户订阅？
少数状况下，好比像上面，为了不发生“值覆盖”的状况（更可能是在异步调用方法时，后面会讨论），咱们可能想限制只容许一个客户端注册。此时怎么作呢？咱们能够向下面这样，将事件声明为private的，而后提供两个方法来进行注册和取消注册：
// 定义事件发布者
public class Publishser {
private event GeneralEventHandler NumberChanged; // 声明一个私有事件
// 注册事件
public void Register(GeneralEventHandler method) {
NumberChanged = method;
}
// 取消注册
public void UnRegister(GeneralEventHandler method) {
NumberChanged -= method;
}
public void DoSomething() {
// 作某些其他的事情
if (NumberChanged != null) { // 触发事件
string rtn = NumberChanged();
Console.WriteLine("Return: {0}", rtn); // 打印返回的字符串，输出为Subscriber3
}
}
}
NOTE：注意上面，在UnRegister()中，没有进行任何判断就使用了NumberChanged-=method语句。这是由于即便method方法没有进行过注册，此行语句也不会有任何问题，不会抛出异常，仅仅是不会产生任何效果而已。
注意在Register()方法中，咱们使用了赋值操做符“=”，而非“+=”，经过这种方式就避免了多个方法注册。上面的代码尽管能够完成咱们的须要，可是此时你们还应该注意下面两点：
一、将NumberChanged声明为委托变量仍是事件都无所谓了，由于它是私有的，即使将它声明为一个委托变量，客户端也看不到它，也就没法经过它来触发事件、调用订阅者的方法。而只能经过Register()和UnRegister()方法来注册和取消注册，经过调用DoSomething()方法触发事件（而不是NumberChanged自己，这在前面已经讨论过了）。
二、咱们还应该发现，这里采用的、对NumberChanged委托变量的访问模式和C#中的属性是多么相似啊？你们知道，在C#中一般一个属性对应一个类型成员，而在类型的外部对成员的操做所有经过属性来完成。尽管这里对委托变量的处理是相似的效果，但却使用了两个方法来进行模拟，有没有办法像使用属性同样来完成上面的例子呢？答案是有的，C#中提供了一种叫事件访问器（Event Accessor）的东西，它用来封装委托变量。以下面例子所示：
class Program {
static void Main(string[] args) {
Publishser pub = new Publishser();
Subscriber1 sub1 = new Subscriber1();
Subscriber2 sub2 = new Subscriber2();
pub.NumberChanged -= sub1.OnNumberChanged; // 不会有任何反应
pub.NumberChanged += sub2.OnNumberChanged; // 注册了sub2
pub.NumberChanged += sub1.OnNumberChanged; // sub1将sub2的覆盖掉了
pub.DoSomething(); // 触发事件
}
}
// 定义委托
public delegate string GeneralEventHandler();
// 定义事件发布者
public class Publishser {
// 声明一个委托变量
private GeneralEventHandler numberChanged;
// 事件访问器的定义
public event GeneralEventHandler NumberChanged {
add {
numberChanged = value;
}
remove {
numberChanged -= value;
}
}
public void DoSomething() {
// 作某些其余的事情
if (numberChanged != null) { // 经过委托变量触发事件
string rtn = numberChanged();
Console.WriteLine("Return: {0}", rtn); // 打印返回的字符串
}
}
}
// 定义事件订阅者
public class Subscriber1 {
public string OnNumberChanged() {
Console.WriteLine("Subscriber1 Invoked!");
return "Subscriber1";
}
}
public class Subscriber2 {/* 与上类同，略 */}
public class Subscriber3 {/* 与上类同，略 */}
上面代码中相似属性的public event GeneralEventHandler NumberChanged {add{...}remove{...}}语句即是事件访问器。使用了事件访问器之后，在DoSomething方法中便只能经过numberChanged委托变量来触发事件，而不能NumberChanged事件访问器（注意它们的大小写不一样）触发，它只用于注册和取消注册。下面是代码输出：
Subscriber1 Invoked!
Return: Subscriber1
得到多个返回值与异常处理
如今假设咱们想要得到多个订阅者的返回值，以List<string>的形式返回，该如何作呢？咱们应该记得委托定义在编译时会生成一个继承自MulticastDelegate的类，而这个MulticastDelegate又继承自Delegate，在Delegate内部，维护了一个委托链表，链表上的每个元素，为一个只包含一个目标方法的委托对象。而经过Delegate基类的GetInvocationList()静态方法，能够得到这个委托链表。随后咱们遍历这个链表，经过链表中的每一个委托对象来调用方法，这样就能够分别得到每一个方法的返回值：
class Program4 {
static void Main(string[] args) {
Publishser pub = new Publishser();
Subscriber1 sub1 = new Subscriber1();
Subscriber2 sub2 = new Subscriber2();
Subscriber3 sub3 = new Subscriber3();
pub.NumberChanged += new DemoEventHandler(sub1.OnNumberChanged);
pub.NumberChanged += new DemoEventHandler(sub2.OnNumberChanged);
pub.NumberChanged += new DemoEventHandler(sub3.OnNumberChanged);
List<string> list = pub.DoSomething(); //调用方法，在方法内触发事件
foreach (string str in list) {
Console.WriteLine(str);
}
}
}
public delegate string DemoEventHandler(int num);
// 定义事件发布者
public class Publishser {
public event DemoEventHandler NumberChanged; // 声明一个事件
public List<string> DoSomething() {
// 作某些其余的事
List<string> strList = new List<string>();
if (NumberChanged == null) return strList;
// 得到委托数组
Delegate[] delArray = NumberChanged.GetInvocationList();
foreach (Delegate del in delArray) {
// 进行一个向下转换
DemoEventHandler method = (DemoEventHandler)del;
strList.Add(method(100)); // 调用方法并获取返回值
}
return strList;
}
}
// 定义事件订阅者
public class Subscriber1 {
public string OnNumberChanged(int num) {
Console.WriteLine("Subscriber1 invoked, number:{0}", num);
return "[Subscriber1 returned]";
}
}
public class Subscriber3 {与上面类同，略}
public class Subscriber3 {与上面类同，略}
若是运行上面的代码，能够获得这样的输出：
Subscriber1 invoked, number:100
Subscriber2 invoked, number:100
Subscriber3 invoked, number:100
[Subscriber1 returned]
[Subscriber2 returned]
[Subscriber3 returned]
可见咱们得到了三个方法的返回值。而咱们前面说过，不少状况下委托的定义都不包含返回值，因此上面介绍的方法彷佛没有什么实际意义。其实经过这种方式来触发事件最多见的状况应该是在异常处理中，由于颇有可能在触发事件时，订阅者的方法会抛出异常，而这一异常会直接影响到发布者，使得发布者程序停止，然后面订阅者的方法将不会被执行。所以咱们须要加上异常处理，考虑下面一段程序：
class Program5 {
static void Main(string[] args) {
Publisher pub = new Publisher();
Subscriber1 sub1 = new Subscriber1();
Subscriber2 sub2 = new Subscriber2();
Subscriber3 sub3 = new Subscriber3();
pub.NumberChanged += new DemoEventHandler(sub1.OnNumberChanged);
pub.NumberChanged += new DemoEventHandler(sub2.OnNumberChanged);
pub.NumberChanged += new DemoEventHandler(sub3.OnNumberChanged);
}
}
public class Publisher {
public event EventHandler MyEvent;
public void DoSomething() {
// 作某些其余的事情
if (MyEvent != null) {
try {
MyEvent(this, EventArgs.Empty);
} catch (Exception e) {
Console.WriteLine("Exception: {0}", e.Message);
}
}
}
}
public class Subscriber1 {
public void OnEvent(object sender, EventArgs e) {
Console.WriteLine("Subscriber1 Invoked!");
}
}
public class Subscriber2 {
public void OnEvent(object sender, EventArgs e) {
throw new Exception("Subscriber2 Failed");
}
}
public class Subscriber3 {/* 与Subsciber1类同，略*/}
注意到咱们在Subscriber2中抛出了异常，同时咱们在Publisher中使用了try/catch语句来处理异常。运行上面的代码，咱们获得的结果是：
Subscriber1 Invoked!
Exception: Subscriber2 Failed
能够看到，尽管咱们捕获了异常，使得程序没有异常结束，可是却影响到了后面的订阅者，由于Subscriber3也订阅了事件，可是却没有收到事件通知（它的方法没有被调用）。此时，咱们能够采用上面的办法，先得到委托链表，而后在遍历链表的循环中处理异常，咱们只须要修改一下DoSomething方法就能够了：
public void DoSomething() {
if (MyEvent != null) {
Delegate[] delArray = MyEvent.GetInvocationList();
foreach (Delegate del in delArray) {
EventHandler method = (EventHandler)del; // 强制转换为具体的委托类型
try {
method(this, EventArgs.Empty);
} catch (Exception e) {
Console.WriteLine("Exception: {0}", e.Message);
}
}
}
}
注意到Delegate是EventHandler的基类，因此为了触发事件，先要进行一个向下的强制转换，以后才能在其上触发事件，调用全部注册对象的方法。除了使用这种方式之外，还有一种更灵活方式能够调用方法，它是定义在Delegate基类中的DynamicInvoke()方法：
public object DynamicInvoke(params object[] args);
这多是调用委托最通用的方法了，适用于全部类型的委托。它接受的参数为object[]，也就是说它能够将任意数量的任意类型做为参数，并返回单个object对象。上面的DoSomething()方法也能够改写成下面这种通用形式：
public void DoSomething() {
// 作某些其余的事情
if (MyEvent != null) {
Delegate[] delArray = MyEvent.GetInvocationList();
foreach (Delegate del in delArray) {
try {
// 使用DynamicInvoke方法触发事件
del.DynamicInvoke(this, EventArgs.Empty);
} catch (Exception e) {
Console.WriteLine("Exception: {0}", e.Message);
}
}
}
}
注意如今在DoSomething()方法中，咱们取消了向具体委托类型的向下转换，如今没有了任何的基于特定委托类型的代码，而DynamicInvoke又能够接受任何类型的参数，且返回一个object对象。因此咱们彻底能够将DoSomething()方法抽象出来，使它成为一个公共方法，而后供其余类来调用，咱们将这个方法声明为静态的，而后定义在Program类中：
// 触发某个事件，以列表形式返回全部方法的返回值
public static object[] FireEvent(Delegate del, params object[] args){
List<object> objList = new List<object>();
if (del != null) {
Delegate[] delArray = del.GetInvocationList();
foreach (Delegate method in delArray) {
try {
// 使用DynamicInvoke方法触发事件
object obj = method.DynamicInvoke(args);
if (obj != null)
objList.Add(obj);
} catch { }
}
}
return objList.ToArray();
}
随后，咱们在DoSomething()中只要简单的调用一下这个方法就能够了：
public void DoSomething() {
// 作某些其余的事情
Program5.FireEvent(MyEvent, this, EventArgs.Empty);
}
注意FireEvent()方法还能够返回一个object[]数组，这个数组包括了全部订阅者方法的返回值。而在上面的例子中，我没有演示如何获取并使用这个数组，为了节省篇幅，这里也再也不赘述了，在本文附带的代码中，有关于这部分的演示，有兴趣的朋友能够下载下来看看。
委托中订阅者方法超时的处理
订阅者除了能够经过异常的方式来影响发布者之外，还能够经过另外一种方式：超时。通常说超时，指的是方法的执行超过某个指定的时间，而这里我将含义扩展了一下，凡是方法执行的时间比较长，我就认为它超时了，这个“比较长”是一个比较模糊的概念，2秒、3秒、5秒均可以视为超时。超时和异常的区别就是超时并不会影响事件的正确触发和程序的正常运行，却会致使事件触发后须要很长才可以结束。在依次执行订阅者的方法这段期间内，客户端程序会被中断，什么也不能作。由于当执行订阅者方法时（经过委托，至关于依次调用全部注册了的方法），当前线程会转去执行方法中的代码，调用方法的客户端会被中断，只有当方法执行完毕并返回时，控制权才会回到客户端，从而继续执行下面的代码。咱们来看一下下面一个例子：
class Program6 {
static void Main(string[] args) {
Publisher pub = new Publisher();
Subscriber1 sub1 = new Subscriber1();
Subscriber2 sub2 = new Subscriber2();
Subscriber3 sub3 = new Subscriber3();
pub.MyEvent += new EventHandler(sub1.OnEvent);
pub.MyEvent += new EventHandler(sub2.OnEvent);
pub.MyEvent += new EventHandler(sub3.OnEvent);
pub.DoSomething(); // 触发事件
Console.WriteLine(" Control back to client!"); // 返回控制权
}
// 触发某个事件，以列表形式返回全部方法的返回值
public static object[] FireEvent(Delegate del, params object[] args) {
// 代码与上同，略
}
}
public class Publisher {
public event EventHandler MyEvent;
public void DoSomething() {
// 作某些其余的事情
Console.WriteLine("DoSomething invoked!");
Program6.FireEvent(MyEvent, this, EventArgs.Empty); //触发事件
}
}
public class Subscriber1 {
public void OnEvent(object sender, EventArgs e) {
Thread.Sleep(TimeSpan.FromSeconds(3));
Console.WriteLine("Waited for 3 seconds, subscriber1 invoked!");
}
}
public class Subscriber2 {
public void OnEvent(object sender, EventArgs e) {
Console.WriteLine("Subscriber2 immediately Invoked!");
}
}
public class Subscriber3 {
public void OnEvent(object sender, EventArgs e) {
Thread.Sleep(TimeSpan.FromSeconds(2));
Console.WriteLine("Waited for 2 seconds, subscriber2 invoked!");
}
}
在这段代码中，咱们使用Thread.Sleep()静态方法模拟了方法超时的状况。其中Subscriber1.OnEvent()须要三秒钟完成，Subscriber2.OnEvent()当即执行，Subscriber3.OnEvent须要两秒完成。这段代码彻底能够正常输出，也没有异常抛出（若是有，也仅仅是该订阅者被忽略掉），下面是输出的状况：
DoSomething invoked!
Waited for 3 seconds, subscriber1 invoked!
Subscriber2 immediately Invoked!
Waited for 2 seconds, subscriber2 invoked!
Control back to client!
可是这段程序在调用方法DoSomething()、打印了“DoSomething invoked”以后，触发了事件，随后必须等订阅者的三个方法所有执行完毕了以后，也就是大概5秒钟的时间，才能继续执行下面的语句，也就是打印“Control back to client”。而咱们前面说过，不少状况下，尤为是远程调用的时候（好比说在Remoting中），发布者和订阅者应该是彻底的松耦合，发布者不关心谁订阅了它、不关心订阅者的方法有什么返回值、不关心订阅者会不会抛出异常，固然也不关心订阅者须要多长时间才能完成订阅的方法，它只要在事件发生的那一瞬间告知订阅者事件已经发生并将相关参数传给订阅者就能够了。而后它就应该继续执行它后面的动做，在本例中就是打印“Control back to client！”。而订阅者无论失败或是超时都不该该影响到发布者，但在上面的例子中，发布者却不得不等待订阅者的方法执行完毕才能继续运行。
如今咱们来看下如何解决这个问题，先回顾一下以前我在C#中的委托和事件一文中提到的内容，我说过，委托的定义会生成继承自MulticastDelegate的完整的类，其中包含Invoke()、BeginInvoke()和EndInvoke()方法。当咱们直接调用委托时，其实是调用了Invoke()方法，它会中断调用它的客户端，而后在客户端线程上执行全部订阅者的方法（客户端没法继续执行后面代码），最后将控制权返回客户端。注意到BeginInvoke()、EndInvoke()方法，在.Net中，异步执行的方法一般都会配对出现，而且以Begin和End做为方法的开头（最多见的可能就是Stream类的BeginRead()和EndRead()方法了）。它们用于方法的异步执行，便是在调用BeginInvoke()以后，客户端从线程池中抓取一个闲置线程，而后交由这个线程去执行订阅者的方法，而客户端线程则能够继续执行下面的代码。
BeginInvoke()接受“动态”的参数个数和类型，为何说“动态”的呢？由于它的参数是在编译时根据委托的定义动态生成的，其中前面参数的个数和类型与委托定义中接受的参数个数和类型相同，最后两个参数分别是AsyncCallback和Object类型，对于它们更具体的内容，能够参见下一节委托和方法的异步调用部分。如今，咱们仅须要对这两个参数传入null就能够了。另外还须要注意几点：
- 在委托类型上调用BeginInvoke()时，此委托对象只能包含一个目标方法，因此对于多个订阅者注册的状况，必须使用GetInvocationList()得到全部委托对象，而后遍历它们，分别在其上调用BeginInvoke()方法。若是直接在委托上调用BeginInvoke()，会抛出异常，提示“委托只能包含一个目标方法”。
- 若是订阅者的方法抛出异常，.NET会捕捉到它，可是只有在调用EndInvoke()的时候，才会将异常从新抛出。而在本例中，咱们不使用EndInvoke()（由于咱们不关心订阅者的执行状况），因此咱们无需处理异常，由于即便抛出异常，也是在另外一个线程上，不会影响到客户端线程（客户端甚至不知道订阅者发生了异常，这有时是好事有时是坏事）。
- BeginInvoke()方法属于委托定义所生成的类，它既不属于MulticastDelegate也不属于Delegate基类，因此没法继续使用可重用的FireEvent()方法，咱们须要进行一个向下转换，来获取到实际的委托类型。
如今咱们修改一下上面的程序，使用异步调用来解决订阅者方法执行超时的状况：
class Program6 {
static void Main(string[] args) {
Publisher pub = new Publisher();
Subscriber1 sub1 = new Subscriber1();
Subscriber2 sub2 = new Subscriber2();
Subscriber3 sub3 = new Subscriber3();
pub.MyEvent += new EventHandler(sub1.OnEvent);
pub.MyEvent += new EventHandler(sub2.OnEvent);
pub.MyEvent += new EventHandler(sub3.OnEvent);
pub.DoSomething(); // 触发事件
Console.WriteLine("Control back to client! "); // 返回控制权
Console.WriteLine("Press any thing to exit...");
Console.ReadKey(); // 暂停客户程序，提供时间供订阅者完成方法
}
}
public class Publisher {
public event EventHandler MyEvent;
public void DoSomething() {
// 作某些其余的事情
Console.WriteLine("DoSomething invoked!");
if (MyEvent != null) {
Delegate[] delArray = MyEvent.GetInvocationList();
foreach (Delegate del in delArray) {
EventHandler method = (EventHandler)del;
method.BeginInvoke(null, EventArgs.Empty, null, null);
}
}
}
}
public class Subscriber1 {
public void OnEvent(object sender, EventArgs e) {
Thread.Sleep(TimeSpan.FromSeconds(3)); // 模拟耗时三秒才能完成方法
Console.WriteLine("Waited for 3 seconds, subscriber1 invoked!");
}
}
public class Subscriber2 {
public void OnEvent(object sender, EventArgs e) {
throw new Exception("Subsciber2 Failed"); // 即便抛出异常也不会影响到客户端
//Console.WriteLine("Subscriber2 immediately Invoked!");
}
}
public class Subscriber3 {
public void OnEvent(object sender, EventArgs e) {
Thread.Sleep(TimeSpan.FromSeconds(2)); // 模拟耗时两秒才能完成方法
Console.WriteLine("Waited for 2 seconds, subscriber3 invoked!");
}
}
运行上面的代码，会获得下面的输出：
DoSomething invoked!
Control back to client!
Press any thing to exit...
Waited for 2 seconds, subscriber3 invoked!
Waited for 3 seconds, subscriber1 invoked!
须要注意代码输出中的几个变化：
- 咱们须要在客户端程序中调用Console.ReadKey()方法来暂停客户端，以提供足够的时间来让异步方法去执行完代码，否则的话客户端的程序到此处便会运行结束，程序会退出，不会看到任何订阅者方法的输出，由于它们根本没来得及执行完毕。缘由是这样的：客户端所在的线程咱们一般称为主线程，而执行订阅者方法的线程来自线程池，属于后台线程(Background Thread），当主线程结束时，不论后台线程有没有结束，都会退出程序。（固然还有一种前台线程(Foreground Thread)，主线程结束后必须等前台线程也结束后程序才会退出，关于线程的讨论能够开辟另外一个庞大的主题，这里就不讨论了）。
- 在打印完“Press any thing to exit...”以后，两个订阅者的方法会以2秒、1秒的间隔显示出来，且尽管咱们先注册了subscirber1，可是却先执行了subscriber3，这是由于执行它须要的时间更短。除此之外，注意到这两个方法是并行执行的，因此执行它们的总时间是最长的方法所须要的时间，也就是3秒，而不是他们的累加5秒。
- 如同前面所提到的，尽管subscriber2抛出了异常，咱们也没有针对异常进行处理，可是客户程序并无察觉到，程序也没有所以而中断。
委托和方法的异步调用
一般状况下，若是须要异步执行一个耗时的操做，咱们会新起一个线程，而后让这个线程去执行代码。可是对于每个异步调用都经过建立线程来进行操做显然会对性能产生必定的影响，同时操做也相对繁琐一些。.Net中能够经过委托进行方法的异步调用，就是说客户端在异步调用方法时，自己并不会由于方法的调用而中断，而是从线程池中抓取一个线程去执行该方法，自身线程（主线程）在完成抓取线程这一过程以后，继续执行下面的代码，这样就实现了代码的并行执行。使用线程池的好处就是避免了频繁进行异步调用时建立、销毁线程的开销。
如同上面所示，当咱们在委托对象上调用BeginInvoke()时，便进行了一个异步的方法调用。上面的例子中是在事件的发布和订阅这一过程当中使用了异步调用，而在事件发布者和订阅者之间每每是松耦合的，发布者一般不须要得到订阅者方法执行的状况；而当使用异步调用时，更多状况下是为了提高系统的性能，而并不是专用于事件的发布和订阅这一编程模型。而在这种状况下使用异步编程时，就须要进行更多的控制，好比当异步执行方法的方法结束时通知客户端、返回异步执行方法的返回值等。本节就对BeginInvoke()方法、EndInvoke()方法和其相关的IAysncResult作一个简单的介绍。
NOTE：注意此处我已经再也不使用发布者、订阅者这些术语，由于咱们再也不是讨论上面的事件模型，而是讨论在客户端程序中异步地调用方法，这里有一个思惟的转变。
咱们看这样一段代码，它演示了不使用异步调用的一般状况：
class Program7 {
static void Main(string[] args) {
Console.WriteLine("Client application started! ");
Thread.CurrentThread.Name = "Main Thread";
Calculator cal = new Calculator();
int result = cal.Add(2, 5);
Console.WriteLine("Result: {0} ", result);
// 作某些其它的事情，模拟须要执行3秒钟
for (int i = 1; i <= 3; i++) {
Thread.Sleep(TimeSpan.FromSeconds(i));
Console.WriteLine("{0}: Client executed {1} second(s).",
Thread.CurrentThread.Name, i);
}
Console.WriteLine(" Press any key to exit...");
Console.ReadKey();
}
}
public class Calculator {
public int Add(int x, int y) {
if (Thread.CurrentThread.IsThreadPoolThread) {
Thread.CurrentThread.Name = "Pool Thread";
}
Console.WriteLine("Method invoked!");
// 执行某些事情，模拟须要执行2秒钟
for (int i = 1; i <= 2; i++) {
Thread.Sleep(TimeSpan.FromSeconds(i));
Console.WriteLine("{0}: Add executed {1} second(s).",
Thread.CurrentThread.Name, i);
}
Console.WriteLine("Method complete!");
return x + y;
}
}
上面代码有几个关于对于线程的操做，若是不了解能够看一下下面的说明，若是你已经了解能够直接跳过：
- Thread.Sleep()，它会让执行当前代码的线程暂停一段时间（若是你对线程的概念比较陌生，能够理解为使程序的执行暂停一段时间），以毫秒为单位，好比Thread.Sleep(1000)，将会使线程暂停1秒钟。在上面我使用了它的重载方法，我的以为使用TimeSpan.FromSeconds(1)，可读性更好一些。
- Thread.CurrentThread.Name，经过这个属性能够设置、获取执行当前代码的线程的名称，值得注意的是这个属性只能够设置一次，若是设置两次，会抛出异常。
- Thread.IsThreadPoolThread，能够判断执行当前代码的线程是否为线程池中的线程。
经过这几个方法和属性，有助于咱们更好地调试异步调用方法。上面代码中除了加入了一些对线程的操做之外再没有什么特别之处。咱们建了一个Calculator类，它只有一个Add方法，咱们模拟了这个方法须要执行2秒钟时间，而且每隔一秒进行一次输出。而在客户端程序中，咱们使用result变量保存了方法的返回值并进行了打印。随后，咱们再次模拟了客户端程序接下来的操做须要执行2秒钟时间。运行这段程序，会产生下面的输出：
Client application started!
Method invoked!
Main Thread: Add executed 1 second(s).
Main Thread: Add executed 2 second(s).
Method complete!
Result: 7
Main Thread: Client executed 1 second(s).
Main Thread: Client executed 2 second(s).
Main Thread: Client executed 3 second(s).
Press any key to exit...
若是你确实执行了这段代码，会看到这些输出并非一瞬间输出的，而是执行了大概5秒钟的时间，由于线程是串行执行的，因此在执行完Add()方法以后才会继续客户端剩下的代码。
接下来咱们定义一个AddDelegate委托，并使用BeginInvoke()方法来异步地调用它。在上面已经介绍过，BeginInvoke()除了最后两个参数为AsyncCallback类型和Object类型之外，前面的参数类型和个数与委托定义相同。另外BeginInvoke()方法返回了一个实现了IAsyncResult接口的对象（实际上就是一个AsyncResult类型实例，注意这里IAsyncResult和AysncResult是不一样的，它们均包含在.Net Framework中）。
AsyncResult的用途有这么几个：传递参数，它包含了对调用了BeginInvoke()的委托的引用；它还包含了BeginInvoke()的最后一个Object类型的参数；它能够鉴别出是哪一个方法的哪一次调用，由于经过同一个委托变量能够对同一个方法调用屡次。
EndInvoke()方法接受IAsyncResult类型的对象（以及ref和out类型参数，这里不讨论了，对它们的处理和返回值相似），因此在调用BeginInvoke()以后，咱们须要保留IAsyncResult，以便在调用EndInvoke()时进行传递。这里最重要的就是EndInvoke()方法的返回值，它就是方法的返回值。除此之外，当客户端调用EndInvoke()时，若是异步调用的方法没有执行完毕，则会中断当前线程而去等待该方法，只有当异步方法执行完毕后才会继续执行后面的代码。因此在调用完BeginInvoke()后当即执行EndInvoke()是没有任何意义的。咱们一般在尽量早的时候调用BeginInvoke()，而后在须要方法的返回值的时候再去调用EndInvoke()，或者是根据状况在晚些时候调用。说了这么多，咱们如今看一下使用异步调用改写后上面的代码吧：
public delegate int AddDelegate(int x, int y);
class Program8 {
static void Main(string[] args) {
Console.WriteLine("Client application started! ");
Thread.CurrentThread.Name = "Main Thread";
Calculator cal = new Calculator();
AddDelegate del = new AddDelegate(cal.Add);
IAsyncResult asyncResult = del.BeginInvoke(2,5,null,null); // 异步调用方法
// 作某些其它的事情，模拟须要执行3秒钟
for (int i = 1; i <= 3; i++) {
Thread.Sleep(TimeSpan.FromSeconds(i));
Console.WriteLine("{0}: Client executed {1} second(s).",
Thread.CurrentThread.Name, i);
}
int rtn = del.EndInvoke(asyncResult);
Console.WriteLine("Result: {0} ", rtn);
Console.WriteLine(" Press any key to exit...");
Console.ReadKey();
}
}
public class Calculator { /* 与上面同，略 */}
此时的输出为：
Client application started!
Method invoked!
Main Thread: Client executed 1 second(s).
Pool Thread: Add executed 1 second(s).
Main Thread: Client executed 2 second(s).
Pool Thread: Add executed 2 second(s).
Method complete!
Main Thread: Client executed 3 second(s).
Result: 7
Press any key to exit...
如今执行完这段代码只须要3秒钟时间，两个for循环所产生的输出交替进行，这也说明了这两段代码并行执行的状况。能够看到Add()方法是由线程池中的线程在执行，由于Thread.CurrentThread.IsThreadPoolThread返回了True，同时咱们对该线程命名为了Pool Thread。另外咱们能够看到经过EndInvoke()方法获得了返回值。
有时候，咱们可能会将得到返回值的操做放到另外一段代码或者客户端去执行，而不是向上面那样直接写在BeginInvoke()的后面。好比说咱们在Program中新建一个方法GetReturn()，此时能够经过AsyncResult的AsyncDelegate得到del委托对象，而后再在其上调用EndInvoke()方法，这也说明了AsyncResult能够惟一的获取到与它相关的调用了的方法（或者也能够理解成委托对象）。因此上面获取返回值的代码也能够改写成这样：
static int GetReturn(IAsyncResult asyncResult) {
AsyncResult result = (AsyncResult)asyncResult;
AddDelegate del = (AddDelegate)result.AsyncDelegate;
int rtn = del.EndInvoke(asyncResult);
return rtn;
}
而后再将int rtn = del.EndInvoke(asyncResult);语句改成int rtn = GetReturn(asyncResult);。注意上面IAsyncResult要转换为实际的类型AsyncResult才能访问AsyncDelegate属性，由于它没有包含在IAsyncResult接口的定义中。
BeginInvoke的另外两个参数分别是AsyncCallback和Object类型，其中AsyncCallback是一个委托类型，它用于方法的回调，便是说当异步方法执行完毕时自动进行调用的方法。它的定义为：
public delegate void AsyncCallback(IAsyncResult ar);
Object类型用于传递任何你想要的数值，它能够经过IAsyncResult的AsyncState属性得到。下面咱们将获取方法返回值、打印返回值的操做放到了OnAddComplete()回调方法中：
public delegate int AddDelegate(int x, int y);
class Program9 {
static void Main(string[] args) {
Console.WriteLine("Client application started! ");
Thread.CurrentThread.Name = "Main Thread";
Calculator cal = new Calculator();
AddDelegate del = new AddDelegate(cal.Add);
string data = "Any data you want to pass.";
AsyncCallback callBack = new AsyncCallback(OnAddComplete);
del.BeginInvoke(2, 5, callBack, data); // 异步调用方法
// 作某些其它的事情，模拟须要执行3秒钟
for (int i = 1; i <= 3; i++) {
Thread.Sleep(TimeSpan.FromSeconds(i));
Console.WriteLine("{0}: Client executed {1} second(s).",
Thread.CurrentThread.Name, i);
}
Console.WriteLine(" Press any key to exit...");
Console.ReadKey();
}
static void OnAddComplete(IAsyncResult asyncResult) {
AsyncResult result = (AsyncResult)asyncResult;
AddDelegate del = (AddDelegate)result.AsyncDelegate;
string data = (string)asyncResult.AsyncState;
int rtn = del.EndInvoke(asyncResult);
Console.WriteLine("{0}: Result, {1}; Data: {2} ",
Thread.CurrentThread.Name, rtn, data);
}
}
public class Calculator { /* 与上面同，略 */}
它产生的输出为：
Client application started!
Method invoked!
Main Thread: Client executed 1 second(s).
Pool Thread: Add executed 1 second(s).
Main Thread: Client executed 2 second(s).
Pool Thread: Add executed 2 second(s).
Method complete!
Pool Thread: Result, 7; Data: Any data you want to pass.
Main Thread: Client executed 3 second(s).
Press any key to exit...
这里有几个值得注意的地方：一、咱们在调用BeginInvoke()后再也不须要保存IAysncResult了，由于AysncCallback委托将该对象定义在了回调方法的参数列表中；二、咱们在OnAddComplete()方法中得到了调用BeginInvoke()时最后一个参数传递的值，字符串“Any data you want to pass”；三、执行回调方法的线程并不是客户端线程Main Thread，而是来自线程池中的线程Pool Thread。另外如前面所说，在调用EndInvoke()时有可能会抛出异常，因此在应该将它放到try/catch块中，这里我就再也不示范了。
总结
这篇文章是对我以前写的C#中的委托和事件的一个补充，大体分为了三个部分，第一部分讲述了几个容易让人产生困惑的问题：为何使用事件而不是委托变量，为何一般委托的定义都返回void；第二部分讲述了如何处理异常和超时；第三部分则讲述了经过委托实现异步方法的调用。
感谢阅读，但愿这篇文章能给你带来帮助。
- 1. C#中委托和事件
- 2. 【22】C# 委托
- 3. C#中的事件委托
- 4. C# 中的委托和事件
- 5. C#中的委托和事件
- 6. *****c#中的委托和事件
- 7. C#中的委托和事件(续)
- 8. 理解C#中的委托和事件
- 9. c#中的delegate（委托）和event（事件）
- 10. C#中委托和事件的区别
- 更多相关文章...
- • C# 委托（Delegate） - C#教程
- • kotlin 委托 - Kotlin 教程
- • 委托模式
- • C# 中 foreach 遍历的用法
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. C#中委托和事件
- 2. 【22】C# 委托
- 3. C#中的事件委托
- 4. C# 中的委托和事件
- 5. C#中的委托和事件
- 6. *****c#中的委托和事件
- 7. C#中的委托和事件(续)
- 8. 理解C#中的委托和事件
- 9. c#中的delegate（委托）和event（事件）
- 10. C#中委托和事件的区别