C#中BackgroundWorker的使用

介绍

BackgroundWorker 类允许您在单独的专用线程上运行操作，在界面上报告进度，接受界面的控制信号，返回运算结果。BackgroundWorker 的DoWork代码运行在非UI线程之上，BackgroundWorker 不跨 AppDomain 边界进行封送处理。
BackgroundWorker 是基于事件的异步编程模式EAP的复杂实现。

初始化BackgroundWorker

主要需要对BackgroundWorker绑定以下三个事件：

• 开始工作的事件:DoWork——非UI线程执行，不可操作界面控件对象
• 完成工作的事件:RunWorkerCompleted——UI线程执行
• 工作中刷新的事件:ProgressChanged——UI线程执行

BackgroundWorker backgroundWorker1 = null;
private void  backgroundWorker1_Init() 
{   
    backgroundWorker1 = new BackgroundWorker();
    backgroundWorker1.WorkerReportsProgress = true;//能否报告进度更新。
    backgroundWorker1.WorkerSupportsCancellation = true;//是否支持异步取消
    //绑定事件
    backgroundWorker1.DoWork += new DoWorkEventHandler(backgroundWorker1_DoWork);
    backgroundWorker1.ProgressChanged += new ProgressChangedEventHandler(backgroundWorker1_ProgressChanged);
    backgroundWorker1.RunWorkerCompleted += new RunWorkerCompletedEventHandler(backgroundWorker1_RunWorkerCompleted);
}

启动BackgroundWorker

//开始按钮
private void backgroundWorker1_Start(string fullPath)
{
    if (backgroundWorker1.IsBusy != true)//判断BackgroundWorker 是否正在运行异步操作。
    {
        backgroundWorker1.RunWorkerAsync("object argument");//启动异步操作，有两种重载（有参和无参）,将触发BackgroundWorker.DoWork事件
    }
}

object argument是要传给DoWork()的DoWorkEventArgs的Argument参数。

DoWork开始事件

在这个动作事件中需要进行两件事：第一，还原出worker；第二，调用DoSomething函数开始工作。代码参考如下：

private void backgroundWorker1_DoWork(object sender, System.ComponentModel.DoWorkEventArgs e)
{    
    //句柄sender指向的就是该BackgroundWorker。
 
    //e.Argument 获取异步操作参数的值  
    //e.Cancel 是否应该取消事件
    //e.Result  获取或设置异步操作结果的值(在RunWorkerCompleted事件可能会使用到)
    object a = e.Argument;//获取RunWorkerAsync(object argument)传入的值
    BackgroundWorker worker = sender as BackgroundWorker;
    
    //如果任务太复杂可以封装到DoSomething()
    //DoSomething(worker, e); 
          
    for (int i = 1; i <= 10; i++)
    {
        if (worker.CancellationPending == true)//在耗时操作中判断CancellationPending属性，如果为false则退出
        {
            e.Cancel = true;
            break;
        }
        else
        {
            // Perform a time consuming operation and report progress.
            System.Threading.Thread.Sleep(500);
            worker.ReportProgress(i * 10, "Object userState");// 将触发BackgroundWorker.ProgressChanged事件，向ProgressChanged报告进度
        }
    }
    e.Result = "结束";
}

//该函数需要有两个用于BackgroundWorker控制的参数传入，其中worker参数用于还原BackgroundWorker对象，而e参数可以指示动作完成的事件是如何被触发的（用户取消or动作完成）。
private void DoSomething(BackgroundWorker worker, DoWorkEventArgs e)

RunWorkerCompleted完成事件

当DoWork事件处理完成之后，将会触发该事件处理工作结果。事件可根据传入的参数e来区分工作是中止或完成，以此来进行不同的“收尾”工作。代码参考如下：

private void backgroundWorker1_RunWorkerCompleted(object sender, System.ComponentModel.RunWorkerCompletedEventArgs e)
{
    //e.Cancelled指示异步操作是否已被取消
    //e.Error 指示异步操作期间发生的错误
    //e.Result 获取异步操作结果的值,即DoWork事件中，Result设置的值。    
  
    //判断是否用户手动取消，若程序要支持此处功能，需要程序中有cancel的动作，并在该动作中将e.cancel置为true
    if (e.Cancelled == true)
    {
        //添加用户手动取消的动作，并在标签控件中进行提示        
        resultLabel.Text = "Canceled!";
    }
     //判断是否由错误造成意外中止
    else if (e.Error != null)
    {
        //若发生错误，在标签控件中显示错误信息
        resultLabel.Text = "Error: " + e.Error.Message;
    }
    //判断是否正常结束
    else
    {
         //添加正常结束之后的收尾动作，并在标签控件中进行提示
        resultLabel.Text = e.Result.ToString();
    }
}

ProgressChanged刷新事件

在界面的控件中更新进度条的进度，此处也可以加入用户在过程中需要实时刷新的内容。代码示例如下：

private void backgroundWorker1_ProgressChanged(object sender, System.ComponentModel.ProgressChangedEventArgs e)
{
    //e.ProgressPercentage  获取异步操作进度的百分比
    resultLabel.Text = (e.ProgressPercentage.ToString() + "%");
    string state = (string)e.UserState;//接收ReportProgress方法传递过来的userState
}

取消BackgroundWorker

取消BackgroundWorker 需要在DoWork中循环检查BackgroundWorker.CancellationPending是否为true。

//终止
private void  backgroundWorker1_End()
{
    if (backgroundWorker1.WorkerSupportsCancellation == true)
    {
        // Cancel the asynchronous operation.
        backgroundWorker1.CancelAsync(); //请求取消挂起的后台操作。调用该方法将使BackgroundWorker.CancellationPending属性设置为True。 
    }
}
 

待处理问题

现在我每次启动BackgroundWorker 前都会实例一个BackgroundWorker（先Init()再Start()），没有测试BackgroundWorker 能否结束后不重新实例就二次启动，以后补上测试结果。