[你必須知道的異步編程]——基于任務的異步模式(TAP)

本專題概要

• 引言

• 什么是TAP——基于任務的異步模式介紹

• 如何使用TAP——使用基于任務的異步模式來異步編程

• TAP與APM或EAP可以轉換嗎？——與其他異步模式的轉換

• 小結

一、引言

　　在上兩個專題中我為大家介紹.NET 1.0中的APM和.NET 2.0中的EAP，在使用前面兩種模式進行異步編程的時候,大家多多少少肯定會感覺到實現起來比較麻煩, 首先我個人覺得,當使用APM的時候,首先我們要先定義用來包裝回調方法的委托,這樣難免有點繁瑣, 然而使用EAP的時候,我們又需要實現Completed事件和Progress事件，上面兩種實現方式感覺都有點繁瑣，同時微軟也意思到了這點，所以在.NET 4.0中提出了一個新的異步模式——基于任務的異步模式，該模式主要使用System.Threading.Tasks.Task和Task<T>類來完成異步編程，相對于前面兩種異步模式來講，TAP使異步編程模式更加簡單(因為這里我們只需要關注Task這個類的使用)，同時TAP也是微軟推薦使用的異步編程模式,下面就具體為大家分享下本專題的內容.

二、什么是TAP——基于任務的異步模式介紹

基于任務的異步模式(Task-based Asynchronous Pattern,TAP)之所以被微軟所推薦,主要就它使用簡單,基于任務的異步模式使用單個方法來表示異步操作的開始和完成,然而異步編程模型(APM)卻要求BeginXxx和EndXxx兩個方法來分別表示異步操作的開始和完成(這樣使用起來就復雜了)，然而，基于事件的異步模式（EAP）要求具有Async后綴的方法和一個或多個事件、事件處理程序和事件參數。看到這里,是不是大家都有這樣一個疑問的——我們怎樣區分.NET類庫中的類實現了基于任務的異步模式呢? 這個識別方法很簡單，當看到類中存在TaskAsync為后綴的方法時就代表該類實現了TAP, 并且基于任務的異步模式同樣也支持異步操作的取消和進度的報告的功能,但是這兩個實現都不像EAP中實現的那么復雜,因為如果我們要自己實現EAP的類,我們需要定義多個事件和事件處理程序的委托類型和事件的參數(具體可以查看上一專題中的BackgroundWorker剖析部分)，但是在TAP實現中，我們只需要通過向異步方法傳入CancellationToken參數,因為在異步方法內部會對這個參數的IsCancellationRequested屬性進行監控,當異步方法收到一個取消請求時,異步方法將會退出執行(具體這點可以使用反射工具查看WebClient的DownloadDataTaskAsync方法,同時也可以參考我后面部分自己實現基于任務的異步模式的異步方法。),在TAP中,我們可以通過IProgress<T>接口來實現進度報告的功能,具體實現可以參考我后面的程序部分。

目前我還沒有找到在.NET 類庫中實現了基于任務的異步模式的哪個類提供進度報告的功能，下面的將為大家演示這個實現，并且也是這個程序的亮點，同時通過自己實現TAP的異步方法來進一步理解基于任務的異步模式。

三、如何使用TAP——使用基于任務的異步模式來異步編程

看完上面的介紹，我們是不是很迫不及待想知道如何自己實現一個基于任務的異步模式的異步方法的，并且希望只需要這個方法就可以完成異步操作的取消和進度報告的功能的（因為EAP中需要實現其他的事件和定義事件參數類型，這樣的實現未免過于復雜），下面就基于上專題中實現的程序用基于任務的異步模式來完成下。下面就讓我們實現自己的異步方法(亮點為只需要一個方法就可以完成進度報告和異步操作取消的功能)：

