快捷導(dǎo)航

C# BackgroundWorker用法詳解

更新時(shí)間：2017年04月12日 15:16:09 作者：sparkdev

本篇文章主要介紹了C# BackgroundWorker使用詳解，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

在C#程序中，經(jīng)常會(huì)有一些耗時(shí)較長的CPU密集型運(yùn)算，如果直接在 UI 線程執(zhí)行這樣的運(yùn)算就會(huì)出現(xiàn)UI不響應(yīng)的問題。解決這類問題的主要途徑是使用多線程，啟動(dòng)一個(gè)后臺(tái)線程，把運(yùn)算操作放在這個(gè)后臺(tái)線程中完成。但是原生接口的線程操作有一些難度，如果要更進(jìn)一步的去完成線程間的通信就會(huì)難上加難。

還好 .NET 類庫中提供了一個(gè)叫做 BackgroundWorker 的類可以比較優(yōu)雅的解決這類問題。雖然BackgroundWorker 類使用起來比較簡單，但其中還是有一些需要注意的細(xì)節(jié)，下面我們就通過 demo 程序介紹它的主要用法。我們?cè)?demo中計(jì)算1到100的累加和，為了演示，每次計(jì)算都 sleep 600毫秒，demo 的UI為：

用法概述

在窗體上構(gòu)建一個(gè)BackgroundWorker 實(shí)例，在它的 DoWork事件處理函數(shù)中添加耗時(shí)的運(yùn)算，然后調(diào)用它的RunWorkerAsync方法就可以了。

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

是不是有點(diǎn)太簡單了？那么讓我們考慮下面的問題：

如果我們想要把參數(shù)傳遞給運(yùn)算過程該怎么做？

在運(yùn)算過程中我們希望把實(shí)時(shí)的信息顯示在UI上該怎么辦？

如果我們想要取消正在進(jìn)行的運(yùn)算該怎么辦？

如果運(yùn)算過程出現(xiàn)異常我們又該如何處理？

接下來我們就一個(gè)一個(gè)的處理這些問題。

把參數(shù)傳遞給運(yùn)算過程

直接把100寫死到運(yùn)算過程中可不好，我們還打算允許用戶指定求和的范圍呢！所以需要把100作為參數(shù)傳遞給計(jì)算過程。在概述中我們通過調(diào)用RunWorkerAsync方法啟動(dòng)計(jì)算過程，其實(shí)這個(gè)方法可以接受一個(gè) object 類型的參數(shù)。通過它我們就可以把任何數(shù)據(jù)傳遞給計(jì)算過程：

//別忘了設(shè)置滾動(dòng)條。
this.progressBarSum.Maximum = 100;
_demoBGWorker.RunWorkerAsync(100);
//下面是更新后的 BGWorker_DoWork 方法：
private void BGWorker_DoWork(object sender, DoWorkEventArgs e)
{
  //在這里執(zhí)行耗時(shí)的運(yùn)算。
  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事件處理函數(shù)通過參數(shù) e 的Argument屬性傳來了我們期望的運(yùn)算信息。

把消息傳遞給UI

由于計(jì)算過程比較長，我們?cè)谕ㄟ^進(jìn)度條來顯示當(dāng)前進(jìn)度的同時(shí)，還希望能實(shí)時(shí)的把計(jì)算的中間結(jié)果顯示在UI上。當(dāng)然，BackgroundWorker對(duì)這個(gè)用例也提供了很好的支持。它允許我們?cè)趫?zhí)行計(jì)算的過程中給UI線程發(fā)送消息，下面看看具體的做法：

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

首先要把WorkerReportsProgress 屬性設(shè)置為 true，然后為ProgressChanged 事件添加處理方法：

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

  //如果有更多的信息需要傳遞，可以使用 e.UserState 傳遞一個(gè)自定義的類型。
  //這是一個(gè) object 類型的對(duì)象，您可以通過它傳遞任何類型。
  //我們僅把當(dāng)前 sum 的值通過 e.UserState 傳回，并通過顯示在窗口上。
  string message = e.UserState.ToString();
  this.labelSum.Text = message;
}

繼續(xù)更新 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 事件處理函數(shù)。
    //第一個(gè)參數(shù)類型為 int，表示執(zhí)行進(jìn)度。
    //如果有更多的信息需要傳遞，可以使用 ReportProgress 的第二個(gè)參數(shù)。
    //這里我們給第二個(gè)參數(shù)傳進(jìn)去一條消息。
    bgWorker.ReportProgress(i, message);
    Thread.Sleep(600);
  }
}

OK，現(xiàn)在已經(jīng)可以看到進(jìn)度條和執(zhí)行信息的更新了。

取消操作

在執(zhí)行過程中允許用戶取消當(dāng)前的操作是一個(gè)基本的設(shè)計(jì)，BackgroundWorker自然有很好的支持：

_demoBGWorker.WorkerSupportsCancellation = true;

和WorkerReportsProgress屬性一樣，如果要支持取消操作我們需要設(shè)置 WorkerSupportsCancellation屬性為 true。并且還要在BGWorker_DoWork方法中進(jìn)行支持，在 for 循環(huán)中 Thread.Sleep(600)后面添加代碼：

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

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

如果檢測到用戶點(diǎn)擊的取消按鈕，就退出當(dāng)前的計(jì)算過程。下面是點(diǎn)擊取消按鈕時(shí)要調(diào)用的代碼：

_demoBGWorker.CancelAsync();

現(xiàn)在已經(jīng)可以支持取消操作了，趕快試試吧！

異常處理

如果在計(jì)算過程中發(fā)生了異常該怎么處理？有沒有辦法知道計(jì)算過程已經(jīng)結(jié)束？當(dāng)然要有，即便是正常的結(jié)束也需要拿到計(jì)算的結(jié)果。

_demoBGWorker.RunWorkerCompleted += BGWorker_RunWorkerCompleted;
private void BGWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
  //如果用戶取消了當(dāng)前操作就關(guān)閉窗口。
  if (e.Cancelled)
  {
    this.Close();
  }

  //計(jì)算已經(jīng)結(jié)束，需要禁用取消按鈕。
  this.btnCancel.Enabled = false;

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

  //計(jì)算結(jié)果信息：e.Result
  //use it do something.
}

RunWorkerCompleted 事件處理函數(shù)會(huì)在DoWork 事件處理函數(shù)返回后被調(diào)用。通過它我們可以進(jìn)行一些運(yùn)算結(jié)束后的操作，比如禁用取消按鈕，異常處理，結(jié)果顯示等。

注意，如果想要拿到 e.Result，您需要在BGWorker_DoWork方法中設(shè)置 e.Result屬性，如：