在C#中，经常会有一些耗时较长的CPU密集型运算，因为如果直接在UI线程执行这样的运算就会出现UI不响应的问题。解决这类问题的主要途径是使用多线程，启动一个后台线程，把运算操作放在这个后台线程中完成。但是原生接口的线程操作有一些难度，如果要更进一步的去完成线程间的通讯就会难上加难。
因此，.NET类库中提供了一个叫做BackgroundWorker的类可以比较优雅的解决这类问题。虽然BackgroundWorker类使用起来比较简单，但其中还是有一些需要注意的细节，下面我们就通过一个简单的Dmeo程序，来详细介绍它的主要用法。我们在Demo中计算1到100的累加和，为了演示效果，每次计算都睡眠600毫秒，Demo的界面如下：
用法概述：
在窗体上构建一个BackgroundWorker实例，在它的DoWork事件处理函数中添加耗时的运算，然后调用它的RunWorkerAsync方法就可以了。
1 private BackgroundWorker _demoBGWorker=new BackgroundWorker(); 2 3 public Form1() 4 { 5 InitializeComponent(); 6 7 } 8 9 private void BGWorker_DoWork(object sender, DoWorkEventArgs e) 10 { 11 //在这里执行耗时运算。 12 int sum = 0; 13 for(int i = 0; i < 100; i++) 14 { 15 sum += i; 16 } 17 } 18 19 20 private void btnStart_Click(object sender, EventArgs e) 21 { 22 _demoBGWorker.DoWork += BGWorker_DoWork; 23 _demoBGWorker.RunWorkerAsync(); 24 }
以上部分，暂时没有加入进度条的显示逻辑，以及其余耗时的计算，但我们可以先考虑下面几个问题：
- 如果我们要想把参数传递给运算过程怎么做？
- 在运算过程中我们希望把实时的信息显示在UI上应该怎么办？
- 如果我们想要取消正在进行的运算该怎么办？
- 如果运算过程出现异常我们又该如何处理？
接下来我们就一个一个的处理这些问题。
一、把参数传递给运算过程：
直接把100写死到运算过程中一般是不会用到的，常见的方式，都是客户指定求和的范围。因此我们在通过调用RunWorkerAsync方法启动计算过程时，这个方法可以接受一个object类型的参数，我们可以通过它把任何数据传递给计算过程：
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; } } private void btnStart_Click(object sender, EventArgs e) { _demoBGWorker.DoWork += BGWorker_DoWork; int num = int.Parse(numericUpDown1.Value.ToString()); //给滚动条赋值 this.progressBar1.Maximum = num; _demoBGWorker.RunWorkerAsync(num); }
BGWork_DoWork事件处理函数通过参数e的Argument属性传来了我们期望的运算信息。
二、把消息传递给UI
由于计算过程比较长，我们在通过进度条来显示当前进度的同时，还希望能实时的把计算的中间爱结果显示在UI上。当然，BackgroundWorker对这个用例也提供了很好的支持。它允许我们在执行计算的过程中给UI线程发送消息，下面看看具体的做法：
private void btnStart_Click(object sender, EventArgs e) { _demoBGWorker.DoWork += BGWorker_DoWork; int num = int.Parse(numericUpDown1.Value.ToString()); //给滚动条赋值 this.progressBar1.Maximum = num; _demoBGWorker.RunWorkerAsync(num); _demoBGWorker.WorkerReportsProgress = true; _demoBGWorker.ProgressChanged += BGWorker_ProgressChanged; }
首先要把WorkerReportsProgress属性设置为true，然后为ProgressChanged事件添加处理方法：
private void BGWorker_ProgressChanged(object sender,ProgressChangedEventArgs e) { //修改进度条的显示。 this.progressBar1.Value=e.ProgressPercentage; //如果有更多的信息需要传递，可以使用 e.UserState传递一个自定义的类型。 //这是一个object类型的对象，您可以通过它传递任何类型。 //我们仅把当前sum的值通过e.UserState传回，并通过显示在窗口上。 string message =e.UserState.ToString(); this.lblSum.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}"; //ReportProgress 方法把信息传递给ProcessChanged事件处理函数。 //第一个参数类型为 int,表示执行进度。 //如果有更多的信息需要传递，可以使用ReportProgress的第二个参数。 //这里我们给第二个参数传进去一条消息。 bgWorker.ReportProgress(i, message); Thread.Sleep(600); } }
现在，我们已经可以看到进度条和执行信息的更新了。
三、取消操作
在执行过程中允许用户取消当前的操作是一个基本的设计，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; }
如果检测到用户点击的取消按钮，就退出当前的计算过程，下面是点击取消按钮时要调用的代码：
private void btnCancel_Click(object sender, EventArgs e) { _demoBGWorker.CancelAsync(); }
四、异常处理
如果在计算过程中发生了异常应该怎么处理？有没有办法知道计算过程已经结束？当然要有，即便是正常的结束也需要拿到计算的结果。
private void btnStart_Click(object sender, EventArgs e) { _demoBGWorker.DoWork += BGWorker_DoWork; int num = int.Parse(numericUpDown1.Value.ToString()); //给滚动条赋值 this.progressBar1.Maximum = num; _demoBGWorker.RunWorkerAsync(num); _demoBGWorker.WorkerSupportsCancellation = true; _demoBGWorker.WorkerReportsProgress = true; _demoBGWorker.ProgressChanged += BGWorker_ProgressChanged; _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 "ArgumentNullExcepetion": 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类功能完善且使用简便，非常适合处理异步耗时的操作。