//  Download File
        // CancellationToken 參數賦值獲得一個取消請求
        // progress參數負責進度報告
        private void DownLoadFile(string url, CancellationToken ct, IProgress<int> progress)
        {
            HttpWebRequest request = null;
            HttpWebResponse response = null;
            Stream responseStream = null;
            int bufferSize = 2048;
            byte[] bufferBytes = new byte[bufferSize];
            try
            {
                request = (HttpWebRequest)WebRequest.Create(url);
                if (DownloadSize != 0)
                {
                    request.AddRange(DownloadSize);
                }
                response = (HttpWebResponse)request.GetResponse();
                responseStream = response.GetResponseStream();
                int readSize = 0;
                while (true)
                {
                    // 收到取消請求則退出異步操作
                    if (ct.IsCancellationRequested == true)
                    {
                        MessageBox.Show(String.Format("下載暫停，下載的文件地址為：{0}\n 已經下載的字節數為: {1}字節", downloadPath, DownloadSize));
                        response.Close();
                        filestream.Close();
                        sc.Post((state) =>
                        {
                            this.btnStart.Enabled = true;
                            this.btnPause.Enabled = false;
                        }, null);
                        // 退出異步操作
                        break;
                    }
                    readSize = responseStream.Read(bufferBytes, 0, bufferBytes.Length);
                    if (readSize > 0)
                    {
                        DownloadSize += readSize;
                        int percentComplete = (int)((float)DownloadSize / (float)totalSize * 100);
                        filestream.Write(bufferBytes, 0, readSize);
                        // 報告進度
                        progress.Report(percentComplete);
                    }
                    else
                    {
                        MessageBox.Show(String.Format("下載已完成，下載的文件地址為：{0}，文件的總字節數為: {1}字節", downloadPath, totalSize));
                        sc.Post((state) =>
                        {
                            this.btnStart.Enabled = false;
                            this.btnPause.Enabled = false;
                        }, null);
                        response.Close();
                        filestream.Close();
                        break;
                    }
                }   
            }
            catch (AggregateException ex)
            {
                // 因為調用Cancel方法會拋出OperationCanceledException異常
                // 將任何OperationCanceledException對象都視為以處理
                ex.Handle(e => e is OperationCanceledException);
            }
        }

這樣只需要上面的一個方法，我們就可以完成上一專題中文件下載的程序，我們只需要在下載按鈕的事件處理程序調用該方法和在暫停按鈕的事件處理程序調用CancellationTokenSource.Cancel方法即可，具體代碼為：

// Start DownLoad File
        private void btnStart_Click(object sender, EventArgs e)
        {
            filestream = new FileStream(downloadPath, FileMode.OpenOrCreate);
            this.btnStart.Enabled = false;
            this.btnPause.Enabled = true;
            filestream.Seek(DownloadSize, SeekOrigin.Begin);
            // 捕捉調用線程的同步上下文派生對象
            sc = SynchronizationContext.Current;
            cts = new CancellationTokenSource();
            // 使用指定的操作初始化新的 Task。
            task = new Task(() => Actionmethod(cts.Token), cts.Token);
            // 啟動 Task，并將它安排到當前的 TaskScheduler 中執行。
            task.Start();
            //await DownLoadFileAsync(txbUrl.Text.Trim(), cts.Token,new Progress<int>(p => progressBar1.Value = p));
        }
        // 任務中執行的方法
        private void Actionmethod(CancellationToken ct)
        {
            // 使用同步上文文的Post方法把更新UI的方法讓主線程執行
            DownLoadFile(txbUrl.Text.Trim(), ct, new Progress<int>(p =>
                {
                    sc.Post(new SendOrPostCallback((result)=>progressBar1.Value=(int)result),p);
                }));
        }
        // Pause Download
        private void btnPause_Click(object sender, EventArgs e)
        {
            // 發出一個取消請求
            cts.Cancel();
        }

下面看看基于任務的異步模式的實現效果如何的，運行結果：

點擊確定按鈕之后，Download按鈕會重新變成可用，此時我們可以繼續點擊Download按鈕來下載進行下載，下載完成之后會下載完成彈出框，運行結果如下：

四、TAP與APM或EAP可以轉換嗎？——與其他異步模式的轉換

從上面的程序代碼我們可以清楚的發現——基于任務的異步模式確實比前面的兩種異步模式更加簡單使用，所以，從.NET Framework 4.0開始，微軟推薦使用TAP來實現異步編程，這里就涉及之前用APM或EAP實現的程序如何遷移到用TAP實現的問題的，同時.NET Framwwork對他們之間的轉換了也做了很好的支持。

4.1 將APM轉換為TAP

在System.Threading.Tasks命名空間中，有一個TaskFactory(任務工程)類，我們正可以利用該類的FromAsync方法來實現將APM轉換為TAP，下面就用基于任務的異步模式來實現在異步編程模型博文中例子。

