淺談.Net異步編程的前世今生----EAP篇

前言

在上一篇博文中，我們提到了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模型的使用，局限性會更強，主要包括以下幾點：

1、可用組件少，除了BackgroundWorker之外，僅有WebClient類支持此模型，在B/S程序中難以使用

2、只能使用預定義事件，無法手動定義回調函數，且依賴事件的執行順序

3、內部封裝較多，占用資源比APM方式多

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

下集預告

淺談.Net異步編程的前世今生----TPL篇