C# 事件的設計與使用深入理解

相關概念

定義：事件是用於通知其他對象發生了本對象發生了特定的事情的類型成員。
說明：事件是.NET類型成員中相對較為難以理解和實踐的一個成員,因為事件的定義不是繼承自基礎的資料類型,而是對委託(delegate)的封裝。所以，在瞭解事件之前，你需要先瞭解一點委託。
應用情境：事件的應用情境非常廣泛，其中最常見的情境是在各個前端控制項中的大量觸發事件設計。原因是因為
意義：事件成員的使用有利於在程式中對物件導向原則的實現。例如類型的單一職責原則，控制反轉原則。設想如果前端控制項不能抽象出大量豐富的事件，那幾乎不能將前端的UI元素與商務邏輯脫鉤。程式必然高度耦合。
設計模式的應用：經典設計模式中的觀察者模式就非常依賴於對事件成員的設計而實現。
本章將通過設計一個電子郵件到達時，觸發事件的情境來解析對事件提供者和訂閱者類型的設計。案例來源於《CLR Via C#》一書。

事件提供者類型的設計

一. 定義類型來容納所有需要發送給事件訂閱者的附加資訊

目標：定義一個類型用於向事件的訂閱者傳遞資訊
方法：繼承預設的System.EventArgs類型，實現簡單的需要傳遞資訊的欄位，屬性以及執行個體構造器成員。樣本如下： 複製代碼 代碼如下: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;
}
}
}
}

二. 定義事件成員

目標：在事件提供者類型中定義一個事件成員，用於事件訂閱者對象的註冊。
方法：封裝一個自訂委託，來提供事件處理方法的模板；或者實現一個System.EventHandler的泛型型別來達到一樣的效果。（EventHandler是一個預設提供的已封裝的委託）。兩種方法的樣本分別如下：
方法一：

複製代碼 代碼如下:public delegate void NewMailHandler(object e, NewMailEventArgs args);

public class MailManager
{
public event NewMailHandler NewMail;
}

方法二：複製代碼 代碼如下:public class MailManager
{
public event EventHandler<NewMailEventArgs> NewMail;
}

為什麼這兩種方法能夠達到同樣的效果，查看一下System.EventHandler的定義就能知曉： 複製代碼 代碼如下:namespace System
{
// 摘要:
// 表示將處理事件的方法。
//
// 參數:
// sender:
// 事件來源。
//
// e:
// 一個包含事件數目據的 System.EventArgs。
//
// 型別參數:
// TEventArgs:
// 由該事件產生的事件數目據的類型。
[Serializable]
public delegate void EventHandler<TEventArgs>(object sender, TEventArgs e);
}

三. 定義一個統一觸發事件的方法入口來通知事件的訂閱對象

目標：在事件提供者類型中定義一個方法成員，用來統一的引發目標事件。
說明：為了保證這個方法只能在本類型及衍生類別型中調用，我們需要將方法修飾為protected, 為了讓衍生類別型可以重寫這個方法，我們需要將該方法修飾為virtual
意義：這個統一入口方法的意義在於，能夠統一維護觸發事件的方式，並且能夠確保事件調用的執行緒安全性。（避免在不同的線程觸發時，事件訂閱者的狀態不同步）
樣本如下：

複製代碼 代碼如下:public class MailManager
{
public event EventHandler<NewMailEventArgs> NewMail;

protected virtual void OnNewMail(NewMailEventArgs e)
{
//處於安全執行緒的考慮，現在將對委託欄位的引用複製到一個臨時欄位中
EventHandler<NewMailEventArgs> temp = System.Threading.Interlocked.CompareExchange
(ref NewMail, null, null);

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

四. 在所有需要觸發事件的業務方法中，調用第三步中定義的方法

目標：在類型中還需要有一個業務方法，來將業務中的情境轉化為事件觸發。。
方法：在任意需要的業務方法中，直接調用第三步的方法就可以了，不過需要實現封裝一個傳遞資訊的類型。
樣本如下：

複製代碼 代碼如下:public class MailManager
{
public event EventHandler<NewMailEventArgs> NewMail;

protected virtual void OnNewMail(NewMailEventArgs e)
{
//處於安全執行緒的考慮，現在將對委託欄位的引用複製到一個臨時欄位中
EventHandler<NewMailEventArgs> temp = System.Threading.Interlocked.CompareExchange
(ref NewMail, null, null);

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

public void SimulateNewMail(string from, string to, string subject)
{
//構造一個對象來封裝向傳給事件訂閱者的資訊
NewMailEventArgs e = new NewMailEventArgs(from, to, subject);

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

事件訂閱者類型的設計

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

目標：設計一個傳真類型Fax類來偵聽NewMail事件。
說明：Fax類型中需要具備對NewMail事件的訂閱和取消訂閱的方法。樣本如下： 複製代碼 代碼如下: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;
}
}