讲故事谈.NET委托:一个C#睡前故事

从前，在南方一块奇异的土地上，有个工人名叫彼得，他非常勤奋，对他的老板总是百依百顺。但是他的老板是个吝啬的人，从不信任别人，坚决要求随时知道彼得的工作进度，以防止他偷懒。但是彼得又不想让老板呆在他的办公室里站在背后盯着他，于是就对老板做出承诺：无论何时，只要我的工作取得了一点进展我都会及时让你知道。彼得通过周期性地使用“带类型的引用”(原文为：“typed reference” 也就是delegate？？)“回调”他的老板来实现他的承诺，

如下：

 1  class  Worker {
 2       public   void  Advise(Boss boss) { _boss  =  boss; }
 3       public   void  DoWork() {
 4          Console.WriteLine(“工作: 工作开始”);
 5           if ( _boss  !=   null  ) _boss.WorkStarted();
 6 
 7          Console.WriteLine(“工作: 工作进行中”);
 8           if ( _boss  !=   null  ) _boss.WorkProgressing();
 9 
10          Console.WriteLine( " “工作: 工作完成” " );
11           if ( _boss  !=   null  ) {
12               int  grade  =  _boss.WorkCompleted();
13              Console.WriteLine(“工人的工作得分＝”  +  grade);
14      }
15  }
16  private  Boss _boss;
17  }
18 
19  class  Boss {
20       public   void  WorkStarted() { }
21       public   void  WorkProgressing() { }
22       public   int  WorkCompleted() {
23          Console.WriteLine(“时间差不多！”);
24           return   2 ;
25      }
26  }
27 
28  class  Universe {
29       static   void  Main() {
30          Worker peter  =   new  Worker();
31          Boss boss  =   new  Boss();
32          peter.Advise(boss);
33          peter.DoWork();
34 
35          Console.WriteLine(“Main: 工人工作完成”);
36          Console.ReadLine();
37      }
38  }

接口

　　现在，彼得成了一个特殊的人，他不但能容忍吝啬的老板，而且和他周围的宇宙也有了密切的联系，以至于他认为宇宙对他的工作进度也感兴趣。不幸的是，他必须也给宇宙添加一个特殊的回调函数Advise来实现同时向他老板和宇宙报告工作进度。彼得想要把潜在的通知的列表和这些通知的实现方法分离开来，于是他决定把方法分离为一个接口：

 1  interface  IWorkerEvents {
 2       void  WorkStarted();
 3       void  WorkProgressing();
 4       int  WorkCompleted();
 5  }
 6 
 7  class  Worker {
 8       public   void  Advise(IWorkerEvents events) { _events  =  events; }
 9       public   void  DoWork() {
10          Console.WriteLine(“工作: 工作开始”);
11           if ( _events  !=   null  ) _events.WorkStarted();
12 
13          Console.WriteLine(“工作: 工作进行中”);
14           if (_events  !=   null  ) _events.WorkProgressing();
15 
16          Console.WriteLine( " “工作: 工作完成” " );
17           if (_events  !=   null  ) {
18               int  grade  =  _events.WorkCompleted();
19 
20              Console.WriteLine(“工人的工作得分＝”  +  grade);
21              }
22      }
23       private  IWorkerEvents _events;
24  }
25 
26  class  Boss : IWorkerEvents {
27       public   void  WorkStarted() { }
28       public   void  WorkProgressing() { }
29       public   int  WorkCompleted() {
30          Console.WriteLine(“时间差不多！”);
31           return   3 ;
32      }
33  }

委托

　　不幸的是，每当彼得忙于通过接口的实现和老板交流时，就没有机会及时通知宇宙了。至少他应该忽略身在远方的老板的引用，好让其他实现了IWorkerEvents的对象得到他的工作报告。（”At least he'd abstracted the reference of his boss far away from him so that others who implemented the IWorkerEvents interface could be notified of his work progress” 原话如此，不理解到底是什么意思）

　　他的老板还是抱怨得很厉害。“彼得！”他老板吼道，“你为什么在工作一开始和工作进行中都来烦我？！我不关心这些事件。你不但强迫我实现了这些方法，而且还在浪费我宝贵的工作时间来处理你的事件，特别是当我外出的时候更是如此！你能不能不再来烦我？”

