C# BackgroundWorker详解，图例，原理分析

http://hi.baidu.com/jiang_yy_jiang/blog/item/c96c4826299fce008b82a126.html

先声明，大部分资料均参考网上，进行了整理。

1.

在VS中添加了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事件来实现。

明白了BagkgroundWorker的事件调用顺序和参数传递机制之后在使用该组件用于多线程编程的时候就可以轻松许多了。详细的实例可以在我写的天涯离线浏览器中看到。

2.

凡是WinForm的应用程序，如果他执行了一个的非常冗长的处理操作（比如文件查询），它在执行时会锁定用户界面，虽然主活动窗口 一直在运行，但用户无法与程序交互，无法移动窗体或改变窗体大小，所以用户感觉很不爽。如何做才能使得这个程序有响应。答案就是在后台线程中执行这个操 作。

在这里已经有了多种方法来做这个事情：

(一)委托异步调用

将具体耗时的操作作为一个委托，并用BeginInvoke来异步执行这个委托（Invoke是同步调用），并且可以为这个操作传入参数并且通过EndInvoke方法获得返回返回值。

(二)使用ThreadPool

新建.net FrameWork中自带的WaitCallback委托，然后放到线程池中运行ThreadPool.QueueUserWorkItem( callback ); 根据WaitCallback委托的定义，可以传入一个object类型的参数。

但是不能精确的控制线程池中的线程。

(三)使用Thread

和ThreadPool相比，使用Thread的开销会比较大。但是它有它的优势，使用 Thread 类可以显式管理线程。只要有可能，就应该使用 ThreadPool 类来创建线程。然而，在一些情况下，您还是需要创建并管理您自己的线程，而不是使用 ThreadPool 类。在.net 2.0 中，提供了一个新的委托 ParameterizedThreadStart 支持启动一个线程并传入参数，这是对原来的ThreadStart委托的改进。

说了这么多还没有说到今天的主角BackgroundWorker，他也是一个在2.0中新增的类,可以用于启动后台线程,并在后台计算结束后调用主线程 的方法.可以看出同样的功能使用委托的异步调用也可以实现，只是使用BackgroundWorker的话会更加的简便快捷，可以节省开发时间，并把你从 创建自己的委托以及对它们的调用中解救出来。真是这样的吗看看下面这个例子。其实我也是从101Samples中看到的例子。

先看看BackgroundWorker中的主要概念。

第一：主要的事件及参数。

DoWork——当执行BackgroundWorker.RunWorkerAsync方法时会触发该事件，并且传递DoWorkEventArgs参数;

ProgressChanged——操作处理中获得的处理状态变化，通过BackgroundWorker.ReportProgress(int)方法 触发该事件，并且传递ProgressChangedEventArgs,其中包含了处理的百分比;

RunWorkerCompleted ——异步操作完成后会触发该事件，当然如果需要在操作过程中结束可以执行BackgroundWorker.CancelAsync方法要求异步调用中 止，并且在异步委托操作中检测BackgroundWorker.CancellationPending属性如果为true的话，跳出异步调用，同时将 DoWorkEventArgs.Cancel属性设为true，这样当退出异步调用的时候，可以让处理RunWorkerCompleted事件的函数 知道是正常退出还是中途退出。

第二：主要的方法。

BackgroundWorker.RunWorkerAsync——

“起动”异步调用的方法有两次重载RunWorkerAsync(),RunWorkerAsync(object argument)，第二个重载提供了一个参数，可以供异步调用使用。（如果有多个参数要传递怎么办，使用一个类来传递他们吧)。调用该方法后会触发 DoWork事件，并且为处理DoWork事件的函数DoWorkEventArg事件参数，其中包含了RunWorkerAsync传递的参数。在相应 DoWork的处理函数中就可以做具体的复杂操作。

BackgroundWorker.ReportProgress——

