C# BackgroundWorker 詳解

在C#程序中，常常會有一些耗時較長的CPU密集型運算，若是直接在 UI 線程執行這樣的運算就會出現UI不響應的問題。解決這類問題的主要途徑是使用多線程，啓動一個後臺線程，把運算操做放在這個後臺線程中完成。可是原生接口的線程操做有一些難度，若是要更進一步的去完成線程間的通訊就會難上加難。

還好 .NET 類庫中提供了一個叫作 BackgroundWorker 的類能夠比較優雅的解決這類問題。雖然BackgroundWorker 類使用起來比較簡單，但其中仍是有一些須要注意的細節，下面咱們就經過 demo 程序介紹它的主要用法。咱們在 demo中計算1到100的累加和，爲了演示，每次計算都 sleep 600毫秒，demo 的UI爲：

用法概述

在窗體上構建一個BackgroundWorker 實例，在它的 DoWork事件處理函數中添加耗時的運算，而後調用它的RunWorkerAsync方法就能夠了。

private BackgroundWorker _demoBGWorker = new BackgroundWorker();
_demoBGWorker.DoWork += BGWorker_DoWork;
_demoBGWorker.RunWorkerAsync();
private void BGWorker_DoWork(object sender, DoWorkEventArgs e)
{
    //在這裏執行耗時的運算。
    int sum = 0;
    for (int i = 0; i <= 100; i++)
    {
        sum += i;
    }
}

是否是有點太簡單了？那麼讓咱們考慮下面的問題：

若是咱們想要把參數傳遞給運算過程該怎麼作？
在運算過程當中咱們但願把實時的信息顯示在UI上該怎麼辦？
若是咱們想要取消正在進行的運算該怎麼辦？
若是運算過程出現異常咱們又該如何處理？

接下來咱們就一個一個的處理這些問題。

把參數傳遞給運算過程

直接把100寫死到運算過程當中可很差，咱們還打算容許用戶指定求和的範圍呢！因此須要把100做爲參數傳遞給計算過程。在概述中咱們經過調用RunWorkerAsync方法啓動計算過程，其實這個方法能夠接受一個 object 類型的參數。經過它咱們就能夠把任何數據傳遞給計算過程：

//別忘了設置滾動條。
this.progressBarSum.Maximum = 100;
_demoBGWorker.RunWorkerAsync(100);
//下面是更新後的 BGWorker_DoWork 方法： private void BGWorker_DoWork(object sender, DoWorkEventArgs e)
{
    //在這裏執行耗時的運算。
    int endNumber = 0;
    if(e.Argument != null)
    {
        endNumber = (int)e.Argument;
    }
    int sum = 0;
    for (int i = 0; i <= endNumber; i++)
    {
        sum += i;
    }
}

BGWorker_DoWork事件處理函數經過參數 e 的Argument屬性傳來了咱們指望的運算信息。

把消息傳遞給UI

因爲計算過程比較長，咱們在經過進度條來顯示當前進度的同時，還但願能實時的把計算的中間結果顯示在UI上。固然，BackgroundWorker對這個用例也提供了很好的支持。它容許咱們在執行計算的過程當中給UI線程發送消息，下面看看具體的作法：

_demoBGWorker.WorkerReportsProgress = true;
_demoBGWorker.ProgressChanged += BGWorker_ProgressChanged;

首先要把WorkerReportsProgress 屬性設置爲 true，而後爲ProgressChanged 事件添加處理方法：

private void BGWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
    //修改進度條的顯示。
    this.progressBarSum.Value = e.ProgressPercentage;

    //若是有更多的信息須要傳遞，可使用 e.UserState 傳遞一個自定義的類型。
    //這是一個 object 類型的對象，您能夠經過它傳遞任何類型。
    //咱們僅把當前 sum 的值經過 e.UserState 傳回，並經過顯示在窗口上。
    string message = e.UserState.ToString();
    this.labelSum.Text = message;
}

繼續更新 BGWorker_DoWork方法：

private void BGWorker_DoWork(object sender, DoWorkEventArgs e)
{
    BackgroundWorker bgWorker = sender as BackgroundWorker;
    int endNumber = 0;
    if(e.Argument != null)
    {
        endNumber = (int)e.Argument;
    }

    int sum = 0;
    for (int i = 0; i <= endNumber; i++)
    {
        sum += i;
        
        string message = "Current sum is: " + sum.ToString();
        //ReportProgress 方法把信息傳遞給 ProcessChanged 事件處理函數。
        //第一個參數類型爲 int，表示執行進度。
        //若是有更多的信息須要傳遞，可使用 ReportProgress 的第二個參數。
        //這裏咱們給第二個參數傳進去一條消息。
        bgWorker.ReportProgress(i, message);
        Thread.Sleep(600);
    }
}

OK，如今已經能夠看到進度條和執行信息的更新了。

取消操做

在執行過程當中容許用戶取消當前的操做是一個基本的設計，BackgroundWorker天然有很好的支持：

_demoBGWorker.WorkerSupportsCancellation = true;

和WorkerReportsProgress屬性同樣，若是要支持取消操做咱們須要設置 WorkerSupportsCancellation屬性爲 true。而且還要在BGWorker_DoWork方法中進行支持，在 for 循環中 Thread.Sleep(600)後面添加代碼：

bgWorker.ReportProgress(i, message);
Thread.Sleep(600);

//在操做的過程當中須要檢查用戶是否取消了當前的操做。
if (bgWorker.CancellationPending == true)
{
    e.Cancel = true;
    break;
}

若是檢測到用戶點擊的取消按鈕，就退出當前的計算過程。下面是點擊取消按鈕時要調用的代碼：

_demoBGWorker.CancelAsync();

如今已經能夠支持取消操做了，趕快試試吧！

異常處理

若是在計算過程當中發生了異常該怎麼處理？有沒有辦法知道計算過程已經結束？固然要有，即使是正常的結束也須要拿到計算的結果。

_demoBGWorker.RunWorkerCompleted += BGWorker_RunWorkerCompleted;
private void BGWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    //若是用戶取消了當前操做就關閉窗口。
    if (e.Cancelled)
    {
        this.Close();
    }

    //計算已經結束，須要禁用取消按鈕。
    this.btnCancel.Enabled = false;

    //計算過程當中的異常會被抓住，在這裏能夠進行處理。
    if (e.Error != null)
    {
        Type errorType = e.Error.GetType();
        switch (errorType.Name)
        {
            case "ArgumentNullException":
            case "MyException":
                //do something.
                break;
            default:
                //do something.
                break;
        }
    }

    //計算結果信息：e.Result
    //use it do something.
}

RunWorkerCompleted 事件處理函數會在DoWork 事件處理函數返回後被調用。經過它咱們能夠進行一些運算結束後的操做，好比禁用取消按鈕，異常處理，結果顯示等。
注意，若是想要拿到 e.Result，您須要在BGWorker_DoWork方法中設置 e.Result屬性，如：

e.Result = sum;

 

總結，BackgroundWorker 類功能完善且使用簡便，實在是處理異步耗時操做的利器！