C# 中的委託和事件

ForTechnology發表於2013-02-26
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

輸出為： 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 sealed 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中委託、事件的實現方式。

希望這篇文章能給你帶來幫助。

原文：http://www.tracefact.net/CSharp-Programming/Delegates-and-Events-in-CSharp.aspx

相關文章