淺談.Net非同步程式設計的前世今生----EAP篇

語言: CN / TW / HK

前言

在上一篇博文中,我們提到了APM模型實現非同步程式設計的模式,通過使用APM模型,可以簡化.Net中編寫非同步程式的方式,但APM模型本身依然存在一些缺點,如無法得知操作進度,不能取消非同步操作等。

針對這些缺點,微軟在.Net 2.0中提出了基於事件的非同步模式,簡稱為EAP模型。

第二個非同步程式設計模型:EAP

概述

EAP,全稱 Event-based Asynchronous Pattern ,基於事件的非同步模式,它提供了一系列的事件宣告與方法,用於實現非同步模式的各個階段。

典型的內建元件為 BackgroundWorker 元件,本文中我們將使用它來探尋此種模式的執行過程。

使用

我們需要建立一個窗體應用,並模擬下載實時進度顯示。建立WinForm後,放入Label控制元件用於展示下載進度和其他資訊,並加入兩個Button按鈕,分別為開始下載和取消下載,再放入我們的主角:BackgroundWorker元件,如圖所示:

在加入這些基本元件後,我們開始這一次的編碼之旅,BackgroundWorker在後臺屬於一個類,因此它已經內建了部分屬性和事件:

這些屬性中包含取消、支援進度更新、判斷是否執行等,恰恰是我們在這次非同步操作中需要的。於是,我們根據需求編寫了以下程式碼:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;


namespace BackgroundWorkerDemo
{
public partial class BackgroundWorkerForm : Form
{
public BackgroundWorkerForm()
{
InitializeComponent();
backgroundWorker1.WorkerReportsProgress = true;
backgroundWorker1.WorkerSupportsCancellation = true;
}


/// <summary>
/// 點選開始下載按鈕
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void btnDownLoad_Click(object sender, EventArgs e)
{
if (!backgroundWorker1.IsBusy) //判斷是否正在執行非同步操作
{
//backgroundWorker開始執行非同步操作
backgroundWorker1.RunWorkerAsync();
}
}


/// <summary>
/// 點選取消按鈕
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void btnCancel_Click(object sender, EventArgs e)
{
if (backgroundWorker1.WorkerSupportsCancellation) //判斷是否支援非同步取消操作
{
//開始執行取消操作
backgroundWorker1.CancelAsync();
}
}


/// <summary>
/// backgroundworker非同步執行事件
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
{
System.ComponentModel.BackgroundWorker worker = sender as System.ComponentModel.BackgroundWorker;
string msg = "當前執行緒是否為後臺執行緒:" + Thread.CurrentThread.IsBackground + ",是否為執行緒池執行緒:" + Thread.CurrentThread.IsThreadPoolThread;
WriteLog("Backgroundworker日誌", msg);
for (int i = 0; i < 20; i++)
{
if (worker.CancellationPending)
{
e.Cancel = true;
break;
}
else
{
//模擬下載執行進度
Thread.Sleep(500);
worker.ReportProgress(i * 5);
}
}
}


/// <summary>
/// 進度報告事件
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void backgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
lblProcess.Text = "當前下載進度為:" + e.ProgressPercentage + "%,是否為後臺執行緒:" + Thread.CurrentThread.IsBackground
+ ",是否為執行緒池執行緒:" + Thread.CurrentThread.IsThreadPoolThread;
}


/// <summary>
/// 非同步操作完成事件
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
if (e.Cancelled) //此狀態為取消
{
lblProcess.Text = "下載已經被取消";
}
else if (e.Error != null)
{
lblProcess.Text = "出現錯誤:" + e.Error.Message;
}
else
{
lblProcess.Text = "下載已完成";
}
}


/// <summary>
/// 記錄日誌
/// </summary>
/// <param name="documentName"></param>
/// <param name="msg"></param>
public void WriteLog(string documentName, string msg)
{
string errorLogFilePath = System.IO.Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Log");
if (!System.IO.Directory.Exists(errorLogFilePath))
{
System.IO.Directory.CreateDirectory(errorLogFilePath);
}
string logFile = System.IO.Path.Combine(errorLogFilePath, documentName + "@" + DateTime.Today.ToString("yyyy-MM-dd") + ".txt");
bool writeBaseInfo = System.IO.File.Exists(logFile);
StreamWriter swLogFile = new StreamWriter(logFile, true, Encoding.Unicode);
swLogFile.WriteLine(DateTime.Now.ToString("HH:mm:ss") + "\t" + msg);
swLogFile.Close();
swLogFile.Dispose();
}
}
}

在這段示例程式碼中,我們首先設定元件支援取消及報告進度操作屬性,其次在點選開始按鈕時,判斷是否執行,若未執行,則執行 RunWorkerAsync 方法,避免多次重複執行。

在EAP模型中,執行RunWorkerAsync方法後,會觸發 backgroundWorker1_DoWork 事件。此事件中我們放入模擬實時下載進度程式碼,並呼叫 ReportProgress 進行進度報告,這時 backgroundWorker1_ProgressChanged 事件會被觸發,同時對UI進行更新操作,此段過程執行結果如下圖所示:

通過結果可以看出,執行過程中已經實現了實時更新進度的功能。與此同時,根據反饋的資訊我們發現,backgroundWorker1_ProgressChanged事件內部是執行緒安全的,在操作UI時不會出現跨執行緒對UI進行更新的問題。

那麼BackgroundWorker內部是不是依然使用了執行緒池及後臺執行緒呢?我們來一起看看在backgroundWorker1_DoWork事件中記錄的日誌:

通過日誌我們發現,EAP與APM一樣,也使用了執行緒池中的執行緒,不得不感嘆一句,執行緒池是個偉大的發明,微軟真是無所不用其極啊!

講到這裡,細心的同學會發現,我們嘮叨了這麼半天,似乎還少了點什麼,對了,取消操作,一起來看看效果:

點選介面上的"取消下載"按鈕後,會提示下載已經被取消。原因是我們在點選按鈕時,首先判斷了 WorkerSupportsCancellation 屬性,看元件是否支援取消操作,隨後執行 CancelAsync 方法進行非同步取消。

由於這個過程是非同步的,因此我們在backgroundWorker1_DoWork事件中不斷判斷 CancellationPending 屬性,若取消則設定e.Cancel=true進行標誌位標誌,標誌後我們可以在 backgroundWorker1_RunWorkerCompleted 判斷是否已經取消,最後對UI進行提示輸出,取消操作完成。

小結

對比APM呼叫委託進行非同步操作的方式,EAP顯得更加簡潔明瞭,只需更少的程式碼即可實現更多的功能。尤其是BackgroundWorker元件,定義相應的事件後,在不同階段根據需求編寫方法即可實現非同步操作、報告進度及取消等。

但是EAP模型的使用,侷限性會更強,主要包括以下幾點:

  • 可用元件少,除了BackgroundWorker之外,僅有WebClient類支援此模型,在B/S程式中難以使用。

  • 只能使用預定義事件,無法手動定義回撥函式,且依賴事件的執行順序。

  • 內部封裝較多,佔用資源比APM方式多。

因此在愈演愈烈的需求中,微軟又對非同步程式設計模型進行了變革,一種兼顧強大與靈活的新模型誕生了,它會是誰呢?預知後事如何,且聽下回分解。

您的點贊和在看是我創作的最大動力,感謝支援

公眾號:wacky的碎碎念

知乎:wacky