深入理解C#委托的實質
本文是博客園麒麟.NET的《把委托說透》系列的第二篇，重點剖析C#委托的實質。
委托在本質上仍然是一個類，我們用delegate關鍵字聲明的所有委托都繼承自System.MulticastDelegate。后者又是繼承自System.Delegate類，System.Delegate類則繼承自System.Object。委托既然是一個類，那么它就可以被定義在任何地方，即可以定義在類的內部，也可以定義在類的外部。
正如很多資料上所說的，委托是一種類型安全的函數(shù)回調機制， 它不僅能夠調用實例方法，也能調用靜態(tài)方法，并且具備按順序執(zhí)行多個方法的能力。
C#委托揭秘
在把委托說透（1）中可以看到，委托的使用其實是很簡單的。盡管如此，其內部實現(xiàn)仍然相當復雜。.NET強大的編譯器和CLR掩蓋了這種復雜性。
為了解釋方便，我們把（1）中的委托代碼復制在下面，并做一處小小的改動，將LogToTextFile設置為實例方法。
- namespace DelegateSample
- {
- public delegate void Log(string message);
- class UserService
- {
- public Log LogDelegate { get; set; }
- public UserService() { }
- public void Register(User user)
- {
- if (user.Name == "Kirin")
- {
- LogDelegate("注冊失敗，已經(jīng)包含名為" + user.Name + "的用戶");
- }
- else
- {
- LogDelegate("注冊成功！");
- }
- }
- }
- class Program
- {
- static void Main(string[] args)
- {
- User user = new User { Name = "Kirin", Password = "123" };
- UserService service = new UserService();
- service.LogDelegate = LogToConsole;
- Program p = new Program();
- service.LogDelegate += p.LogToTextFile;
- service.Register(user);
- Console.ReadLine();
- }
- static void LogToConsole(string message)
- {
- Console.WriteLine(message);
- }
- void LogToTextFile(string message)
- {
- using (StreamWriter sw = File.AppendText("log.txt"))
- {
- sw.WriteLine(message);
- sw.Flush();
- sw.Close();
- }
- }
- }
- }
打開Reflector反編譯Log委托，可以看到Log類被編譯為如下形式：
在上圖中可以得出如下結論：
委托是一個類
可以很清晰的看出Log—>MulticastDelegate—>Delegate這種繼承機制。
盡管委托繼承自System.MulticastDelegate類，但我們并不能顯示地聲明一個繼承自System.MulticastDelegate類的委托。委托必須使用delegate關鍵字聲明，編譯器會自動為我們生成繼承代碼。
由于委托繼承自System.MulticastDelegate類，自然也繼承MulticastDelegate類的字段、屬性和方法。這些成員中，最重要的當屬三個非公共字段，如下表所示：
字段名稱
字段類型
描述
_target
System.Object
該字段指明委托所調用的方法所在的實例類型。如果委托調用的為靜態(tài)方法，該字段為null；如果為實例方法則為該方法所在的對象。
_methodPtr
System.IntPtr
標識回調方法的指針。
_invocationList
System.Object
在構建委托鏈時指向一個委托數(shù)組，在委托剛剛構建時通常為null。
由上表可以看出，每個委托對象實際上是對方法及其調用時操作的對象的封裝。MulticastDelegate類還定義了兩個只讀公有實例屬性：Target和Method，分別對應_target和_methodPtr。Target屬性返回一個方法回調時操作的對象引用。如果是靜態(tài)方法則返回null。Method屬性返回一個標識回調方法的System.Reflection.MethodInfo對象。
編譯器自動為委托創(chuàng)建了BeginInvoke、EndInvoke和Invoke三個方法
當我們在像調用普通的方法一樣調用委托時，如
- LogDelegate("注冊失敗，已經(jīng)包含名為" + user.Name + "的用戶");
這時實際上調用的是編譯器自動生成的Invoke方法
- LogDelegate.Invoke("注冊失敗，已經(jīng)包含名為" + user.Name + "的用戶");
使用IL DASM查看UserService的IL代碼，可以驗證以上結論，如下圖所示：
在使用委托時，我們也可以顯示調用Invoke方法（CLR 2.0）。
Invoke方法的參數(shù)和返回值與委托是一致的。在調用Invoke方法時，會使用_target和_methodPtr字段。
BeginInvoke和EndInvoke方法用來實現(xiàn)異步調用，本文在此不進行討論。
委托鏈
委托鏈是一個委托的集合，它允許我們調用這個集合中的委托所代表的所有方法（對于有返回值的方法，委托鏈的返回值為鏈表中最后一個方法的返回值，本文后面會有詳細介紹）。在Delegate類中定義了3個靜態(tài)方法來幫助我們操作委托鏈。
- public static Delegate Combine(params Delegate[] delegates);
- public static Delegate Combine(Delegate a, Delegate b);
- public static Delegate Remove(Delegate source, Delegate value);
要理解委托鏈，我們首先基于前面的例子，重新聲明兩個委托：logDel1和logDel2。
- Log logDel1 = LogToConsole;
- Program p = new Program();
- Log logDel2 = p.LogToTextFile;
這兩個委托的_target、_methodPtr和_invocationList值分別如下圖所示：
構造委托鏈
然后，我們使用Combin方法來構造一個委托鏈：
- Log logChain = null;
- logChain = (Log)Delegate.Combine(logChain, logDel1);
由于logChain初始為null，在使用Combin方法構造委托鏈時，將返回另外一個參數(shù)logDel1，再將logDel1的引用賦給logChain。這時logChain將指向logDel1所指向的對象。
接下來我們將logDel2也添加到logChain中來：
- logChain = (Log)Delegate.Combine(logChain, logDel2);
此時，由于logChain已經(jīng)不再是null，將重新構建一個新的委托對象。該委托對象的_target和_methodPtr字段與logDel2（第二個參數(shù)）相同，_invocationList字段將指向一個委托數(shù)組。該委托數(shù)組中包含兩個元素，第一個元素（索引為0）指向封裝了LogToConsole方法的委托（即logDel1指向的委托）；第二個元素（索引為1）指向封裝了LogToTextFile方法的委托（即logDel2指向的委托）。最后，將這個新創(chuàng)建的委托對象的引用賦給logChain。
若再將一個新的委托l(wèi)ogDel3添加到委托鏈中，則仍然會構建一個新的委托對象，并將logDel3的引用添加到該委托對象_invocationList的末尾（此時鏈表共有3個元素）。然后，再將該委托對象的引用賦給logChain。而logChain之前指向的委托對象則等待垃圾回收。
至此，委托鏈構造完畢，我們來看看如何執(zhí)行委托鏈表中的委托。由于logChain仍然指向一個委托對象，因此執(zhí)行委托鏈表的語法與執(zhí)行委托是一樣的：
- logChain("執(zhí)行委托鏈");
與普通的委托（如logDel1）所不同的是，logChain的_invocationList字段不為null。這時將首先遍歷執(zhí)行_invocationList中的所有委托。所執(zhí)行的方法的順序與添加的順序一致，依次為LogToConsole、LogToTextFile。
委托Log的Invoke方法的實現(xiàn)用偽代碼表示如下：
- public void Invoke(string message)
- {
- Delegate[] delegateSet = _InvocationList as Delegate[];
- if (delegateSet != null)
- {
- // 如果委托數(shù)組不為空，則依次執(zhí)行該委托數(shù)組中的委托
- foreach (Feedback d in delegateSet)
- d(value);
- }
- else
- {
- // 如果委托數(shù)組為空，則該委托不代表一個委托鏈
- // 按照正常方式執(zhí)行該委托
- _methodPtr.Invoke(_target, value);
- }
- }
包含返回值的委托的Invoke實現(xiàn)如下，假設返回值為string：
- public string Invoke(string message)
- {
- string result = null;
- Delegate[] delegateSet = _InvocationList as Delegate[];
- if (delegateSet != null)
- {
- // 如果委托數(shù)組不為空，則依次執(zhí)行該委托數(shù)組中的委托
- foreach (Feedback d in delegateSet)
- result = d(value);
- }
- else
- {
- // 如果委托數(shù)組為空，則該委托不代表一個委托鏈
- // 按照正常方式執(zhí)行該委托
- result = _methodPtr.Invoke(_target, value);
- }
- return result;
- }
可以看到在委托鏈中，返回值為鏈表中最后一個委托的返回值。
那么如果對兩個委托鏈調用Combine方法呢？
- Log logChain = null;
- Log logChain1 = null;
- Log logChain2 = null;
- logChain1 = (Log)Delegate.Combine(logChain1, logDel1);
- logChain1 = (Log)Delegate.Combine(logChain1, logDel2);
- logChain2 = (Log)Delegate.Combine(logChain2, logDel3;
- logChain2 = (Log)Delegate.Combine(logChain2, logDel4;
- logChain = (Log)Delegate.Combine(logChain1, logChain2);
最終的結果是，logChain的_target和_methodPtr均與logDel4相同（確切地說，兩個委托對象的_methodPtr字段并不相同，但Method屬性是相同的），而_invocationList中委托的順序依次為logDel1、logDel2、logDel3、logDel4。
綜上所述，可以對Delegate.Combine(Delegate A, Delegate B)方法做如下總結：
1. 如果A和B均為null，則返回null。
2. 如果A或B一個為null而另一個不為null，則返回不為null的委托。
3. 如果A和B均不為null，返回一個新的委托，該委托
（1）_target字段與B的_target字段的值相同
（2）Method屬性與B的Method屬性的值相同
（3）_invocationList字段為一個委托數(shù)組，該數(shù)組中委托的順序為：A中_invacationList所指向的委托數(shù)組 + B中_invacationList所指向的委托數(shù)組。
移除委托鏈
Combine方法用來向委托鏈中添加一個委托，而Remove方法用來從委托鏈中移除一個委托。
logChain = (Log)Delegate.Remove(logChain, new Log(LogToConsole));
當調用Remove時，會遍歷（倒序）第一個參數(shù)（logChain）中的中的委托列表（_invocationList字段）， 找到與第二個參數(shù)（new Log(LogToConsole)）的_target和_methodPtr字段相匹配的委托，并將其從委托列表中移除。返回值需分以下幾種情況，為了描述方便，我們將logChain記為A，將new Log(LogToConsole)記為B。
1. 如果A為null，返回null。
2. 如果B為null，返回A。
3. 如果A的_invocationList為null，即不包含委托鏈，那么如果A本身與B匹配，則返回null，否則返回A。
4. 如果A的_invocationList中不包含與B匹配的委托，則返回A。
5. 如果A的_invocationList中包含與B匹配的委托，則從鏈表中移除B，然后
（1）如果A的鏈表中只剩下一個委托，則返回該委托。
（2）如果A的鏈表中還剩下多個委托，將重新構建一個新的委托R（R的_invocationList字段為A的_invocationList移除了B之后的鏈表），并返回R。
注意，Remove方法只移除源委托的_invocationList列表中第一個匹配的委托，要想移除所有匹配的委托，可以使用RemoveAll方法。
有了委托鏈，在（1）中提出的第二個疑問就迎刃而解了。當用戶希望使用多種日志記錄方式的時候，使用委托鏈可以輕松地添加和刪除某種日志記錄方式，從而避免了人為地維護一個列表。
總結
本文首先介紹了C#委托的實質，委托是一個類，它繼承自System.MulticastDelegate，而MulticastDelegate又繼承自System.Delegate。然后重點剖析了委托鏈，討論了如何創(chuàng)建和移除委托鏈。
【編輯推薦】
