.NET 事件模型教程（一） .code {padding: 10px 10px 10px 10px;font-family: 宋體;background-color: #ececec }

目錄

• 事件、事件處理程序概念
• 問題描述：一個需要較長時間才能完成的任務(wù)
• 高耦合的實現(xiàn)
• 事件模型的解決方案，簡單易懂的 VB.NET 版本
• 委托（delegate）簡介
• C# 實現(xiàn)
• 向“.NET Framework 類庫設(shè)計指南”靠攏，標準實現(xiàn)

事件、事件處理程序概念

在面向?qū)ο罄碚撝?#xff0c;一個對象（類的實例）可以有屬性（property，獲取或設(shè)置對象的狀態(tài)）、方法（method，對象可以做的動作）等成員外，還有事件（event）。所謂事件，是對象內(nèi)部狀態(tài)發(fā)生了某些變化、或者對象做某些動作時（或做之前、做之后），向外界發(fā)出的通知。打個比方就是，對象“張三”肚子疼了，然后他站在空地上大叫一聲“我肚子疼了！”事件就是這個通知。

那么，相對于對象內(nèi)部發(fā)出的事件通知，外部環(huán)境可能需要應對某些事件的發(fā)生，而做出相應的反應。接著上面的比方，張三大叫一聲之后，救護車來了把它接到醫(yī)院（或者瘋?cè)嗽?#xff0c;呵呵，開個玩笑）。外界因應事件發(fā)生而做出的反應（具體到程序上，就是針對該事件而寫的那些處理代碼），稱為事件處理程序（event handler）。

事件處理程序必須和對象的事件掛鉤后，才可能會被執(zhí)行。否則，孤立的事件處理程序不會被執(zhí)行。另一方面，對象發(fā)生事件時，并不一定要有相應的處理程序。就如張三大叫之后，外界環(huán)境沒有做出任何反應。也就是說，對象的事件和外界對該對象的事件處理之間，并沒有必然的聯(lián)系，需要你去掛接。

在開始學習之前，我希望大家首先區(qū)分“事件”和“事件處理程序”這兩個概念。事件是隸屬于對象（類）本身的，事件處理程序是外界代碼針對對象的事件做出的反應。事件，是對象（類）的設(shè)計者、開發(fā)者應該完成的；事件處理程序是外界調(diào)用方需要完成的。簡單的說，事件是“內(nèi)”；事件處理程序是“外”。

了解以上基本概念之后，我們開始學習具體的代碼實現(xiàn)過程。因為涉及代碼比較多，限于篇幅，我只是將代碼中比較重要的部分貼在文章里，進行解析，剩余代碼還是請讀者自己查閱，我已經(jīng)把源代碼打了包提供下載。我也建議你對照這些源代碼，來學習教程。[下載本教程的源代碼]

[TOP]

?

問題描述：一個需要較長時間才能完成的任務(wù)

Demo 1A，問題描述。這是一個情景演示，也是本教程中其他 Demo 都致力于解決的一個“實際問題”：Worker 類中有一個可能需要較長時間才能完成的方法 DoLongTimeTask：