　　于是，彼得意识到接口虽然在很多情况都很有用，但是当用作事件时，“粒度”不够好。他希望能够仅在别人想要时才通知他们，于是他决定把接口的方法分离为单独的委托，每个委托都像一个小的接口方法：

 1  delegate   void  WorkStarted();
 2  delegate   void  WorkProgressing();
 3  delegate   int  WorkCompleted();
 4 
 5  class  Worker {
 6       public   void  DoWork() {
 7          Console.WriteLine(“工作: 工作开始”);
 8           if ( started  !=   null  ) started();
 9 
10          Console.WriteLine(“工作: 工作进行中”);
11           if ( progressing  !=   null  ) progressing();
12 
13          Console.WriteLine( " “工作: 工作完成” " );
14           if ( completed  !=   null  ) {
15               int  grade  =  completed();
16              Console.WriteLine(“工人的工作得分＝”  +  grade);
17          }
18      }
19       public  WorkStarted started;
20       public  WorkProgressing progressing;
21       public  WorkCompleted completed;
22  }
23 
24  class  Boss {
25       public   int  WorkCompleted() {
26      Console.WriteLine( " Better " );
27       return   4 ;
28  }
29  }
30 
31  class  Universe {
32       static   void  Main() {
33          Worker peter  =   new  Worker();
34          Boss boss  =   new  Boss();
35          peter.completed  =   new  WorkCompleted(boss.WorkCompleted);
36          peter.DoWork();
37 
38          Console.WriteLine(“Main: 工人工作完成”);
39          Console.ReadLine();
40      }
41  }

静态监听者

　　这样，彼得不会再拿他老板不想要的事件来烦他老板了，但是他还没有把宇宙放到他的监听者列表中。因为宇宙是个包涵一切的实体，看来不适合使用实例方法的委托（想像一下，实例化一个“宇宙”要花费多少资源…..），于是彼得就需要能够对静态委托进行挂钩，委托对这一点支持得很好：

 1  class  Universe {
 2       static   void  WorkerStartedWork() {
 3          Console.WriteLine( " Universe notices worker starting work " );
 4      }
 5 
 6       static   int  WorkerCompletedWork() {
 7          Console.WriteLine( " Universe pleased with worker's work " );
 8           return   7 ;
 9      }
10 
11       static   void  Main() {
12          Worker peter  =   new  Worker();
13          Boss boss  =   new  Boss();
14          peter.completed  =   new  WorkCompleted(boss.WorkCompleted);
15          peter.started  =   new  WorkStarted(Universe.WorkerStartedWork);
16          peter.completed  =   new  WorkCompleted(Universe.WorkerCompletedWork);
17          peter.DoWork();
18 
19          Console.WriteLine(“Main: 工人工作完成”);
20          Console.ReadLine();
21      }
22  }

事件

　　不幸的是，宇宙太忙了，也不习惯时刻关注它里面的个体，它可以用自己的委托替换了彼得老板的委托。这是把彼得的Worker类的的委托字段做成public的一个无意识的副作用。同样，如果彼得的老板不耐烦了，也可以决定自己来激发彼得的委托（真是一个粗鲁的老板）：

// Peter's boss taking matters into his own hands
if( peter.completed != null ) peter.completed();

　　彼得不想让这些事发生，他意识到需要给每个委托提供“注册”和“反注册”功能，这样监听者就可以自己添加和移除委托，但同时又不能清空整个列表也不能随意激发彼得的事件了。彼得并没有来自己实现这些功能，相反，他使用了event关键字让C#编译器为他构建这些方法

1  class  Worker {
2 
3       public   event  WorkStarted started;
4       public   event  WorkProgressing progressing;
5       public   event  WorkCompleted completed;
6  }
7 
8 

彼得知道event关键字在委托的外边包装了一个property，仅让C#客户通过+= 和 -=操作符来添加和移除，强迫他的老板和宇宙正确地使用事件。

 1  static   void  Main() {
 2      Worker peter  =   new  Worker();
 3      Boss boss  =   new  Boss();
 4      peter.completed  +=   new  WorkCompleted(boss.WorkCompleted);
 5      peter.started  +=   new  WorkStarted(Universe.WorkerStartedWork);
 6      peter.completed  +=   new  WorkCompleted(Universe.WorkerCompletedWork);
 7      peter.DoWork();
 8 
 9      Console.WriteLine(“Main: 工人工作完成”);
10      Console.ReadLine();
11  }

“收获”所有结果