// 大家可以對比這兩種實現方式
        #region 使用APM實現異步請求
        private void APMWay()
        {
            WebRequest webRq = WebRequest.Create("http://msdn.microsoft.com/zh-CN/");
            webRq.BeginGetResponse(result =>
            {
                WebResponse webResponse = null;
                try
                {
                    webResponse = webRq.EndGetResponse(result);
                    Console.WriteLine("請求的內容大小為： " + webResponse.ContentLength);
                }
                catch (WebException ex)
                {
                    Console.WriteLine("異常發生，異常信息為： " + ex.GetBaseException().Message);
                }
                finally
                {
                    if (webResponse != null)
                    {
                        webResponse.Close();
                    }
                }
            }, null);
        }
        #endregion
        #region 使用FromAsync方法將APM轉換為TAP
        private void APMswitchToTAP()
        {
            WebRequest webRq = WebRequest.Create("http://msdn.microsoft.com/zh-CN/");
            Task.Factory.FromAsync<WebResponse>(webRq.BeginGetResponse, webRq.EndGetResponse, null, TaskCreationOptions.None).
                ContinueWith(t =>
                {
                    WebResponse webResponse = null;
                    try
                    {
                        webResponse = t.Result;
                        Console.WriteLine("請求的內容大小為： " + webResponse.ContentLength);
                    }
                    catch (AggregateException ex)
                    {
                        if (ex.GetBaseException() is WebException)
                        {
                            Console.WriteLine("異常發生，異常信息為： " + ex.GetBaseException().Message);
                        }
                        else
                        {
                            throw;
                        }
                    }
                    finally
                    {
                        if (webResponse != null)
                        {
                            webResponse.Close();
                        }
                    }
                });
        }
        #endregion

上面代碼演示了使用APM的原始實現方式以及如何使用FromAsync方法把APM的實現方式轉換為TAP的實現方法，把這兩種方式放在一起，一是可以幫助大家做一個對比，使大家更容易明白APM與TAP的轉換，二是大家也可以通過上面的對比明白TAP與APM的區別。

4.2 將EAP轉化為TAP

處理APM可以升級為用TAP來實現外，對于EAP，我們同樣可以對其轉換為TAP的方式，下面代碼演示了如何將EAP轉換為TAP的實現方式：

#region 將EAP轉換為TAP的實現方式
            // webClient類支持基于事件的異步模式(EAP)
            WebClient webClient = new WebClient();
            // 創建TaskCompletionSource和它底層的Task對象
            TaskCompletionSource<string> tcs = new TaskCompletionSource<string>();
            // 一個string下載好之后，WebClient對象會應發DownloadStringCompleted事件
            webClient.DownloadStringCompleted += (sender, e) =>
            {
                // 下面的代碼是在GUI線程上執行的
                // 設置Task狀態
                if (e.Error != null)
                {
                    // 試圖將基礎Tasks.Task<TResult>轉換為Tasks.TaskStatus.Faulted狀態
                    tcs.TrySetException(e.Error);
                }
                else if (e.Cancelled)
                {
                    // 試圖將基礎Tasks.Task<TResult>轉換為Tasks.TaskStatus.Canceled狀態
                    tcs.TrySetCanceled();
                }
                else
                {
                    // 試圖將基礎Tasks.Task<TResult>轉換為TaskStatus.RanToCompletion狀態。
                    tcs.TrySetResult(e.Result);
                }
            };
            // 當Task完成時繼續下面的Task,顯示Task的狀態
            // 為了讓下面的任務在GUI線程上執行，必須標記為TaskContinuationOptions.ExecuteSynchronously
            // 如果沒有這個標記，任務代碼會在一個線程池線程上運行
            tcs.Task.ContinueWith(t =>
            {
                if (t.IsCanceled)
                {
                    Console.WriteLine("操作已被取消");
                }
                else if (t.IsFaulted)
                {
                    Console.WriteLine("異常發生，異常信息為：" + t.Exception.GetBaseException().Message);
                }
                else
                {
                    Console.WriteLine(String.Format("操作已完成，結果為：{0}", t.Result));
                }
            }, TaskContinuationOptions.ExecuteSynchronously);
            // 開始異步操作
            webClient.DownloadStringAsync(new Uri("http://msdn.microsoft.com/zh-CN/"));
            #endregion

五、小結

　　本專題關于TAP的內容就介紹到這里了，本專題主要以實現一個文件下載程序要講述基于任務的異步模式所帶來的簡便，這個也是.NET 4.0中提出TAP的原因所在吧，最后介紹了TAP與APM和EAP模式之間的轉化，通過這部分大家可以清楚知道以前的異步實現如何向新的異步模式的遷移，以及從他們的轉換實現代碼中也可以比較他們之間的不同。然而在.NET 4.5中，微軟對異步編程又做了更好的支持——提供了async和await兩個關鍵字，這兩個關鍵字使我們異步編程如同步編程一樣的簡單，徹底改變了實現異步編程所面臨的委托回調，跨線程訪問控件等問題，具體這部分內容，我將在下個專題中為大家介紹。