前言 對於搞.net的朋友來說,經常會遇到關於事件和委托的問題:事件與委托有什麼關係?事件的本質是什麼?委托的本質又是什麼?由於.net 做了大量的封裝,對於初學者,這兩個概念確實不怎麼好理解。事件是用戶與應用程式交互的基礎,它是回調機制的一種應用。舉個例子,當用戶點擊按鈕時,我們希望彈出一句“您好 ...
前言
對於搞.net的朋友來說,經常會遇到關於事件和委托的問題:事件與委托有什麼關係?事件的本質是什麼?委托的本質又是什麼?由於.net 做了大量的封裝,對於初學者,這兩個概念確實不怎麼好理解。事件是用戶與應用程式交互的基礎,它是回調機制的一種應用。舉個例子,當用戶點擊按鈕時,我們希望彈出一句“您好”;這裡的【點擊】就是一個事件;那麼回調就是我們註冊一個方法,當用戶點擊時,程式自動執行這個方法去響應這個操作,而不是我們時刻去監聽用戶有沒有點擊。
上一篇已經介紹了委托的相關知識,它就是.net用來實現回調機制的技術,而事件又是回調機制的一種應用,在學習事件前,應該先學習好委托的知識。有了委托的基礎,接下來就讓我們一步步走進事件。
一、使用事件
假設場景:有一個郵件管理員(事件擁有者),它賦值接收郵件,當郵件到來時(事件),郵件可以交給傳真員和列印員處理(事件訂閱者)。很明顯,郵件到來的時間只有郵件管理員知道,傳真員和列印員也不可能時刻去詢問有沒有新郵件,而是應該由管理員主動來通知(回調),但他們也要先告訴管理員,新郵件到來時,我需要處理(訂閱)。這裡接收新郵件就是一個事件,郵件有一定的信息(事件附加信息),例如:發送人、接收人,內容。接下來我們通過這個過程來瞭解事件。
1. 定義事件所需要的附加信息
按照約定,所有的事件的附加信息都應該從EventArgs派生,因為我們希望一看就知道這是個事件附加信息參數,而不是其它的。EventArgs的定義如下:
public class EventArgs { public static readonly EventArgs Empty = new EventArgs(); public EventArgs() {} }
可以看到,該類有一個靜態只讀欄位Empty,這是一個單例;與String.Empty一樣,當我們需要一個空的EventArgs時,應該使用EventArgs.Empty,而不是重新去new一個。
我們定義一個NewMailEventArgs參數,如下:
class NewMailEventArgs : EventArgs { private string from; private string to; private string content; public string From { get { return from; } } public string To { get { return to; } } public string Content { get { return content; } } public NewMailEventArgs(string from,string to,string content) { this.from = from; this.to = to; this.content = content; } }
2. 定義事件
c#里定義事件用到了event關鍵字,而且事件一般都是公開類型的。我們定義一個NewMail事件如下:
public event EventHandler<NewMailEventArgs> NewMail;
我們說NewMail是一個事件,但.net並沒有事件這種類型。實際上,這裡它是一個EventHandler<TEventArgs>委托(委托又是引用類型),只不過用了event進行修飾,也可以說它是一種具有事件性質的委托。
我們知道委托是用來包裝回調函數的,它的本質是一個class,回調函數的簽名必須與委托的簽名一致。一個事件可以有多個處理函數,一個函數就會被包裝成一個委托對象,所有的委托對象都保存在NewMail的委托鏈當中。所以,觸發NewMail事件,其實就是遍歷其指向的委托對象的委托鏈,執行每個委托對象所包裝的方法。(不清楚可以看委托)
EventHandler 是個泛型委托,他的定義如下:
public delegate void EventHandler<TEventArgs>(object sender, TEventArgs e);
這裡有兩個特點:1. 返回值是void,這是因為事件處理函數一般不需要有返回值,.net中大部分的事件處理函數都是沒有返回值的。2. object類型的sender參數,這表示事件的擁有者;這也很符合邏輯,我們除了要拿到實際的附加信息外,還要知道事件是從哪裡來的;至於為什麼是object類型的,是因為這樣可以給更多的類型使用。
3. 定義事件觸發函數
//3.定義觸發事件的方法 protected virtual void OnNewMail(NewMailEventArgs e) { /* 第1種做法 if(this.NewMail != null) { this.NewMail(this,e); } */ /* 第二種做法 EventHandler<NewMailEventArgs> temp = this.NewMail; if (temp != null) { temp(this, e); } */ //第三種做法 EventHandler<NewMailEventArgs> temp = Interlocked.CompareExchange(ref this.NewMail, null, null); if (temp != null) { temp(this, e); } }
第一種做法是很常見的做法,判斷不為空,然後就觸發。CLR里提到這是線程不安全的做法,因為單我們判斷不為空後,準備執行時,另一個線程將從委托鏈將委托移除,此時變成了空,引發NullReferenceException異常。第二、三種做法都是線程安全的,因為它通過一個臨時委托變數(委托鏈保存了所有委托),通過上一篇對委托鏈的瞭解,我們知道對委托鏈進行Combine/Remove實際都會創建一個新的數組對象,此時對temp沒有影響。但實際上事件主要在單線程的環境下使用,所以一般也不會出現這種問題。
4. 包裝好事件參數,調用事件觸發函數。
public void ReceiveNewMail(string from, string to, string content) { NewMailEventArgs e = new NewMailEventArgs(from, to, content); OnNewMail(e); }
接下來,對該事件感興趣的,就可以對該事件進行註冊。
class Fax { public Fax(MailManager mm) { mm.NewMail += FaxMsg; } private void FaxMsg(object sender, NewMailEventArgs e) { Console.WriteLine(string.Format("fax receive,from:{0} to:{1} content is:{2}", e.From, e.To, e.Content)); } }
二、事件揭秘
前面我們已經提到事件的本質是委托,或者說是委托的一種應用。要深入理解事件,我們通過ILDasm.exe查到定義事件而生成的代碼。
public event EventHandler<NewMailEventArgs> NewMail;
可以看到當我們定義一個NewEvent時,編譯器幫我們生成了:1. 一個private NewMail 欄位,類型為 EventHandler<NewMailEventArgs>。 2.一個 add_NewMail 方法,用於將委托添加到委托鏈(內部調用了Delegate.Combine方法)。3.一個 remove_NewMail 方法,用於將委托從委托鏈移除(內部調用了Delegate.Remove方法)。對事件的操作,就是是對NewMail欄位的操作。
現在我們知道了,事件的本質就是委托,定義事件就是定義委托。只不過編譯器隱藏了這個過程。那為什麼不直接使用委托呢?
三、為什麼不直接用委托
我們知道,事件的本質是委托,那用事件實現的地方,用委托也完成可以實現。上面的代碼,我們完全可能這樣寫來達到相同的目的:
class MailManager { public EventHandler<EventArgs> NewMail; public void RaiseNewMail() { if (NewMail != null) { NewMail(this, EventArgs.Empty); } } }
外部調用:
class Fax { public Fax(MailManager mm) { mm.NewMail += FaxNewMail; } public void FaxNewMail(object sender, EventArgs e) { Console.WriteLine("Fax New Mail 處理成功"); } }
對於維護對象狀態的欄位我們往往不設計為公開類型,因為外部完全可以隨意改變它,這不是我們想看到的。例如上面那樣寫,我們可以在外部直接就調用NewMail的Invoke方法。而且對於欄位,我們無法控制具體的獲取和設置過程,要控制就需要定義一個Get_ 方法,一個Set_方法,對於委托類型來說,就是Add_和Remove_。對於每個事件,都去定義Add_/Remove_是非常麻煩的。說到這裡我們會馬上連想到屬性的設計,沒錯,屬性是用Get_/Set_方法提供訪問私有欄位(非委托)的方法,事件就是用Add_/Remove_方法提供訪問私有委托欄位的方法。
四、顯示實現事件
我們知道隱式實現屬性時,編譯器會為我們生成一個private的欄位,例如:public string Name{get;set;} 會自動生成一個 _name欄位。但是我們顯示實現時,編譯器就不會為生成了。例如下麵的寫法:
public string Name { get{return "Tom";} set{} }
對於事件來說顯示實現就是:
private EventHandler<NewMailEventArgs> _newMail; public event EventHandler<NewMailEventArgs> NewMail { add { _newMail += value; } remove { _newMail -= value; } }
Control 的 EventHandlerList
對於 Control 來說,它定義了大量的事件(定義事件就是定義委托),而這些事件不一定都會用到,所以這會浪費大量的記憶體。所以 Control 里的事件都是顯示實現的,並且將委托保存在一個EventHandlerList集合中,這是一個key-value的集合。這樣需要處理哪些事件就只要添加相應的委托即可,看起來像是這樣的:
class Control { private EventHandlerList events; protected EventHandlerList Events { get { if (this.events == null) { this.events = new EventHandlerList(); } return this.events; } } private static readonly object _clickEventObj = new object(); private static readonly object _mouseOverEventObj = new object(); public event EventHandler<EventArgs> Click { add { this.Events.AddHandler(_clickEventObj, value); } remove { this.Events.RemoveHandler(_clickEventObj, value); } } public event EventHandler<EventArgs> MouseOver { add { this.Events.AddHandler(_mouseOverEventObj, value); } remove { this.Events.RemoveHandler(_mouseOverEventObj, value); } } }
也就是我們針對每個事件定義一個 object 類型作為集合的key,雖然會定義許多object,但object的代價比委托的要小很多。
至此我們應該知道:委托的本質是引用類型,用於包裝回調函數,委托用於實現回調機制;事件的本質是委托,事件是回調機制的一種應用。