[C#] 走進異步編程的世界 - 在 GUI 中執行異步操做

時間 2019-12-19

標籤 c# 走進異步編程世界 gui 執行欄目 C# 简体版

原文原文鏈接

走進異步編程的世界 - 在 GUI 中執行異步操做

【博主】反骨仔　　【原文地址】http://www.cnblogs.com/liqingwen/p/5877042.html

序

　　這是繼《開始接觸 async/await 異步編程》、《走進異步編程的世界 - 剖析異步方法》後的第三篇。主要介紹在 WinForm 中如何執行異步操做。html

1、在 WinForm 程序中執行異步操做

　　下面經過窗體示例演示如下操做-點擊按鈕後：編程

　　　　①將按鈕禁用，並將標籤內容改爲：「Doing」（表示執行中）；異步

　　　　②線程掛起3秒（模擬耗時操做）；async

　　　　③啓用按鈕，將標籤內容改成：「Complete」（表示執行完成）。異步編程

 1     public partial class Form1 : Form
 2     {
 3         public Form1()
 4         {
 5             InitializeComponent();
 6         }
 7 
 8         private void btnDo_Click(object sender, EventArgs e)
 9         {
10             btnDo.Enabled = false;
11             lblText.Text = @"Doing";
12 
13             Thread.Sleep(3000);
14 
15             btnDo.Enabled = true;
16             lblText.Text = @"Complete";
17         }
18     }

　　但是執行結果倒是：工具

圖1-1oop

　　【發現的問題】post

　　　　①好像沒有變成「Doing」？url

　　　　②而且拖動窗口的時候卡住不動了？spa

　　　　③3秒後忽然變到想拖動到的位置？

　　　　④同時文本變成「Complete」？

　　【分析】GUI 程序在設計中要求全部的顯示變化都必須在主 GUI 線程中完成，如點擊事件和移動窗體。Windows 程序時經過消息來實現，消息放入消息泵管理的消息隊列中。點擊按鈕時，按鈕的Click消息放入消息隊列。消息泵從隊列中移除該消息，並開始處理點擊事件的代碼，即 btnDo_Click 事件的代碼。

　　btnDo_Click 事件會將觸發行爲的消息放入隊列，但在 btnDo_Click 時間處理程序徹底退出前（線程掛起 3 秒退出前），消息都沒法執行。（3 秒後）接着全部行爲都發生了，但速度太快肉眼沒法分辨纔沒有發現標籤改爲「Doing」。

圖1-2 點擊事件

圖1-3 點擊事件具體執行過程

　　如今咱們加入 async/await 特性。

 1     public partial class Form1 : Form
 2     {
 3         public Form1()
 4         {
 5             InitializeComponent();
 6         }
 7 
 8         private async void btnDo_Click(object sender, EventArgs e)
 9         {
10             btnDo.Enabled = false;
11             lblText.Text = @"Doing";
12 
13             await Task.Delay(3000);
14 
15             btnDo.Enabled = true;
16             lblText.Text = @"Complete";
17         }
18     }

圖1-4

　　如今，就是原先但願看到的效果。

　　【分析】btnDo_Click 事件處理程序先將前兩條消息壓入隊列，而後將本身從處理器移出，在3秒後（等待空閒任務完成後 Task.Delay ）再將本身壓入隊列。這樣能夠保持響應，並保證全部的消息能夠在線程掛起的時間內被處理。

1.1 Task.Yield

　　Task.Yield 方法建立一個馬上返回的 awaitable。等待一個Yield可讓異步方法在執行後續部分的同時返回到調用方法。能夠將其理解爲離開當前消息隊列，回到隊列末尾，讓 CPU 有時間處理其它任務。

 1     class Program
 2     {
 3         static void Main(string[] args)
 4         {
 5             const int num = 1000000;
 6             var t = DoStuff.Yield1000(num);
 7 
 8             Loop(num / 10);
 9             Loop(num / 10);
10             Loop(num / 10);
11 
12             Console.WriteLine($"Sum: {t.Result}");
13 
14             Console.Read();
15         }
16 
17         /// <summary>
18         /// 循環
19         /// </summary>
20         /// <param name="num"></param>
21         private static void Loop(int num)
22         {
23             for (var i = 0; i < num; i++) ;
24         }
25     }
26 
27     internal static class DoStuff
28     {
29         public static async Task<int> Yield1000(int n)
30         {
31             var sum = 0;
32             for (int i = 0; i < n; i++)
33             {
34                 sum += i;
35                 if (i % 1000 == 0)
36                 {
37                     await Task.Yield(); //建立異步產生當前上下文的等待任務
38                 }
39             }
40 
41             return sum;
42         }
43     }

圖1.1-1

　　上述代碼每執行1000次循環就調用 Task.Yield 方法建立一個等待任務，讓處理器有時間處理其它任務。該方法在 GUI 程序中是比較有用的。

2、在 WinForm 中使用異步 Lambda 表達式

　　將剛纔的窗口程序的點擊事件稍微改動一下。

 1     public partial class Form1 : Form
 2     {
 3         public Form1()
 4         {
 5             InitializeComponent();
 6 
 7             //async (sender, e) 異步表達式
 8             btnDo.Click += async (sender, e) =>
 9             {
10                 Do(false, "Doing");
11 
12                 await Task.Delay(3000);
13 
14                 Do(true, "Finished");
15             };
16         }
17 
18         private void Do(bool isEnable, string text)
19         {
20             btnDo.Enabled = isEnable;
21             lblText.Text = text;
22         }
23     }

　　仍是原來的配方，仍是熟悉的味道，仍是原來哪一個窗口，變的只是內涵。

圖2-1

3、一個完整的 WinForm 程序

　　如今在原來的基礎上添加了進度條，以及取消按鈕。

 1     public partial class Form1 : Form
 2     {
 3         private CancellationTokenSource _source;
 4         private CancellationToken _token;
 5 
 6         public Form1()
 7         {
 8             InitializeComponent();
 9         }
10 
11         /// <summary>
12         /// Do 按鈕事件
13         /// </summary>
14         /// <param name="sender"></param>
15         /// <param name="e"></param>
16         private async void btnDo_Click(object sender, EventArgs e)
17         {
18             btnDo.Enabled = false;
19 
20             _source = new CancellationTokenSource();
21             _token = _source.Token;
22 
23             var completedPercent = 0; //完成百分比
24             const int time = 10; //循環次數
25             const int timePercent = 100 / time; //進度條每次增長的進度值
26 
27             for (var i = 0; i < time; i++)
28             {
29                 if (_token.IsCancellationRequested)
30                 {
31                     break;
32                 }
33 
34                 try
35                 {
36                     await Task.Delay(500, _token);
37                     completedPercent = (i + 1) * timePercent;
38                 }
39                 catch (Exception)
40                 {
41                     completedPercent = i * timePercent;
42                 }
43                 finally
44                 {
45                     progressBar.Value = completedPercent;
46                 }
47             }
48 
49             var msg = _token.IsCancellationRequested ? $"進度爲：{completedPercent}% 已被取消！" : $"已經完成";
50 
51             MessageBox.Show(msg, @"信息");
52 
53             progressBar.Value = 0;
54             InitTool();
55         }
56 
57         /// <summary>
58         /// 初始化窗體的工具控件
59         /// </summary>
60         private void InitTool()
61         {
62             progressBar.Value = 0;
63             btnDo.Enabled = true;
64             btnCancel.Enabled = true;
65         }
66 
67         /// <summary>
68         /// 取消事件
69         /// </summary>
70         /// <param name="sender"></param>
71         /// <param name="e"></param>
72         private void btnCancel_Click(object sender, EventArgs e)
73         {
74             if (btnDo.Enabled) return;
75 
76             btnCancel.Enabled = false;
77             _source.Cancel();
78         }
79     }

圖3-1

4、另外一種異步方式 - BackgroundWorker 類

　　與 async/await 不一樣的是，你有時候可能須要一個額外的線程，在後臺持續完成某項任務，並不時與主線程通訊，這時就須要用到 BackgroundWorker 類。主要用於 GUI 程序。

　　書中的千言萬語不及一個簡單的示例。

 1     public partial class Form2 : Form
 2     {
 3         private readonly BackgroundWorker _worker = new BackgroundWorker();
 4 
 5         public Form2()
 6         {
 7             InitializeComponent();
 8 
 9             //設置 BackgroundWorker 屬性
10             _worker.WorkerReportsProgress = true;   //可否報告進度更新
11             _worker.WorkerSupportsCancellation = true;  //是否支持異步取消
12 
13             //鏈接 BackgroundWorker 對象的處理程序
14             _worker.DoWork += _worker_DoWork;   //開始執行後臺操做時觸發，即調用 BackgroundWorker.RunWorkerAsync 時觸發
15             _worker.ProgressChanged += _worker_ProgressChanged; //調用 BackgroundWorker.ReportProgress(System.Int32) 時觸發
16             _worker.RunWorkerCompleted += _worker_RunWorkerCompleted;   //當後臺操做已完成、被取消或引起異常時觸發
17         }
18 
19         /// <summary>
20         /// 當後臺操做已完成、被取消或引起異常時發生
21         /// </summary>
22         /// <param name="sender"></param>
23         /// <param name="e"></param>
24         private void _worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
25         {
26             MessageBox.Show(e.Cancelled ? $@"進程已被取消：{progressBar.Value}%" : $@"進程執行完成：{progressBar.Value}%");
27             progressBar.Value = 0;
28         }
29 
30         /// <summary>
31         /// 調用 BackgroundWorker.ReportProgress(System.Int32) 時發生
32         /// </summary>
33         /// <param name="sender"></param>
34         /// <param name="e"></param>
35         private void _worker_ProgressChanged(object sender, ProgressChangedEventArgs e)
36         {
37             progressBar.Value = e.ProgressPercentage;   //異步任務的進度百分比
38         }
39 
40         /// <summary>
41         /// 開始執行後臺操做觸發，即調用 BackgroundWorker.RunWorkerAsync 時發生
42         /// </summary>
43         /// <param name="sender"></param>
44         /// <param name="e"></param>
45         private static void _worker_DoWork(object sender, DoWorkEventArgs e)
46         {
47             var worker = sender as BackgroundWorker;
48             if (worker == null)
49             {
50                 return;
51             }
52 
53             for (var i = 0; i < 10; i++)
54             {
55                 //判斷程序是否已請求取消後臺操做
56                 if (worker.CancellationPending)
57                 {
58                     e.Cancel = true;
59                     break;
60                 }
61 
62                 worker.ReportProgress((i + 1) * 10);    //觸發 BackgroundWorker.ProgressChanged 事件
63                 Thread.Sleep(250);  //線程掛起 250 毫秒
64             }
65         }
66 
67         private void btnDo_Click(object sender, EventArgs e)
68         {
69             //判斷 BackgroundWorker 是否正在執行異步操做
70             if (!_worker.IsBusy)
71             {
72                 _worker.RunWorkerAsync();   //開始執行後臺操做
73             }
74         }
75 
76         private void btnCancel_Click(object sender, EventArgs e)
77         {
78             _worker.CancelAsync();  //請求取消掛起的後臺操做
79         }
80     }