在WinForm程序中,有时会由于加载大量数据致使UI界面假死,这种状况对于用户来讲是很是不友好的。所以,在加载大量数据的状况下,首先应该将数据加载放在另外一线程中进行,这样保证了UI界面的响应;其次能够提供一个进度条使用户明白程序正在加载数据,同时清楚知道目前加载的进度。html
实现上述功能的一个简单的方式是利用 System.ComponentModel 中的工具类:BackgroundWorker,它支持取消,进度报告,异常转发,而且实现了 IComponent 接口,意味着能够直接在VS设计器中从工具箱中拖到界面上使用。工具
下面以一个例子来讲明如何使用 BackgroundWorker,更详细的 BackgroundWorker 说明能够参考Threading in C#(或者 中文翻译):post
1. UI界面添加一个进度条,一个开始按钮,一个结束按钮,以及BackgroundWorker,并设置下列 BackgroundWorker 属性(例子中设置了其Name为bw):this
- WorkerReportsProcess:默认为False,将其设置为True,支持进度报告
- WorkerSupportsCancellation:默认为False,将其设置为True,支持取消
2. DoWork事件,在其中执行咱们的数据加载,咱们执行一个循环来模拟数据加载spa
private void bw_DoWork(object sender, DoWorkEventArgs e) { var count = (int)e.Argument; for (int i = 1; i <= count; i++) { if (bw.CancellationPending) { e.Cancel = true; return; } bw.ReportProgress(i); Thread.Sleep(200); // 模拟耗时的任务 } }
- 注意:在这个方法中不能进行UI控件的更新。
- 经过检查 CancellationPending 来判断用户是否进行了取消
- 经过调用 ReportProgress 来报告进度
3. ProgressChanged 事件,在这里能够操做进度条,以及其余UI控件。线程
private void bw_ProgressChanged(object sender, ProgressChangedEventArgs e) { progressBar.Value = e.ProgressPercentage; resultTextBox.Text += DateTime.Now + "\r\n"; }
经过e.ProgressPercentage来获取任务执行过程当中设置的进度,以此来更新进度条。翻译
4. RunWorkerCompleted 事件,在这里能够更新UI,以及进行异常处理。设计
private void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e) { if (e.Cancelled) resultTextBox.Text += "任务取消。" + "\r\n"; else if (e.Error != null) resultTextBox.Text += "出现异常: " + e.Error + "\r\n"; else resultTextBox.Text += "任务完成。 " + "\r\n"; }
当执行过程当中出现异常时,异常会被转发到这里,所以能够在这里处理异常。code
5. 经过一个开始按钮调和一个取消按钮来控制:orm
- bw.RunWorkerAsync() 启动
- bw.CancelAsync() 取消
下边是完整的代码及输出:
public partial class Form1 : Form { public Form1() { InitializeComponent(); bw.DoWork += bw_DoWork; bw.ProgressChanged += bw_ProgressChanged; bw.RunWorkerCompleted += bw_RunWorkerCompleted; } private void startButton_Click(object sender, EventArgs e) { progressBar.Value = 0; progressBar.Maximum = 10; resultTextBox.Text = "任务开始..." + "\r\n"; bw.RunWorkerAsync(10); } private void bw_DoWork(object sender, DoWorkEventArgs e) { var count = (int)e.Argument; for (int i = 1; i <= count; i++) { if (bw.CancellationPending) { e.Cancel = true; return; } if (i == 2) throw new Exception("出错啦!"); bw.ReportProgress(i); Thread.Sleep(200); } } private void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e) { if (e.Cancelled) resultTextBox.Text += "任务取消。" + "\r\n"; else if (e.Error != null) resultTextBox.Text += "出现异常: " + e.Error + "\r\n"; else resultTextBox.Text += "任务完成。 " + "\r\n"; } private void bw_ProgressChanged(object sender, ProgressChangedEventArgs e) { progressBar.Value = e.ProgressPercentage; resultTextBox.Text += DateTime.Now + "\r\n"; } private void cancelbutton_Click(object sender, EventArgs e) { bw.CancelAsync(); } }
输出以下:
参考:Threading in C# --> 中文翻译