C# BackgroundWorker用法详解（源码可直接使用）

在C#程序中，经常会有一些耗时较长的CPU密集型运算，如果直接在 UI 线程执行这样的运算就会出现UI不响应的问题。解决这类问题的主要途径是使用多线程，启动一个后台线程，把运算操作放在这个后台线程中完成。但是原生接口的线程操作有一些难度，如果要更进一步的去完成线程间的通信就会难上加难。

还好 .NET 类库中提供了一个叫做 BackgroundWorker 的类可以比较优雅的解决这类问题。虽然BackgroundWorker 类使用起来比较简单，但其中还是有一些需要注意的细节，下面我们就通过 demo 程序介绍它的主要用法。我们在 demo中计算1到100的累加和，为了演示，每次计算都 sleep 600毫秒，demo 的UI为：

如果我们想要把参数传递给运算过程该怎么做？

在运算过程中我们希望把实时的信息显示在UI上该怎么办？

如果我们想要取消正在进行的运算该怎么办？

如果运算过程出现异常我们又该如何处理？

接下来我们就一个一个的处理这些问题。

在概述中我们通过调用RunWorkerAsync方法启动计算过程，其实这个方法可以接受一个 object 类型的参数。通过它我们就可以把任何数据传递给计算过程：

BGWorker_DoWork事件处理函数通过参数 e 的Argument属性传来了我们期望的运算信息。

把消息传递给UI

由于计算过程比较长，我们在通过进度条来显示当前进度的同时，还希望能实时的把计算的中间结果显示在UI上。当然，BackgroundWorker对这个用例也提供了很好的支持。它允许我们在执行计算的过程中给UI线程发送消息

首先要把WorkerReportsProgress 属性设置为 true，然后为ProgressChanged 事件添加处理方法

取消操作

在执行过程中允许用户取消当前的操作是一个基本的设计，BackgroundWorker自然有很好的支持

和WorkerReportsProgress属性一样，如果要支持取消操作我们需要设置 WorkerSupportsCancellation属性为 true。并且还要在BGWorker_DoWork方法中进行支持，在 for 循环中 Thread.Sleep(600)后面添加代码

 如果检测到用户点击的取消按钮，就退出当前的计算过程。下面是点击取消按钮时要调用的代码：

异常处理

如果在计算过程中发生了异常该怎么处理？有没有办法知道计算过程已经结束？当然要有，即便是正常的结束也需要拿到计算的结果。

RunWorkerCompleted 事件处理函数会在DoWork 事件处理函数返回后被调用。通过它我们可以进行一些运算结束后的操作，比如禁用取消按钮，异常处理，结果显示等

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;
 
namespace backgroudDemo
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }
 
        private void btnBegin_Click(object sender, EventArgs e)
        {
            progressBar1.Maximum = 100;
            if (backBGWorker.IsBusy) { return; }
            backBGWorker.RunWorkerAsync(100);
 
       
        }
 
        private void dateProcess(object sender, DoWorkEventArgs e)
        {
            //在这里执行耗时的运算。
            BackgroundWorker bgWorker = sender as BackgroundWorker;
            int endNumber = 0;
            if (e.Argument != null)
            {
                endNumber = (int)e.Argument;
            }
 
 
            int sum = 0;
            string message;
            for (int i = 0; i <= endNumber; i++)
            {
                sum += i;
                 message = "当前累加: " + sum.ToString();
                bgWorker.ReportProgress(i, message);
                Thread.Sleep(600);
 
                //在操作的过程中需要检查用户是否取消了当前的操作。
                if (bgWorker.CancellationPending == true)
                {
                    e.Cancel = true;
                    break;
                }
 
 
            }
 
            e.Result = "完成计算！";
        }
 
        private BackgroundWorker backBGWorker = new BackgroundWorker();
        
        private void Form1_Load(object sender, EventArgs e)
        {
            backBGWorker.DoWork += dateProcess;//添加耗时操作
            backBGWorker.WorkerReportsProgress = true;//在执行计算的过程中给UI线程发送消息
            backBGWorker.ProgressChanged += ProcessChange;
            backBGWorker.WorkerSupportsCancellation = true;//支持取消操作
            backBGWorker.RunWorkerCompleted += processCompleted;//拿到计算的结果
        }
 
        private void processCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
            //如果用户取消了当前操作就关闭窗口。
            if (e.Cancelled)
            {
                //this.Close();
                MessageBox.Show("用户取消了计算", "结束", MessageBoxButtons.OK, MessageBoxIcon.Information);
 
                return;
            }
 
 
            //计算过程中的异常会被抓住，在这里可以进行处理。
            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.
            MessageBox.Show(e.Result.ToString(),"结束", MessageBoxButtons.OK, MessageBoxIcon.Information);
 
        }
 
        private void ProcessChange(object sender, ProgressChangedEventArgs e)
        {
            progressBar1.Value = e.ProgressPercentage;
            string message = e.UserState.ToString();
            label1.Text = message;
        }
 
        private void btnCancel_Click(object sender, EventArgs e)
        {
            if (backBGWorker.IsBusy)
            {
                backBGWorker.CancelAsync();
 
            }
        }
    }
}