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結尾。
再做一下說明:
委托聲明原型中的Object類型的參數代表了Subject,也就是監視對象,在本例中是 Heater(熱水器)。回調函數(比如Alarm的MakeAlert)可以通過它訪問觸發事件的對象(Heater)。
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中委托、事件的實現方式。
希望這篇文章能給你帶來幫助。
引言
委托 和 事件在 .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
早上好, 張子陽
讓我們再次對委托作個總結:
使用委托可以將多個方法綁定到同一個委托變量,當調用此變量時(這裡用“調用”這個詞,是因為此變量代表一個方法),可以依次調用所有綁定的方法。