using System; using System.Threading;namespace percyboy.EventModelDemo.Demo1A {// 需要做很長時間才能完成任務(wù)的 Worker，沒有加入任何匯報途徑。public class Worker{// 請根據(jù)你的機器配置情況，設(shè)置 MAX 的值。// 在我這里（CPU: AMD Sempron 2400+, DDRAM 512MB）// 當 MAX = 10000，任務(wù)耗時 20 秒。private const int MAX = 10000;public Worker(){}public void DoLongTimeTask(){int i;bool t = false;for (i = 0; i <= MAX; i++){// 此處 Thread.Sleep 的目的有兩個：// 一個是不讓 CPU 時間全部耗費在這個任務(wù)上：// 因為本例中的工作是一個純粹消耗 CPU 計算資源的任務(wù)。// 如果一直讓它一直占用 CPU，則 CPU 時間幾乎全部都耗費于此。// 如果任務(wù)時間較短，可能影響不大；// 但如果任務(wù)耗時也長，就可能會影響系統(tǒng)中其他任務(wù)的正常運行。// 所以，Sleep 就是要讓 CPU 有機會“分一下心”，// 處理一下來自其他任務(wù)的計算請求。//// 當然，這里的主要目的是為了讓這個任務(wù)看起來耗時更長一點。Thread.Sleep(1);t = !t;}}} }

界面很簡單（本教程中其他 Demo 也都沿用這個界面，因為我們主要的研究對象是 Worker.cs）：

單擊“Start”按鈕后，開始執(zhí)行該方法。（具體的機器配置條件，完成此任務(wù)需要的時間也不同，你可以根據(jù)你的實際情況調(diào)整代碼中的 MAX 值。）

在沒有進度指示的情況下，界面長時間的無響應，往往會被用戶認為是程序故障或者“死機”，而實際上，你的工作正在進行還沒有結(jié)束。此次教程就是以解決此問題為實例，向你介紹 .NET 中事件模型的原理、設(shè)計與具體編碼實現(xiàn)。

[TOP]

?

高耦合的實現(xiàn)

Demo 1B，高度耦合。有很多辦法可以讓 Worker 在工作的時候向用戶界面報告進度，比如最容易想到的：

public void DoLongTimeTask(){int i;bool t = false;for (i = 0; i <= MAX; i++){Thread.Sleep(1);t = !t;在此處書寫刷新用戶界面狀態(tài)欄的代碼}}

如果說 DoLongTimeTask 是用戶界面（Windows 窗體）的一個方法，那么上面藍色部分或許很簡單，可能只不過是如下的兩行代碼：

double rate = (double)i / (double)MAX;this.statusbar.Text = String.Format(@"已完成 {0:P2} ...", rate);

不過這樣的話，DoLongTimeTask 就是這個 Windows 窗體的一部分了，顯然它不利于其他窗體調(diào)用這段代碼。那么：Worker 類應該作為一個相對獨立的部分存在。源代碼 Demo1B 中給出了這樣的一個示例（應該還有很多種、和它類似的方法）：

Windows 窗體 Form1 中單擊“Start”按鈕后，初始化 Worker 類的一個新實例，并執(zhí)行它的 DoLongTimeTask 方法。但你應該同時看到，Form1 也賦值給 Worker 的一個屬性，在 Worker 執(zhí)行 DoLongTimeTask 方法時，通過這個屬性刷新 Form1 的狀態(tài)欄。Form1 和 Worker 之間相互粘在一起：Form1 依賴于 Worker 類（因為它單擊按鈕后要實例化 Worker），Worker 類也依賴于 Form1（因為它在工作時，需要訪問 Form1）。這二者之間形成了高度耦合。

高度耦合同樣不利于代碼重用，你仍然無法在另一個窗體里使用 Worker 類，代碼靈活度大為降低。正確的設(shè)計原則應該是努力實現(xiàn)低耦合：如果 Form1 必須依賴于 Worker 類，那么 Worker 類就不應該再反過來依賴于 Form1。

?

下面我們考慮使用 .NET 事件模型解決上述的“高度耦合”問題：

讓 Worker 類在工作時，向外界發(fā)出“進度報告”的事件通知（RateReport）。同時，為了演示更多的情景，我們讓 Worker 類在開始 DoLongTimeTask 之前發(fā)出一個“我要開始干活了！總?cè)蝿?wù)數(shù)有 N 件?！钡氖录ㄖ?#xff08;StartWork），并在完成任務(wù)時發(fā)出“任務(wù)完成”的事件通知（EndWork）。

采用事件模型后，類 Worker 本身并不實際去刷新 Form1 的狀態(tài)欄，也就是說 Worker 不依賴于 Form1。在 Form1 中，單擊“Start”按鈕后，Worker 的一個實例開始工作，并發(fā)出一系列的事件通知。我們需要做的是為 Worker 的事件書寫事件處理程序，并將它們掛接起來。

[TOP]

?

事件模型的解決方案，簡單易懂的 VB.NET 版本

Demo 1C，VB.NET 代碼。雖然本教程以 C# 為示例語言，我還是給出一段 VB.NET 的代碼輔助大家的理解。因為我個人認為 VB.NET 的事件語法，能讓你非常直觀的領(lǐng)悟到 .NET 事件模型的“思維方式”：