　　到这时，彼得终于可以送一口气了，他成功地满足了所有监听者的需求，同时避免了与特定实现的紧耦合。但是他注意到他的老板和宇宙都为它的工作打了分，但是他仅仅接收了一个分数。面对多个监听者，他想要“收获”所有的结果，于是他深入到代理里面，轮询监听者列表，手工一个个调用：

 1  public   void  DoWork() {
 2      
 3      Console.WriteLine( " “工作: 工作完成” " );
 4       if ( completed  !=   null  ) {
 5           foreach ( WorkCompleted wc  in  completed.GetInvocationList() ) {
 6               int  grade  =  wc();
 7              Console.WriteLine(“工人的工作得分＝”  +  grade);
 8          }
 9      }
10  }

异步通知：激发 & 忘掉

　　同时，他的老板和宇宙还要忙于处理其他事情，也就是说他们给彼得打分所花费的事件变得非常长：

 1  class  Boss {
 2       public   int  WorkCompleted() {
 3          System.Threading.Thread.Sleep( 3000 );
 4          Console.WriteLine( " Better " );  return   6 ;
 5      }
 6  }
 7 
 8  class  Universe {
 9       static   int  WorkerCompletedWork() {
10          System.Threading.Thread.Sleep( 4000 );
11          Console.WriteLine( " Universe is pleased with worker's work " );
12           return   7 ;
13      }
14      
15  }

很不幸，彼得每次通知一个监听者后必须等待它给自己打分，现在这些通知花费了他太多的工作事件。于是他决定忘掉分数，仅仅异步激发事件：

 1  public   void  DoWork() {
 2      
 3      Console.WriteLine( " “工作: 工作完成” " );
 4       if ( completed  !=   null  ) {
 5           foreach ( WorkCompleted wc  in  completed.GetInvocationList() )
 6          {
 7              wc.BeginInvoke( null ,  null );
 8          }
 9      }
10  }

异步通知：轮询

　　这使得彼得可以通知他的监听者，然后立即返回工作，让进程的线程池来调用这些代理。随着时间的过去，彼得发现他丢失了他工作的反馈，他知道听取别人的赞扬和努力工作一样重要，于是他异步激发事件，但是周期性地轮询，取得可用的分数。

 1  public   void  DoWork() {
 2      
 3      Console.WriteLine( " “工作: 工作完成” " );
 4       if ( completed  !=   null  ) {
 5           foreach ( WorkCompleted wc  in  completed.GetInvocationList() ) {
 6              IAsyncResult res  =  wc.BeginInvoke( null ,  null );
 7               while (  ! res.IsCompleted ) System.Threading.Thread.Sleep( 1 );
 8               int  grade  =  wc.EndInvoke(res);
 9              Console.WriteLine(“工人的工作得分＝”  +  grade);
10          }
11      }
12  }

异步通知：委托

　　不幸地，彼得有回到了一开始就想避免的情况中来，比如，老板站在背后盯着他工作。于是，他决定使用自己的委托作为他调用的异步委托完成的通知，让他自己立即回到工作，但是仍可以在别人给他的工作打分后得到通知：

 1  public   void  DoWork() {
 2          
 3          Console.WriteLine( " “工作: 工作完成” " );
 4           if ( completed  !=   null  ) {
 5               foreach ( WorkCompleted wc  in  completed.GetInvocationList() ) {
 6                  wc.BeginInvoke( new  AsyncCallback(WorkGraded), wc);
 7              }
 8          }
 9      }
10 
11       private   void  WorkGraded(IAsyncResult res) {
12          WorkCompleted wc  =  (WorkCompleted)res.AsyncState;
13           int  grade  =  wc.EndInvoke(res);
14          Console.WriteLine(“工人的工作得分＝”  +  grade);
15      }

宇宙中的幸福

　　彼得、他的老板和宇宙最终都满足了。彼得的老板和宇宙可以收到他们感兴趣的事件通知，减少了实现的负担和非必需的往返“差旅费”。彼得可以通知他们，而不管他们要花多长时间来从目的方法中返回，同时又可以异步地得到他的结果。彼得知道，这并不*十分*简单，因为当他异步激发事件时，方法要在另外一个线程中执行，彼得的目的方法完成的通知也是一样的道理。但是，迈克和彼得是好朋友，他很熟悉线程的事情，可以在这个领域提供指导。

　　他们永远幸福地生活下去……<完>