基于事件的C#異步編程模式是什么呢？我們現(xiàn)在開(kāi)始向你慢慢介紹：

基于事件的C#異步編程模式是比IAsyncResult模式更高級(jí)的一種異步編程模式，也被用在更多的場(chǎng)合。對(duì)于相對(duì)簡(jiǎn)單的應(yīng)用程序可以直接用 .Net 2.0 新增的 BackgroundWorker 組件來(lái)很方便的實(shí)現(xiàn)，對(duì)于更復(fù)雜的異步應(yīng)用程序則需要自己實(shí)現(xiàn)一個(gè)符合基于事件的C#異步編程模式的類(lèi)。這兩者對(duì)我都是新東西，先從簡(jiǎn)單的入手，下一篇里我再去嘗試復(fù)雜類(lèi)模型的實(shí)現(xiàn)

基于事件的C#異步編程模式概述

支持基于事件的C#異步編程模式的類(lèi)會(huì)有若干個(gè) MethodNameAsync 方法表示開(kāi)始異步操作，并有對(duì)應(yīng)的 MethodNameCompleted 事件。類(lèi)里面還可能會(huì)有 CancelAsync 或 MethodNameAsyncCancel 方法用于取消異步操作，并可以有  ProgressChanged 或 MethodNameProgressChanged 事件來(lái)跟蹤執(zhí)行進(jìn)度。下面分別作一下解釋

MethodNameAsync 方法可以有兩個(gè)重載：?jiǎn)握{(diào)用和多調(diào)用，多調(diào)用有一個(gè)額外的狀態(tài)對(duì)象參數(shù)  userState。userState 參數(shù)用來(lái)區(qū)分各次異步操作，使得我們可以多次調(diào)用多調(diào)用形式的方法而不需要等待任何異步操作的完成（在學(xué)習(xí) IAsyncResult 模式時(shí)我把狀態(tài)對(duì)象僅僅當(dāng)成傳給回調(diào)方法的一個(gè)條件來(lái)用，可能在使用模式時(shí)這么做并沒(méi)有什么關(guān)系，但在實(shí)現(xiàn)模式時(shí)不把狀態(tài)對(duì)象用作異常調(diào)用的唯一標(biāo)識(shí)而另作他用就值得商榷了）。而單調(diào)用形式的方法如果在前一個(gè)調(diào)用尚未完成時(shí)調(diào)用將會(huì)拋出 InvalidOperationException 異常

如果有多個(gè)異步方法，則應(yīng)使用 CancelAsync 方法來(lái)取消掛起的操作，并可使用 userState 來(lái)取消指定的掛起任務(wù)。如果只有一個(gè)異步方法則可以使用 MethodNameAsyncCancel 方法

另外 MSDN 上說(shuō)：一次只支持一個(gè)掛起的操作的方法（如 Method1Async(string param) ）是不可取消的。這句話我還沒(méi)有理解，不可能說(shuō)是單調(diào)用的異步方法就不能取消吧，BackgroundWorker 上都是這樣做的

先不管了，接著看ProgressChanged 事件。它有一個(gè) ProgressChangedEventArgs 參數(shù)，事件處理程序通過(guò)檢查該參數(shù)的 ProgressPercentage 屬性來(lái)獲取任務(wù)完成的百分比。如果有多個(gè)異步操作掛起，也可以通過(guò)檢查參數(shù)的 UserState 屬性來(lái)分辨操作。如果需要用 ProgressChanged 事件來(lái)報(bào)告增量結(jié)果，則可以把結(jié)果保存在派生自 ProgressChangedEventArgs 的類(lèi)中，并在事件處理程序中使用

基于事件的C#異步編程模式之BackgroundWorker

BackgroundWorker 很好的符合了事件異步操作模式。它有兩個(gè)重載版本的 RunWorkerAsync 方法（均為單調(diào)用形式）和 RunWorkerCompleted 事件，并有 CancelAsync 方法以及 ProcessChanged 事件。不同的是 BackgroundWorker 增加了 DoWork 事件，在 RunWorkerAsync 方法調(diào)用時(shí)發(fā)生，以達(dá)到將實(shí)際執(zhí)行的開(kāi)始方法與 BackgroundWorker 分離的目的。還需要提一下的是 WorkerReportsProcess 屬性和 ReportProcess 方法，前者指示能否報(bào)告進(jìn)度更新，后者引發(fā) ProcessChanged 事件，它們會(huì)在接下來(lái)的 Demo 里用到

基于事件的C#異步編程模式的實(shí)例應(yīng)用：

因?yàn)槠綍r(shí)經(jīng)常要處理幾十兆的文本文件，這個(gè) Demo 就做一個(gè)讀取文件并顯示進(jìn)度的控制臺(tái)程序。先看類(lèi)名和字段

class BackgroundWorkerDemo  
{  
  private BackgroundWorker m_bw;  
  string m_FilePath;  
} 

構(gòu)造函數(shù)接收文件路徑為參數(shù)，設(shè)置文件路徑并初始化 BackgroundWorker

public BackgroundWorkerDemo(string filePath)  
  {  
m_FilePath = filePath;  
 
m_bw = new BackgroundWorker();  
m_bw.WorkerReportsProgress = true;  
m_bw.DoWork += new DoWorkEventHandler(  
 
BackgroundWorker_DoWork);  
m_bw.ProgressChanged +=   
 
new ProgressChangedEventHandler(  
 
BackgroundWorker_ProgressChanged);  
m_bw.RunWorkerCompleted +=   
 
new RunWorkerCompletedEventHandler(  
 
BackgroundWorker_RunWorkerCompleted);  
  }  

