程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> .NET網頁編程 >> C# >> C#入門知識 >> C# BackgroundWorker用法詳解

C# BackgroundWorker用法詳解

編輯:C#入門知識

C# BackgroundWorker用法詳解。本站提示廣大學習愛好者:(C# BackgroundWorker用法詳解)文章只能為提供參考,不一定能成為您想要的結果。以下是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 類功能完善且使用簡便,實在是處理異步耗時操作的利器!

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved