在一些耗时的操作过程中,在长时间运行时可能会导致用户界面 (UI) 处于停止响应状态,用户在这操作期间无法进行其他的操作,为了不使UI层处于停止响应状态,我们倾向推荐用户使用BackgroundWorker来进行处理,这个后台的线程处理,可以很好的实现常规操作的同时,还可以及时通知UI,包括当前处理信息和进度等
BackgroundWorker 类在 System.ComponentModel 命名空间下。VS 的工具箱时有一个 BackgroundWorker 组件,就是这个类。
参考使用后台线程BackgroundWorker处理任务的总结
backgroundwork主要的事件及参数:
1.DoWork——当执行BackgroundWorker.RunWorkerAsync方法时会触发该事件,并且传递DoWorkEventArgs参数;
2.RunWorkerCompleted——异步操作完成或中途终止会触发该事件。
3.ProgressChanged——操作处理中获得的处理状态变化,通过BackgroundWorker.ReportProgress(int)方法触发该事件,并且传递ProgressChangedEventArgs,其中包含了处理的百分比,这个参数在UI界面上设置progressbar控件。
backgroundwork主要的方法:
- 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该方法才可用)。
BackgroundWorker组件
重要属性:
1、CancellationPending 获取一个值,指示应用程序是否已请求取消后台操作。通过在DoWork事件中判断CancellationPending属性可以认定是否需要取消后台操作(也就是结束线程);
2、 WorkerReportsProgress :获取或设置一个值,该值指示BackgroundWorker能否报告进度更新
重要方法:
1、CancelAsync 请求取消挂起的后台操作
2、RunWorkerAsync 开始执行后台操作
3、ReportProgress 引发ProgressChanged事件
重要事件:
1、DoWork 调用 RunWorkerAsync 时发生
2、ProgressChanged 调用 ReportProgress 时发生
3、RunWorkerCompleted 当后台操作已完成、被取消或引发异常时发生另外还有三个重要的参数RunWorkerCompletedEventArgs以及DoWorkEventArgs、ProgressChangedEventArgs。
DEMO:
结果图:
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
namespace backGWdemo
{
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
this.backgroundWorker1.DoWork += backgroundWorker1_DoWork;
this.backgroundWorker1.ProgressChanged += backgroundWorker1_ProgressChanged;
this.backgroundWorker1.RunWorkerCompleted += new RunWorkerCompletedEventHandler(this.backgroundWorker1_RunWorkerCompleted);
}
/*-----------按钮触发的事件----------*/
private void button1_Click(object sender, EventArgs e)
{
//调用RunWorkerAsync()方法,会触发DoWork事件
this.backgroundWorker1.RunWorkerAsync();
}
/*-------定义backgroundWork事件-------*/
/// <summary>
/// 这里就是通过响应消息,来处理界面的显示工作(当调用ReportProgress方法时发生)
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void backgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
this.progressBar1.Value = e.ProgressPercentage;
this.label1.Text = e.UserState.ToString();
this.label1.Update();
}
/// <summary>
/// 这里是后台工作完成后的消息处理(异步操作完成或中途终止会触发该事件)
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
MessageBox.Show("运算完成了!");
}
/// <summary>
/// 后台进程开始工作的地方(当执行BackgroundWorker.RunWorkerAsync方法时会触发该事件,
/// 并且传递DoWorkEventArgs参数;)
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
{
work(this.backgroundWorker1); //调用处理函数(也可以直接将处理过程写在这个事件中)
}
/*处理函数*/
/// <summary>
/// 处理函数
/// </summary>
/// <param name="bk">backgroundwork对象</param>
/// <returns></returns>
private bool work(BackgroundWorker bk)
{
for (int i = 0; i < 100; i++)
{
//这里判断一下是否用户要求取消后台进行,并可以尽早退出。
//可以通过调用CancelAsync方法设置CancellationPending的值为false
if (bk.CancellationPending)
{
bk.ReportProgress(i, String.Format("{0}%,操作被用户申请中断", i));
return false;
}
//调用 ReportProgress 方法,会触发ProgressChanged事件
bk.ReportProgress(i, String.Format("{0}%", i));
System.Threading.Thread.Sleep(1000);
}
return true;
}
}
}
注意:如果报这种错误
是因为没有设置BackgroundWorker.WorkerReportsProgress属性为true。
上面那个参考链接里面DoWork事件处理封装了细节,如下。
void worker_DoWork(object sender, DoWorkEventArgs e)
{
CollectStateInfo info = e.Argument as CollectStateInfo;
if (info != null)
{
LinkJob job = new LinkJob();
var stateInfo = job.Execute(this.worker, info);
e.Result = stateInfo;
}
}
根据上面的讲解,job.Execute内完成了长时间的循环处理,每次循环都调用了ReportProgress(),然后触发worker_ProgressChanged()这个处理函数进行进度条的刷新。