接下來(lái)看這三個(gè)事件的處理程序。每一個(gè)事件都有各自的 EventArgs 參數(shù)類(lèi)型，都很簡(jiǎn)單就不多說(shuō)了

***個(gè) BackgroundWorker_DoWork 方法寫(xiě)得我有些郁悶。我在方法里取文件長(zhǎng)度，先是直接取 StreamReader.BaseStream.Length 或 FileInfo.Length ，結(jié)果卻導(dǎo)致很多文件讀不到 100% 就結(jié)束了，不得已改成先把整個(gè)文件讀一次得到字符串的長(zhǎng)度。這樣的方法當(dāng)然性能不好了，主要是因?yàn)樽约簩?duì) IO 一直就不夠清楚，等下一個(gè)主題重新認(rèn)識(shí)下 IO 再回頭過(guò)來(lái)改吧。也望有經(jīng)驗(yàn)的朋友賜教，感激不盡

  /**//// ﹤summary﹥  
  /// DoWork event process method  
  /// ﹤/summary﹥  
  /// ﹤param name="sender"﹥﹤/param﹥  
  /// ﹤param name="e"﹥﹤/param﹥  
  private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)  
  {  
long length;  
using (StreamReader sr = new StreamReader(m_FilePath))  
{  
// Get file length  
length = sr.ReadToEnd().Length;  
}  
 
using (StreamReader sr = new StreamReader(m_FilePath))  
{  
long onePercentOfLength = length / 100;  
long currentPosition = 0;  
int i = 0;  
 
while (!sr.EndOfStream)  
{  
  sr.Read();  
  currentPosition ++;  
 
  // Produce ProcessChanged event in each percent reading  
  while (currentPosition ﹥ onePercentOfLength * i)  
  {  
((BackgroundWorker)sender).ReportProgress(i++);  
  }  
}  
 
// e.Result will be used in RunWorkerCompleted event process method  
e.Result = currentPosition;  
}  
  }  

基于事件的C#異步編程模式之BackgroundWorker_ProgressChanged 方法，簡(jiǎn)單輸出當(dāng)前進(jìn)度

  /**//// ﹤summary﹥  
  /// ProgressChanged event process method  
  /// ﹤/summary﹥  
  /// ﹤param name="sender"﹥﹤/param﹥  
  /// ﹤param name="e"﹥﹤/param﹥  
  private void BackgroundWorker_ProgressChanged(  
object sender, ProgressChangedEventArgs e)  
  {  
Console.WriteLine("Reading percents: " + e.ProgressPercentage + "%");  
  } 

BackgroundWorker_RunWorkerCompleted 方法，輸出結(jié)果。這里要注意如果 RunWorkerCompletedEventArgs 參數(shù)的 Error 屬性不為空則讀取其他屬性會(huì)產(chǎn)生異常，然后如果 Cancelled 屬性為 true 則讀取 Result 屬性也會(huì)產(chǎn)生異常，因此必須依次判斷各屬性的值

  /**//// ﹤summary﹥  
  /// RunWorkerCompleted event process method  
  /// ﹤/summary﹥  
  /// ﹤param name="sender"﹥﹤/param﹥  
  /// ﹤param name="e"﹥﹤/param﹥  
  private void BackgroundWorker_RunWorkerCompleted(  
object sender, RunWorkerCompletedEventArgs e)  
  {  
if (e.Error != null)  
{  
Console.WriteLine("Error occurs: " + e.Error.Message);  
}  
else if(e.Cancelled)  
{  
Console.WriteLine("Work cancelled");  
}  
else 
{  
Console.WriteLine("Read finished,   
the file length is: " + e.Result);  
}  
  } 

基于事件的C#異步編程模式之向外提供一個(gè)入口方法

  /**//// ﹤summary﹥  
  /// Test portal  
  /// ﹤/summary﹥  
  public void ReadAsync()  
  {  
if (File.Exists(m_FilePath))  
{  
Console.WriteLine("Begin read");  
m_bw.RunWorkerAsync();  
}  
else 
{  
throw new FileNotFoundException(  
"Can't find file: " + m_FilePath);  
}  
  } 

***是 Main 方法，比昨天有了小小的改變，用 Console.ReadLine 代替了 Thread.Sleep 來(lái)達(dá)到阻止主線程退出的目的

class BackgroundWorkerTest  
{  
  static void Main(string[] args)  
  {  
Console.Write("Input file path: ");  
string filePath = Console.ReadLine();  
 
BackgroundWorkerDemo demo =   
new BackgroundWorkerDemo(filePath);  
demo.ReadAsync();  
 
// Thread waiting  
Console.ReadLine();  
  }  
} 

基于事件的C#異步編程模式的總結(jié)

回顧一下我用委托實(shí)現(xiàn) IAsyncResult 模式的 Demo ，與用 BackgroundWorker 實(shí)現(xiàn)的基于事件的C#異步編程模式很相似吧。而且應(yīng)用程序可以通過(guò)委托的 BeginInvoke 和 EndInvoke 方法來(lái)異步執(zhí)行現(xiàn)有的同步方法而不需要作額外的修改，BackgroundWorker 也差不多是一樣。我把這兩者看成實(shí)現(xiàn)對(duì)應(yīng)異步操作模式的范本，在性能要求不是很高的一些異步操作場(chǎng)合，用好委托和 BackgroundWorker 就可以簡(jiǎn)單有效的完成開(kāi)發(fā)了。

基于事件的C#異步編程模式的基本內(nèi)容就向你介紹到這里，希望對(duì)你了解和學(xué)習(xí)基于事件的C#異步編程模式有所幫助。

【編輯推薦】

1. 概述C#加框和消框