C#（99）：二、.NET 2.0基於事件的非同步程式設計模式(EAP)
阿新 • • 發佈：2020-06-17
二、基於事件的非同步程式設計模式(EAP)
一、引言
APM為我們實現非同步程式設計提供了一定的支援，同時它也存在著一些明顯的問題——不支援對非同步操作的取消和沒有提供對進度報告的功能，對於有介面的應用程式來說，進度報告和取消操作的支援也是必不可少的。
微軟在.NET 2.0的時候就為我們提供了一個新的非同步程式設計模型，也就是基於事件的非同步程式設計模型——EAP（Event-based Asynchronous Pattern ）。
二、介紹
實現了基於事件的非同步模式的類將具有一個或者多個以Async為字尾的方法和對應的Completed事件，並且這些類都支援非同步方法的取消、進度報告和報告結果。
當我們呼叫實現基於事件的非同步模式的類的 XxxAsync方法時，即代表開始了一個非同步操作，該方法呼叫完之後會使一個執行緒池執行緒去執行耗時的操作，所以當UI執行緒呼叫該方法時，當然也就不會堵塞UI執行緒了。
並且基於事件的非同步模式是建立了APM的基礎之上的，而APM又是建立了在委託之上的。
public static void GetInfomation() { WebClient client = new WebClient(); Uri uri= new Uri("http://www.baidu.com"); client.DownloadFileCompleted += AsyncCompletedEventHandler(client_DownloadFileCompleted); client.DownloadProgressChanged += DownloadProgressChangedEventHandler(client_DownloadProgressCallback); client.DownloadFileAsync(uri,serverdata.txt); } void client_DownloadProgressCallback(objectsender,DownloadProgressChangedEventArgs e) { // Displays the operation identifier,and the transfer progress. Console.WriteLine({0} downloaded {1} of {2} bytes. {3} % complete...",(string)e.UserState,e.BytesReceived,e.TotalBytesToReceive,e.ProgressPercentage); } void client_DownloadFileCompleted(string RetStr = (e.Error == null ? 成功 : e.Error.Message); Console.Write(RetStr); 顯示操作結果資訊 }
三、使用BackgroundWorker元件進行非同步程式設計
BackgroundWorker類就是用EAP實現的。
BackgroundWorker類
公共屬性
- CancellationPending：獲取一個值，指示應用程式是否已請求取消後臺操作
- IsBusy：獲取一個值，指示 BackgroundWorker 是否正在執行非同步操作。
- WorkReportsProgress：獲取或設定一個值，該值指示 BackgroundWorker 能否報告進度更新。
- WorkerSupportsCancellation：獲取或設定一個值，該值指示 BackgroundWorker 是否支援非同步取消。
公共方法
- CancelAsync：請求取消掛起的後臺操作。
- ReportProgress：引發 ProgressChanged 事件
- RunWorkerAsync：開始執行後臺操作。
公共事件
- DoWork：呼叫 RunWorkerAsync 時發生
- ProgressChanged：呼叫ReportProgress時發生
- RunWorkerCompleted：當後臺操作已完成、被取消或引發異常時發生。
下面向大家演示一個使用BackgroundWorker元件實現非同步下載檔案的一個小程式，該程式支援非同步下載(指的就是用執行緒池執行緒要執行下載操作)，斷點續傳、下載取消和進度報告的功能。
事件繫結：
程式碼：
int DownloadSize = 0; string downloadPath = nullprivate RequestState requestState = private long totalSize = ; public FileDownloader() { InitializeComponent(); string url = http://download.microsoft.com/download/7/0/3/703455ee-a747-4cc8-bd3e-98a615c3aedb/dotNetFx35setup.exe; string url = "http://download.microsoft.com/download/9/5/A/95A9616B-7A37-4AF6-BC36-D6EA96C8DAAE/dotNetFx40_Full_x86_x64.exe"; txbUrl.Text = url; this.btnPause.Enabled = falsethis.status = DownloadStatus.Initialized; Get download Path GetTotalSize(); downloadPath = Environment.GetFolderPath(Environment.SpecialFolder.Desktop) + \\" + Path.GetFileName(this.txbUrl.Text.Trim()); if (File.Exists(downloadPath)) { FileInfo fileInfo = FileInfo(downloadPath); DownloadSize = (int)fileInfo.Length; progressBar1.Value = (int)((float)DownloadSize / (float)totalSize * 100); } 啟用支援 ReportProgress and Cancellation bgWorkerFileDownload.WorkerReportsProgress = true; bgWorkerFileDownload.WorkerSupportsCancellation = ; } 開始或恢復下載 void btnDownload_Click(if (bgWorkerFileDownload.IsBusy != ) { 啟動非同步操作觸發DoWork事件 bgWorkerFileDownload.RunWorkerAsync(); 建立RequestState 例項 requestState = RequestState(downloadPath); requestState.filestream.Seek(DownloadSize,SeekOrigin.Begin); this.btnDownload.Enabled = ; ; } else { MessageBox.Show(正在執行操作，請稍後); } } 暫停下載 void btnPause_Click(if (bgWorkerFileDownload.IsBusy && bgWorkerFileDownload.WorkerSupportsCancellation == 終止非同步操作觸發RunWorkerCompleted事件 bgWorkerFileDownload.CancelAsync(); } } #region BackGroundWorker Event 1、當呼叫RunWorkerAsync方法時觸發 void bgWorkerFileDownload_DoWork(獲取事件源 BackgroundWorker bgworker = sender as BackgroundWorker; try { 執行下載操作 初始化一個HttpWebRequest物件 HttpWebRequest myHttpWebRequest = (HttpWebRequest)WebRequest.Create(txbUrl.Text.Trim()); 如果檔案已下載了一部分， 伺服器應該從DownloadSize開始傳送資料到HTTP實體中資料的末尾。 if (DownloadSize != ) { myHttpWebRequest.AddRange(DownloadSize); } 指定一個 HttpWebRequest 例項到request欄位. requestState.request = myHttpWebRequest; requestState.response = (HttpWebResponse)myHttpWebRequest.GetResponse(); requestState.streamResponse = requestState.response.GetResponseStream(); int readSize = while () { bgworker.CancellationPending == true) { e.Cancel = ; break; } readSize = requestState.streamResponse.Read(requestState.BufferRead,,requestState.BufferRead.Length); if (readSize > ) { DownloadSize += readSize; int percentComplete = (); requestState.filestream.Write(requestState.BufferRead,readSize); 報告進度，引發ProgressChanged事件的發生 bgworker.ReportProgress(percentComplete); } { ; } } } catchthrow; } } 2、當呼叫ReportProgress方法時觸發 void bgWorkerFileDownload_ProgressChanged(this.progressBar1.Value = e.ProgressPercentage; } 3、當後臺操作完成，取消或者有錯誤時觸發 void bgWorkerFileDownload_RunWorkerCompleted(if (e.Error != ) { MessageBox.Show(e.Error.Message); requestState.response.Close(); } else (e.Cancelled) { MessageBox.Show(String.Format(下載暫停，下載的檔案地址為：{0}\n 已經下載的位元組數為: {1}位元組 { MessageBox.Show(String.Format(下載已完成，下載的檔案地址為：{0}，檔案的總位元組數為: {1}位元組; requestState.response.Close(); requestState.filestream.Close(); } } #endregion BackGroundWorker Event 獲取檔案總大小 GetTotalSize() { HttpWebRequest myHttpWebRequest = (HttpWebRequest)WebRequest.Create(txbUrl.Text.Trim()); HttpWebResponse response = (HttpWebResponse)myHttpWebRequest.GetResponse(); totalSize = response.ContentLength; response.Close(); } } 此類儲存請求的狀態 class RequestState { public int BufferSize = 2048byte[] BufferRead; public HttpWebRequest request; HttpWebResponse response; Stream streamResponse; FileStream filestream; public RequestState( downloadPath) { BufferRead = new [BufferSize]; request = ; streamResponse = ; filestream = FileStream(downloadPath,FileMode.OpenOrCreate); }
執行程式點選"下載"按鈕然後再點選"暫停"後的結果：
當暫停下載後，我們還可以點 ”下載“按鈕繼續下載該檔案，此時並不會從開開始下載，而會接著上次的下載繼續下載。
這個實現主要是通過AddRange方法來實現的，該方法是指出向伺服器請求檔案的大小，上面程式碼中通過傳入DownloadSize來告訴伺服器，這次我需要的內容不是從開頭開始的，而是從已經下載的檔案位元組數開始到該檔案的總的位元組結尾，這樣就就實現了斷點續傳的功能了，使戶暫停下載不至於之前下載的都白費了。程式的執行結果為：