Public Class WorkerPrivate Const MAX = 10000Public Sub New()End Sub ' 注：此例的寫法不符合 .NET Framework 類庫設(shè)計指南中的約定，' 只是為了讓你快速理解事件模型而簡化的。' 請繼續(xù)閱讀，使用 Demo 1F 的 VB.NET 標準寫法。' ' 工作開始事件，并同時通知外界需要完成的數(shù)量。Public Event StartWork(ByVal totalUnits As Integer)' 進度匯報事件，通知外界任務(wù)完成的進度情況。Public Event RateReport(ByVal rate As Double)' 工作結(jié)束事件。Public Event EndWork()Public Sub DoLongTimeTask()Dim i As IntegerDim t As Boolean = FalseDim rate As Double' 開始工作前，向外界發(fā)出事件通知RaiseEvent StartWork(MAX)For i = 0 To MAXThread.Sleep(1)t = Not trate = i / MAXRaiseEvent RateReport(rate)NextRaiseEvent EndWork()End Sub

首先是事件的聲明部分：你只需寫上 Public Event 關(guān)鍵字，然后寫事件的名稱，后面的參數(shù)部分寫上需要發(fā)送到外界的參數(shù)聲明。

然后請注意已標記為藍色的 RaiseEvent 關(guān)鍵字，VB.NET 使用此關(guān)鍵字在類內(nèi)部引發(fā)事件，也就是向外界發(fā)送事件通知。請注意它的語法，RaiseEvent 后接上你要引發(fā)的事件名稱，然后是具體的事件參數(shù)值。

從這個例子中，我們可以加深對事件模型的認識：事件是對象（類）的成員，在對象（類）內(nèi)部狀態(tài)發(fā)生了一些變化（比如此例中 rate 在變化），或者對象做一些動作時（比如此例中，方法開始時，向外界 raise event；方法結(jié)束時，向外界 raise event），對象（類）發(fā)出的通知。并且，你也了解了事件參數(shù)的用法：事件參數(shù)是事件通知的相關(guān)內(nèi)容，比如 RateReport 事件通知需要報告進度值 rate，StartWork 事件通知需要報告總?cè)蝿?wù)數(shù) MAX。

我想 RaiseEvent 很形象的說明了這些道理。

[TOP]

?

委托（delegate）簡介。

在學習 C# 實現(xiàn)之前，我們首先應該了解一些關(guān)于“委托”的基礎(chǔ)概念。

你可以簡單的把“委托（delegate）”理解為 .NET 對函數(shù)的包裝（這是委托的主要用途）。委托代表一“類”函數(shù)，它們都符合一定的規(guī)格，如：擁有相同的參數(shù)個數(shù)、參數(shù)類型、返回值類型等。也可以認為委托是對函數(shù)的抽象，是函數(shù)的“類”（類是具有某些相同特征的事物的抽象）。這時，委托的實例將代表一個具體的函數(shù)。

你可以用如下的方式聲明委托：

public delegate void MyDelegate(int integerParameter);

如上的委托將可以用于代表：有且只有一個整數(shù)型參數(shù)、且不帶返回值的一組函數(shù)。它的寫法和一個函數(shù)的寫法類似，只是多了 delegate 關(guān)鍵字、而沒有函數(shù)體。（注：本文中的函數(shù)（function），取了面向過程理論中慣用的術(shù)語。在完全面向?qū)ο蟮?.NET/C# 中，我用以指代類的實例方法或靜態(tài)方法（method），希望不會因此引起誤解。順帶地，既然完全面向?qū)ο?#xff0c;其實委托本身也是一種對象。）

委托的實例化：既然委托是函數(shù)的“類”，那么使用委托之前也需要實例化。我們先看如下的代碼：

public class Sample{public void DoSomething(int mode){Console.WriteLine("test function.");}public static void Hello(int world){Console.WriteLine("hello, world!");}}

我們看到 Sample 的實例方法 DoSomething 和靜態(tài)方法 Hello 都符合上面已經(jīng)定義了的 MyDelegate 委托的“規(guī)格”。那么我們可以使用 MyDelegate 委托來包裝它們，以用于特殊的用途（比如下面要講的事件模型，或者將來教程中要講的多線程模型）。當然，包裝的過程其實也是委托的實例化過程：

Sample sp = new Sample();MyDelegate del = new MyDelegate(sp.DoSomething);

