WinForm中使用BackgroundWorker異步加載數據並使用進度條

時間 2020-09-20

標籤 winform 使用 backgroundworker 異步加載數據並使進度简体版

原文原文鏈接

在WinForm程序中，有時會由於加載大量數據致使UI界面假死，這種狀況對於用戶來講是很是不友好的。所以，在加載大量數據的狀況下，首先應該將數據加載放在另外一線程中進行，這樣保證了UI界面的響應；其次能夠提供一個進度條使用戶明白程序正在加載數據，同時清楚知道目前加載的進度。html

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

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

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

WorkerReportsProcess：默認爲False，將其設置爲True，支持進度報告
WorkerSupportsCancellation：默認爲False，將其設置爲True，支持取消

2. DoWork事件，在其中執行咱們的數據加載，咱們執行一個循環來模擬數據加載spa

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";
}

當執行過程當中出現異常時，異常會被轉發到這裏，所以能夠在這裏處理異常。code

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

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();
    }
}