快捷導(dǎo)航

C# 事件的設(shè)計(jì)與使用深入理解

更新時(shí)間：2012年12月24日 16:34:18 作者：

事件是用于通知其他對(duì)象發(fā)生了本對(duì)象發(fā)生了特定的事情的類型成員;事件是.NET類型成員中相對(duì)較為難以理解和實(shí)踐的一個(gè)成員,因?yàn)槭录亩x不是繼承自基礎(chǔ)的數(shù)據(jù)類型,而是對(duì)委托(delegate)的封裝。所以，在了解事件之前，你需要先了解一點(diǎn)委托

相關(guān)概念

定義：事件是用于通知其他對(duì)象發(fā)生了本對(duì)象發(fā)生了特定的事情的類型成員。
說明：事件是.NET類型成員中相對(duì)較為難以理解和實(shí)踐的一個(gè)成員,因?yàn)槭录亩x不是繼承自基礎(chǔ)的數(shù)據(jù)類型,而是對(duì)委托(delegate)的封裝。所以，在了解事件之前，你需要先了解一點(diǎn)委托。
應(yīng)用場景：事件的應(yīng)用場景非常廣泛，其中最常見的場景是在各個(gè)前端控件中的大量觸發(fā)事件設(shè)計(jì)。原因是因?yàn)?
意義：事件成員的使用有利于在程序中對(duì)面向?qū)ο笤瓌t的實(shí)現(xiàn)。例如類型的單一職責(zé)原則，控制反轉(zhuǎn)原則。設(shè)想如果前端控件不能抽象出大量豐富的事件，那幾乎不能將前端的UI元素與業(yè)務(wù)邏輯脫鉤。程序必然高度耦合。
設(shè)計(jì)模式的應(yīng)用：經(jīng)典設(shè)計(jì)模式中的觀察者模式就非常依賴于對(duì)事件成員的設(shè)計(jì)而實(shí)現(xiàn)。
本章將通過設(shè)計(jì)一個(gè)電子郵件到達(dá)時(shí)，觸發(fā)事件的場景來解析對(duì)事件提供者和訂閱者類型的設(shè)計(jì)。案例來源于《CLR Via C#》一書。

事件提供者類型的設(shè)計(jì)

一. 定義類型來容納所有需要發(fā)送給事件訂閱者的附加信息

目標(biāo)：定義一個(gè)類型用于向事件的訂閱者傳遞信息
方法：繼承默認(rèn)的System.EventArgs類型，實(shí)現(xiàn)簡單的需要傳遞信息的字段，屬性以及實(shí)例構(gòu)造器成員。示例如下：

復(fù)制代碼代碼如下:

using System; 
using System.Linq; 

namespace ConsoleTest 
{ 
public class NewMailEventArgs : EventArgs 
{ 
private readonly string from, to, subject; 

public NewMailEventArgs(string from, string to, string subject) 
{ 
this.from = from; 
this.to = to; 
this.subject = subject; 
} 

public string Subject 
{ 
get 
{ 
return this.subject; 
} 
} 

public string To 
{ 
get 
{ 
return this.to; 
} 
} 

public string From 
{ 
get 
{ 
return this.from; 
} 
} 
} 
}

二. 定義事件成員

目標(biāo)：在事件提供者類型中定義一個(gè)事件成員，用于事件訂閱者對(duì)象的注冊(cè)。
方法：封裝一個(gè)自定義委托，來提供事件處理方法的模板；或者實(shí)現(xiàn)一個(gè)System.EventHandler的泛型類型來達(dá)到一樣的效果。（EventHandler是一個(gè)默認(rèn)提供的已封裝的委托）。兩種方法的示例分別如下：
方法一：

復(fù)制代碼代碼如下:

public delegate void NewMailHandler(object e, NewMailEventArgs args); 

public class MailManager 
{ 
public event NewMailHandler NewMail; 
}

方法二：

復(fù)制代碼代碼如下:

public class MailManager 
{ 
public event EventHandler<NewMailEventArgs> NewMail; 
}

為什么這兩種方法能夠達(dá)到同樣的效果，查看一下System.EventHandler的定義就能知曉：

復(fù)制代碼代碼如下:

