C# BackgroundWorker的使用

標籤：winform   style   blog   http   io   color   ar   使用   for   

文章摘自：http://www.cnblogs.com/tom-tong/archive/2012/02/22/2363965.html

 

BackgroundWorker 可以用於啟動後台線程。

主要的事件及參數：
　　1.DoWork——當執行BackgroundWorker.RunWorkerAsync方法時會觸發該事件，並且傳遞DoWorkEventArgs參數;

　　2.RunWorkerCompleted——非同步作業完成或中途終止會觸發該事件。

如果需要提前終止執行後台操作，可以調用BackgroundWorker.CancelAsync方法。

在處理DoWork事件的函數中檢測BackgroundWorker.CancellationPending屬性是否為true，如果是true，則表示使用者已經取消了非同步呼叫，同時將DoWorkEventArgs.Cancel屬性設為true(傳遞給處理DoWork事件的函數的第二個參數)，這樣當退出非同步呼叫的時候，可以讓處理RunWorkerCompleted事件的函數知道是正常退出還是中途退出。
　　3.ProgressChanged——操作處理中獲得的處理狀態變化，通過BackgroundWorker.ReportProgress(int)方法觸發該事件，並且傳遞ProgressChangedEventArgs,其中包含了處理的百分比,這個參數在UI介面上設定progressbar控制項。   

   
 主要的方法：
         1. BackgroundWorker.RunWorkerAsync——“起動”非同步呼叫的方法有兩次重載RunWorkerAsync(),RunWorkerAsync(object argument)，第二個重載提供了一個參數，可以供非同步呼叫使用。（如果有多個參數要傳遞怎麼辦，使用一個類來傳遞他們吧)。調用該方法後會觸發DoWork事件，並且為處理DoWork事件的函數傳遞DoWorkEventArg參數，其中包含了RunWorkerAsync傳遞的參數。在相應DoWork的處理函數中就可以做具體的複雜操作。
        2. BackgroundWorker.ReportProgress——需要在一個冗長的操作中向使用者不斷反饋進度，這樣的話就可以調用的ReportProgress(int percent),在調用 ReportProgress 方法時，觸發ProgressChanged事件。提供一個在 0 到 100 之間的整數，它表示後台活動已完成的百分比。你也可以提供任何對象作為第二個參數，允許你 給事件處理常式傳遞狀態資訊。作為傳遞到此過程的 ProgressChangedEventArgs 參數屬性，百分比和你自己的對象（如果提供的話）均要被傳遞到 ProgressChanged 事件處理常式。這些屬性被分別命名為 ProgressPercentage 和 UserState，並且你的事件處理常式可以以任何需要的方式使用它們。(注意：只有在BackgroundWorker.WorkerReportsProgress屬性被設定為true該方法才可用)。
        3. BackgroundWorker.CancelAsync——但需要退出非同步呼叫的時候，就調用的這個方法。但是樣還不夠，因為它僅僅是將BackgroudWorker.CancellationPending屬性設定為true。你需要在具體的非同步呼叫處理的時候，不斷檢查BackgroudWorker.CancellationPending是否為true，如果是真的話就退出。(注意：只有在BackgroundWorker.WorkerSupportsCancellation屬性被設定為true該方法才可用)。

 

BackgroundWorker組件
在VS2005中添加了BackgroundWorker組件，該組件在多線程編程方面使用起來非常方便，然而在開始時由於沒有搞清楚它的使用機制，走了不少的彎路，現在把我在使用它的過程中的經驗與諸位分享一下。
    BackgroundWorker類中主要用到的有這列屬性、方法和事件：
    重要屬性：
    1、CancellationPending             擷取一個值，指示應用程式是否已請求取消後台操作。通過在DoWork事件中判斷CancellationPending屬性可以認定是否需要取消後台操作（也就是結束線程）；
    2、IsBusy                          擷取一個值，指示 BackgroundWorker 是否正在運行非同步作業。程式中使用IsBusy屬性用來確定後台操作是否正在使用中；
    3、WorkerReportsProgress           擷取或設定一個值，該值指示BackgroundWorker能否報告進度更新
    4、WorkerSupportsCancellation      擷取或設定一個值，該值指示 BackgroundWorker 是否支援非同步取消。設定WorkerSupportsCancellation為true使得程式可以調用CancelAsync方法提交終止掛起的後台操作的請求；
    重要方法：
    1、CancelAsync         請求取消掛起的後台操作
    2、RunWorkerAsync      開始執行後台操作
    3、ReportProgress      引發ProgressChanged事件  
    重要事件：
    1、DoWork              調用 RunWorkerAsync 時發生
    2、ProgressChanged     調用 ReportProgress 時發生
    3、RunWorkerCompleted  當後台操作已完成、被取消或引發異常時發生
    另外還有三個重要的參數是RunWorkerCompletedEventArgs以及DoWorkEventArgs、ProgressChangedEventArgs。
    BackgroundWorker的各屬性、方法、事件的調用機制和順序：

