WinForm中非同步載入資料並使用進度條

標籤：

在WinForm程式中，有時會因為載入大量資料導致UI介面假死，這種情況對於使用者來說是非常不友好的。因此，在載入大量資料的情況下，首先應該將資料載入放在另一線程中進行，這樣保證了UI介面的響應；其次可以提供一個進度條使使用者明白程式正在載入資料，同時清楚知道目前載入的進度。

實現上述功能的一個簡單的方式是利用 System.ComponentModel 中的工具類：BackgroundWorker，它支援取消，進度報告，異常轉寄，並且實現了 IComponent 介面，意味著可以直接在VS設計器中從工具箱中拖到介面上使用。

下面以一個例子來說明如何使用 BackgroundWorker，更詳細的 BackgroundWorker 說明可以參考Threading in C#（或者 中文翻譯）：

1. UI介面添加一個進度條，一個開始按鈕，一個結束按鈕，以及BackgroundWorker，並設定下列 BackgroundWorker 屬性（例子中設定了其Name為bw）：

 

• WorkerReportsProcess：預設為False，將其設定為True，支援進度報告
• WorkerSupportsCancellation：預設為False，將其設定為True，支援取消

2. DoWork事件，在其中執行我們的資料載入，我們執行一個迴圈來類比資料載入

private void bw_DoWork(object sender, DoWorkEventArgs e){    var count = (int)e.Argument;    for (int i = 1; i <= count; i++)    {        if (bw.CancellationPending)        {            e.Cancel = true;            return;        }                            bw.ReportProgress(i);        Thread.Sleep(200);      // 類比耗時的任務    }                          }

• 注意：在這個方法中不能進行UI控制項的更新。
• 通過檢查 CancellationPending 來判斷使用者是否進行了取消
• 通過調用 ReportProgress 來報告進度

 

3. ProgressChanged 事件，在這裡可以操作進度條，以及其他UI控制項。

private void bw_ProgressChanged(object sender, ProgressChangedEventArgs e){    progressBar.Value = e.ProgressPercentage;    resultTextBox.Text += DateTime.Now + "\r\n";}

通過e.ProgressPercentage來擷取任務執行過程中設定的進度，以此來更新進度條。

4. RunWorkerCompleted 事件，在這裡可以更新UI，以及進行異常處理。

private void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e){    if (e.Cancelled)        resultTextBox.Text += "任務取消。" + "\r\n";    else if (e.Error != null)        resultTextBox.Text += "出現異常: " + e.Error + "\r\n";    else        resultTextBox.Text += "任務完成。 " + "\r\n";}

當執行過程中出現異常時，異常會被轉寄到這裡，因此可以在這裡處理異常。

5. 通過一個開始按鈕調和一個取消按鈕來控制：

• bw.RunWorkerAsync()   啟動
• bw.CancelAsync()  取消

下邊是完整的代碼及輸出：

public partial class Form1 : Form{    public Form1()    {        InitializeComponent();        bw.DoWork += bw_DoWork;        bw.ProgressChanged += bw_ProgressChanged;        bw.RunWorkerCompleted += bw_RunWorkerCompleted;    }    private void startButton_Click(object sender, EventArgs e)    {        progressBar.Value = 0;        progressBar.Maximum = 10;        resultTextBox.Text = "任務開始..." + "\r\n";        bw.RunWorkerAsync(10);    }    private void bw_DoWork(object sender, DoWorkEventArgs e)    {        var count = (int)e.Argument;        for (int i = 1; i <= count; i++)        {            if (bw.CancellationPending)            {                e.Cancel = true;                return;            }            if (i == 2)                throw new Exception("出錯啦！");                                bw.ReportProgress(i);            Thread.Sleep(200);              }                              }    private void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)    {        if (e.Cancelled)            resultTextBox.Text += "任務取消。" + "\r\n";        else if (e.Error != null)            resultTextBox.Text += "出現異常: " + e.Error + "\r\n";        else            resultTextBox.Text += "任務完成。 " + "\r\n";    }    private void bw_ProgressChanged(object sender, ProgressChangedEventArgs e)    {        progressBar.Value = e.ProgressPercentage;        resultTextBox.Text += DateTime.Now + "\r\n";    }    private void cancelbutton_Click(object sender, EventArgs e)    {        bw.CancelAsync();    }}

輸出如下：

 

參考：Threading in C# --> 中文翻譯

WinForm中非同步載入資料並使用進度條