有时候需要在一个冗长的操作中向用户不断反馈进度，这样的话就可以调用的ReportProgress(int percent),在调用 ReportProgress 方法时，触发ProgressChanged事件。提供一个在 0 到 100 之间的整数，它表示后台活动已完成的百分比。你也可能提供任何对象作为第二个参数，允许你 给事件处理程序传递状态信息。作为传递到此过程的 ProgressChangedEventArgs 参数属性，百分比和你自己的对象（如果提供的话）均要被传递到 ProgressChanged
事件处理程序。这些属性被分别命名为 ProgressPercentage 和 UserState，并且你的事件处理程序可以以任何需要的方式使用它们。(注意：只有在 BackgroundWorker.WorkerReportsProgress属性被设置为true该方法才可用)。

BackgroundWorker.CancelAsync——

但需要退出异步调用的时候，就调用的这个方法。但是样还不够，因为它仅仅是将BackgroudWorker.CancellationPending属 性设置为true。你需要在具体的异步调用处理的时候，不断检查BackgroudWorker.CancellationPending是否为 true，如果是真的话就退出。(注意：只有在BackgroundWorker.WorkerSupportsCancellation属性被设置为 true该方法才可用)。

贴出一段101Samples里面的代码，看一下就明白了：

public partial
class MainForm : Form

{

private System.ComponentModel.BackgroundWorker backgroundCalculator;

public MainForm()

{

InitializeComponent();

backgroundCalculator =new BackgroundWorker();

backgroundCalculator.WorkerReportsProgress =true;

backgroundCalculator.WorkerSupportsCancellation =true;

backgroundCalculator.DoWork +=

new DoWorkEventHandler(backgroundCalculator_DoWork);

backgroundCalculator.ProgressChanged +=

new ProgressChangedEventHandler(backgroundCalculator_ProgressChanged);

backgroundCalculator.RunWorkerCompleted +=

new RunWorkerCompletedEventHandler(backgroundCalculator_RunWorkerCompleted);

updateStatus(String.Empty);

}

privateint getNextPrimeAsync(int start, BackgroundWorker worker, DoWorkEventArgs e)

{

int percentComplete
=0;

start++;

while (!isPrime(start))

{

// Check for cancellation

if (worker.CancellationPending)

{

e.Cancel =true;

break;

}

else

{

start++;

percentComplete++;

worker.ReportProgress(percentComplete %100);

}

}

return start;

}

void backgroundCalculator_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)

{

if (e.Cancelled)

{

updateStatus("Cancelled.");

}

elseif (e.Error
!=null)

{

reportError(e.Error);

}

else

{

reportPrime((int)e.Result);

}

calcProgress.Value =0;

}

void backgroundCalculator_ProgressChanged(object sender, ProgressChangedEventArgs e)

{

updateProgress(e.ProgressPercentage);

}

void backgroundCalculator_DoWork(object sender, DoWorkEventArgs e)

{

int start
= (int) e.Argument;

e.Result = getNextPrimeAsync(start, (BackgroundWorker)sender, e);

}

privatevoid nextPrimeAsyncButton_Click(object sender, EventArgs e)

{

updateStatus("Calculating...");

int start;

Int32.TryParse(textBoxPrime.Text, out start);

if (start
==0)

{

reportError("The number must be a valid integer");

}

else

{

// Kick off the background worker process

backgroundCalculator.RunWorkerAsync(int.Parse(textBoxPrime.Text));

}

}

privatevoid cancelButton_Click(object sender, EventArgs e)

{

if (backgroundCalculator.IsBusy)

{

updateStatus("Cancelling...");

backgroundCalculator.CancelAsync();

}

}

// Update the Status label

privatevoid updateStatus(string status)

{

calcStatus.Text = status;

}

// Indicate progress using progress bar

privatevoid updateProgress(int percentComplete)

{

calcProgress.Value = percentComplete;

}

}
BackgroundWorker创建自己的委托并调用这个窗体的 Invoke 方法来运行它，BackgroundWorker 组件以一种优雅的方式来处理这个线程转换。BackgroundWorker 组件允许你从后台线程中调用它的 ReportProgress 方法，该方法触发其 ProgressChanged 事件处理例程返回到窗体的线程中。你不必使用 delegate/Invoke 方法自己处理这个线程转换，而是调用 ReportProgress，其余的事情交给组件来做。