從可見在整個生活周期內發生了3次重要的參數傳遞過程：
    參數傳遞1：此次的參數傳遞是將RunWorkerAsync(Object)中的Object傳遞到DoWork事件的DoWorkEventArgs.Argument,由於在這裡只有一個參數可以傳遞，所以在實際應用往封裝一個類，將整個執行個體化的類作為RunWorkerAsync的Object傳遞到DoWorkEventArgs.Argument；
    參數傳遞2：此次是將程式運行進度傳遞給ProgressChanged事件，實際使用中往往使用給方法和事件更新進度條或者日誌資訊；
    參數傳遞3：在DoWork事件結束之前，將後台線程產生的結果資料賦給DoWorkEventArgs.Result一邊在RunWorkerCompleted事件中調用RunWorkerCompletedEventArgs.Result屬性取得後台線程產生的結果。
    另外從可以看到DoWork事件是在後台線程中啟動並執行，所以在該事件中不能夠操作使用者介面的內容，如果需要更新使用者介面，可以使用ProgressChanged事件及RunWorkCompleted事件來實現。


在WinForm中經常遇到一些費時的操作介面，比如統計某個磁碟分割的檔案夾或者檔案數目，如果分區很大或者檔案過多的話，處理不好就會造成“假死”的情況，或者報“線程間操作無效”的異常，為瞭解決這個問題，可以使用委託來處理，在.net2.0中還可以用BackgroundWorker類。

BackgroundWorker類是.net 2.0裡新增加的一個類，對於需要長時間操作而不需要使用者長時間等待的情況可以使用這個類。
注意確保在 DoWork 事件處理常式中不操作任何使用介面物件。而應該通過 ProgressChanged 和 RunWorkerCompleted 事件與使用者介面進行通訊。   

public partial class MainWindow : Window    {         private BackgroundWorker m_BackgroundWorker;// 申明後台對象         public MainWindow()        {            InitializeComponent();             m_BackgroundWorker = new BackgroundWorker(); // 執行個體化後台對象             m_BackgroundWorker.WorkerReportsProgress = true; // 設定可以通告進度            m_BackgroundWorker.WorkerSupportsCancellation = true; // 設定可以取消             m_BackgroundWorker.DoWork += new DoWorkEventHandler(DoWork);            m_BackgroundWorker.ProgressChanged += new ProgressChangedEventHandler(UpdateProgress);            m_BackgroundWorker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(CompletedWork);             m_BackgroundWorker.RunWorkerAsync(this);        }          void DoWork(object sender, DoWorkEventArgs e)        {            BackgroundWorker bw = sender as BackgroundWorker;            MainWindow win = e.Argument as MainWindow;             int i = 0;            while ( i <= 100 )            {                if (bw.CancellationPending)                {                    e.Cancel = true;                    break;                }                 bw.ReportProgress(i++);                     Thread.Sleep(1000);             }        }         void UpdateProgress(object sender, ProgressChangedEventArgs e)        {            int progress = e.ProgressPercentage;             label1.Content = string.Format("{0}",progress);        }          void CompletedWork(object sender, RunWorkerCompletedEventArgs e)        {            if ( e.Error != null)            {                MessageBox.Show("Error");            }            else if (e.Cancelled)            {                MessageBox.Show("Canceled");            }            else            {                MessageBox.Show("Completed");            }        }          private void button1_Click(object sender, RoutedEventArgs e)        {            m_BackgroundWorker.CancelAsync();        }    }

 

C# BackgroundWorker的使用