這是對上面的實例方法的包裝。但如果這段代碼寫在 Sample 類內(nèi)部，則應使用 this.DoSomething 而不用新建一個 Sample 實例。對 Sample 的 Hello 靜態(tài)方法可以包裝如下：

MyDelegate del = new MyDelegate(Sample.Hello);

調(diào)用委托：對于某個委托的實例（其實是一個具體的函數(shù)），如果想執(zhí)行它：

del(12345);

直接寫上委托實例的名字，并在括號中給相應的參數(shù)賦值即可。（如果函數(shù)有返回值，也可以像普通函數(shù)那樣接收返回值）。

[TOP]

?

C# 實現(xiàn)

Demo 1D，C# 實現(xiàn)。這里給出 Demo 1C 中 VB.NET 代碼的 C# 實現(xiàn)：是不是比 VB.NET 的代碼復雜了一些呢？

using System; using System.Threading;namespace percyboy.EventModelDemo.Demo1D {// 需要做很長時間才能完成任務(wù)的 Worker，這次我們使用事件向外界通知進度。public class Worker{private const int MAX = 10000; // 注：此例的寫法不符合 .NET Framework 類庫設(shè)計指南中的約定，// 只是為了讓你快速理解事件模型而簡化的。// 請繼續(xù)閱讀，使用 Demo 1E / Demo 1H 的 C# 標準寫法。// public delegate void StartWorkEventHandler(int totalUnits);public delegate void EndWorkEventHandler();public delegate void RateReportEventHandler(double rate);public event StartWorkEventHandler StartWork;public event EndWorkEventHandler EndWork;public event RateReportEventHandler RateReport;public Worker(){}public void DoLongTimeTask(){int i;bool t = false;double rate;if (StartWork != null){StartWork(MAX);}for (i = 0; i <= MAX; i++){Thread.Sleep(1);t = !t;rate = (double)i / (double)MAX;if (RateReport != null){RateReport(rate);}}if (EndWork != null){EndWork();}}} }

?

這份代碼和上面 VB.NET 代碼實現(xiàn)一致的功能。通過 C# 代碼，我們可以看到被 VB.NET 隱藏了的一些實現(xiàn)細節(jié)：

首先，這里一開始聲明了幾個委托（delegate）。然后聲明了三個事件，這里請注意 C# 事件聲明的方法：

public event [委托類型] [事件名稱];

這里你可以看到 VB.NET 隱藏了聲明委托的步驟。

另外提醒你注意代碼中具體引發(fā)事件的部分：

if (RateReport != null){RateReport(rate);}

在調(diào)用委托之前，必須檢查委托是否為 null，否則將有可能引發(fā) NullReferenceException 意外；比較 VB.NET 的代碼，VB.NET 的 RaiseEvent 語句實際上也隱藏了這一細節(jié)。

好了，到此為止，Worker 類部分通過事件模型向外界發(fā)送事件通知的功能已經(jīng)有了第一個版本，修改你的 Windows 窗體，給它添加 RateReport 事件處理程序（請參看你已下載的源代碼），并掛接到一起，看看現(xiàn)在的效果：

添加了進度指示之后的界面，極大的改善了用戶體驗，對用戶更為友好。

[TOP]

?

向“.NET Framework 類庫設(shè)計指南”靠攏，標準實現(xiàn)

Demo 1E，C# 的標準實現(xiàn)。上文已經(jīng)反復強調(diào)了 Demo 1C, Demo 1D 代碼不符合 CLS 約定。微軟為 .NET 類庫的設(shè)計與命名提出了一些指南，作為一種約定，.NET 開發(fā)者應當遵守這些約定。涉及事件的部分，請參看事件命名指南（對應的在線網(wǎng)頁），事件使用指南（對應的在線網(wǎng)頁）。

using System; using System.Threading;namespace percyboy.EventModelDemo.Demo1E {public class Worker{private const int MAX = 10000;public class StartWorkEventArgs : EventArgs{private int totalUnits;public int TotalUnits{get { return totalUnits; }}public StartWorkEventArgs(int totalUnits){this.totalUnits = totalUnits;}}public class RateReportEventArgs : EventArgs{private double rate;public double Rate{get { return rate; }}public RateReportEventArgs(double rate){this.rate = rate;}}public delegate void StartWorkEventHandler(object sender, StartWorkEventArgs e);public delegate void RateReportEventHandler(object sender, RateReportEventArgs e); public event StartWorkEventHandler StartWork;public event EventHandler EndWork;public event RateReportEventHandler RateReport; protected virtual void OnStartWork( StartWorkEventArgs e ){if (StartWork != null){StartWork(this, e);}}protected virtual void OnEndWork( EventArgs e ){if (EndWork != null){EndWork(this, e);}}protected virtual void OnRateReport( RateReportEventArgs e ){if (RateReport != null){RateReport(this, e);}}public Worker(){}public void DoLongTimeTask(){int i;bool t = false;double rate;OnStartWork(new StartWorkEventArgs(MAX) );for (i = 0; i <= MAX; i++){Thread.Sleep(1);t = !t;rate = (double)i / (double)MAX;OnRateReport( new RateReportEventArgs(rate) );}OnEndWork( EventArgs.Empty );}} }

按照 .NET Framework 類庫設(shè)計指南中的約定：

(1)事件委托名稱應以 EventHandler 為結(jié)尾；

(2)事件委托的“規(guī)格”應該是兩個參數(shù)：第一個參數(shù)是 object 類型的 sender，代表發(fā)出事件通知的對象（代碼中一般是 this 關(guān)鍵字(VB.NET 中是 Me)）。第二個參數(shù) e，應該是 EventArgs 類型或者從 EventArgs 繼承而來的類型；

事件參數(shù)類型，應從 EventArgs 繼承，名稱應以 EventArgs 結(jié)尾。應該將所有想通過事件、傳達到外界的信息，放在事件參數(shù) e 中。

(3)一般的，只要類不是密封（C# 中的 sealed，VB.NET 中的 NotInheritable）的，或者說此類可被繼承，應該為每個事件提供一個 protected 并且是可重寫（C# 用 virtual，VB.NET 用 Overridable）的 OnXxxx 方法：該方法名稱，應該是 On 加上事件的名稱；只有一個事件參數(shù) e；一般在該方法中進行 null 判斷，并且把 this/Me 作為 sender 執(zhí)行事件委托；在需要發(fā)出事件通知的地方，應調(diào)用此 OnXxxx 方法。

對于此類的子類，如果要改變發(fā)生此事件時的行為，應重寫 OnXxxx 方法；并且在重寫時，一般情況下應調(diào)用基類的此方法（C# 里的 base.OnXxxx，VB.NET 用 MyBase.OnXxxx）。

我建議你能繼續(xù)花些時間研究一下這份代碼的寫法，它是 C# 的標準事件實現(xiàn)代碼，相信你會用得著它！

在 Demo 1D 中我沒有講解如何將事件處理程序掛接到 Worker 實例的事件的代碼，在這個 Demo 中，我將主要的部分列在這里：

private void button1_Click(object sender, System.EventArgs e){statusBar1.Text = "開始工作 ....";this.Cursor = Cursors.WaitCursor;long tick = DateTime.Now.Ticks;Worker worker = new Worker();// 將事件處理程序與 Worker 的相應事件掛鉤// 這里我只掛鉤了 RateReport 事件做示意worker.RateReport += new Worker.RateReportEventHandler(this.worker_RateReport);worker.DoLongTimeTask();tick = DateTime.Now.Ticks - tick;TimeSpan ts = new TimeSpan(tick);this.Cursor = Cursors.Default;statusBar1.Text = String.Format("任務(wù)完成，耗時 {0} 秒。", ts.TotalSeconds);}private void worker_RateReport(object sender, Worker.RateReportEventArgs e){this.statusBar1.Text = String.Format("已完成 {0:P0} ....", e.Rate);}

?

請注意 C# 的掛接方式（“+=”運算符）。

到這里為此，你已經(jīng)看到了事件機制的好處：Worker 類的代碼和這個 Windows Form 沒有依賴關(guān)系。Worker 類可以單獨存在，可以被重復應用到不同的地方。

VB.NET 的讀者，請查看 Demo 1F 中的 VB.NET 標準事件寫法，并參考這里的說明，我就不再贅述了。

《新程序員》：云原生和全面數(shù)字化實踐50位技術(shù)專家共同創(chuàng)作，文字、視頻、音頻交互閱讀

總結(jié)

以上是生活随笔為你收集整理的.NET 事件模型教程（一）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。