namespace System 
{ 
// 摘要: 
// 表示將處理事件的方法。 
// 
// 參數(shù): 
// sender: 
// 事件源。 
// 
// e: 
// 一個(gè)包含事件數(shù)據(jù)的 System.EventArgs。 
// 
// 類型參數(shù): 
// TEventArgs: 
// 由該事件生成的事件數(shù)據(jù)的類型。 
[Serializable] 
public delegate void EventHandler<TEventArgs>(object sender, TEventArgs e); 
}

三. 定義一個(gè)統(tǒng)一觸發(fā)事件的方法入口來通知事件的訂閱對(duì)象

目標(biāo)：在事件提供者類型中定義一個(gè)方法成員，用來統(tǒng)一的引發(fā)目標(biāo)事件。
說明：為了保證這個(gè)方法只能在本類型及派生類型中調(diào)用，我們需要將方法修飾為protected, 為了讓派生類型可以重寫這個(gè)方法，我們需要將該方法修飾為virtual
意義：這個(gè)統(tǒng)一入口方法的意義在于，能夠統(tǒng)一維護(hù)觸發(fā)事件的方式，并且能夠確保事件調(diào)用的線程安全性。（避免在不同的線程觸發(fā)時(shí)，事件訂閱者的狀態(tài)不同步）
示例如下：

復(fù)制代碼代碼如下:

public class MailManager 
{ 
public event EventHandler<NewMailEventArgs> NewMail; 

protected virtual void OnNewMail(NewMailEventArgs e) 
{ 
//處于線程安全的考慮，現(xiàn)在將對(duì)委托字段的引用復(fù)制到一個(gè)臨時(shí)字段中 
EventHandler<NewMailEventArgs> temp = System.Threading.Interlocked.CompareExchange 
(ref NewMail, null, null); 

//如果有事件訂閱者對(duì)象的存在，則通知他們，事件已觸發(fā) 
if (temp != null) 
temp(this, e); 
} 
}

四. 在所有需要觸發(fā)事件的業(yè)務(wù)方法中，調(diào)用第三步中定義的方法

目標(biāo)：在類型中還需要有一個(gè)業(yè)務(wù)方法，來將業(yè)務(wù)中的場景轉(zhuǎn)化為事件觸發(fā)。。
方法：在任意需要的業(yè)務(wù)方法中，直接調(diào)用第三步的方法就可以了，不過需要實(shí)現(xiàn)封裝一個(gè)傳遞信息的類型。
示例如下：

復(fù)制代碼代碼如下:

public class MailManager 
{ 
public event EventHandler<NewMailEventArgs> NewMail; 

protected virtual void OnNewMail(NewMailEventArgs e) 
{ 
//處于線程安全的考慮，現(xiàn)在將對(duì)委托字段的引用復(fù)制到一個(gè)臨時(shí)字段中 
EventHandler<NewMailEventArgs> temp = System.Threading.Interlocked.CompareExchange 
(ref NewMail, null, null); 

//如果有事件訂閱者對(duì)象的存在，則通知他們，事件已觸發(fā) 
if (temp != null) 
temp(this, e); 
} 

public void SimulateNewMail(string from, string to, string subject) 
{ 
//構(gòu)造一個(gè)對(duì)象來封裝向傳給事件訂閱者的信息 
NewMailEventArgs e = new NewMailEventArgs(from, to, subject); 

//觸發(fā)事件引發(fā)的入口方法 
OnNewMail(e); 
} 
}

事件訂閱者類型的設(shè)計(jì)

一. 定義類型來訂閱和偵聽事件

目標(biāo)：設(shè)計(jì)一個(gè)傳真類型Fax類來偵聽NewMail事件。
說明：Fax類型中需要具備對(duì)NewMail事件的訂閱和取消訂閱的方法。示例如下：

復(fù)制代碼代碼如下:

internal sealed class Fax 
{ 
private MailManager mailManager; 

public Fax(MailManager mm) 
{ 
this.mailManager = mm; 
} 

public void Register() 
{ 
mailManager.NewMail += new EventHandler<NewMailEventArgs>(FaxMsg); 
} 

void FaxMsg(object sender, NewMailEventArgs e) 
{ 
Console.WriteLine("Fax mail message"); 
Console.WriteLine("From = {0}, To = {1}, Subject = {2}", e.From, e.To, e.Subject); 
} 

public void Unregister() 
{ 
mailManager.NewMail -= FaxMsg; 
} 
}