C# 中的委託和事件(1)

標籤：http   使用   strong   os   width   io   

引言

委託 和 事件在 .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

實際上，我們可以也可以繞過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#》等相關書籍，這裡就不再討論了。