C# BackgroundWorker 控件使用分享
BackgroundWorker是一个非常不错的线程控件,能避免界面假死,让线程操作你想要做的事,它学习起来很简单,但是能实现很强大的功能。发布这篇文章的目的是将最近学习到的共享出来,大家交流一下,当然我也是菜鸟,在这里你将学习到BackgroundWorker简单使用,停止,暂停,继续等操作,BackgroundWorker比起Thread和ThreadPool要简单太多,为了更方便在实际应用中使用,我使用的是winform,没有使用控制台程序。 在UI界面里拖动一个button和richTextBox到界面。
我会从最简单的开始,只有最简单的代码才会让人有继续学下去的欲望,下列代码可以将1到999打印到richTextBox1控件上。 复制代码 代码如下:
private void button1_Click(object sender, EventArgs e) {
//创建一个BackgroundWorker线程
BackgroundWorker bw = new BackgroundWorker();
//创建一个DoWork事件,指定bw_DoWork方法去做事 bw.DoWork += new DoWorkEventHandler(bw_DoWork); //开始执行
bw.RunWorkerAsync(); }
void bw_DoWork(object sender, DoWorkEventArgs e) {
for (int i = 0; i < 1000; i++) {
this.richTextBox1.Text += i + Environment.NewLine; } }
但是很不幸,以上代码会报错,报错信息:线程间操作无效: 从不是创建控件“richTextBox1”的线程访问它。
那么我们继续改造代码,让数字显示在richTextBox1控件上,并且让richTextBox1焦点处于最低端。
复制代码 代码如下:
private void button1_Click(object sender, EventArgs e) {
//创建一个BackgroundWorker线程
BackgroundWorker bw = new BackgroundWorker();
//创建一个DoWork事件,指定bw_DoWork方法去做事 bw.DoWork += new DoWorkEventHandler(bw_DoWork); //开始执行
bw.RunWorkerAsync(); }
void bw_DoWork(object sender, DoWorkEventArgs e) {
for (int i = 0; i < 1000; i++) {
this.Invoke((MethodInvoker)delegate {
this.richTextBox1.Text += i + Environment.NewLine; }); } }
private void richTextBox1_TextChanged(object sender, EventArgs e) {
RichTextBox textbox = (RichTextBox)sender;
textbox.SelectionStart = textbox.Text.Length; textbox.ScrollToCaret(); }
上面是BackgroundWorker一个最简单的例子,没有多余复杂的代码,这就是BackgroundWorker,下面我们加入停止按钮,让线程停下来。
再拖动一个button控件到界面,让线程停止我们先要改造一下代码,让button事件也能控制到BackgroundWorker线程。 复制代码 代码如下:
BackgroundWorker bw = null;
private void button1_Click(object sender, EventArgs e) {
//创建一个BackgroundWorker线程 bw = new BackgroundWorker(); //指定可以让线程停止
bw.WorkerSupportsCancellation = true;
//创建一个DoWork事件,指定bw_DoWork方法去做事 bw.DoWork += new DoWorkEventHandler(bw_DoWork); //开始执行
bw.RunWorkerAsync(); }
private void button2_Click(object sender, EventArgs e) {
//停止线程
bw.CancelAsync(); }
void bw_DoWork(object sender, DoWorkEventArgs e) {
for (int i = 0; i < 1000; i++) {
//获取当前线程是否得到停止的指令 if (bw.CancellationPending) {
e.Cancel = true; return; }
this.Invoke((MethodInvoker)delegate {
this.richTextBox1.Text += i + Environment.NewLine; }); } }
为了避免代码的复杂化,上面代码我没有做更多的体验修改,比如点击开始的按钮,开始的按钮应该为不可用状态,点击停止按钮后停止按钮不可用状态,激活开始按钮。 下面我们将继续升级,如何来获知线程是否已经执行完成或者线程已经停止了呢 复制代码 代码如下:
BackgroundWorker bw = null;
private void button1_Click(object sender, EventArgs e) {
bw = new BackgroundWorker();
bw.WorkerSupportsCancellation = true;
bw.DoWork += new DoWorkEventHandler(bw_DoWork); //线程完成或者停止发生的事件 bw.RunWorkerCompleted += new RunWorkerCompletedEventHandler(bw_RunWorkerCompleted);
bw.RunWorkerAsync(); }
private void button2_Click(object sender, EventArgs e) {
bw.CancelAsync(); }
void bw_DoWork(object sender, DoWorkEventArgs e) {
for (int i = 0; i < 1000; i++)
{
if (bw.CancellationPending) {
e.Cancel = true; return; }
this.Invoke((MethodInvoker)delegate {
this.richTextBox1.Text += i + Environment.NewLine; }); } }
void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e) {
if (e.Cancelled) {
this.richTextBox1.Text += \线程已经停止\ } else {
this.richTextBox1.Text += \线程已经完成\ } }
到现在为止你可以自己去用BackgroundWorker创建一个线程了,你已经了解它了,当然BackgroundWorker还有一个ReportProgress滚动条事件,可以显示进度,我暂且认为它是多余的,因为大部分进度都可以通过bw_DoWork来控制实现。下面我们继续完善BackgroundWorker,加入暂停和继续功能。 再拖动一个button控件到界面,BackgroundWorker的暂停和继续我们使用ManualResetEvent。 复制代码 代码如下:
BackgroundWorker bw = null; //创建ManualResetEvent
ManualResetEvent mr = new ManualResetEvent(true);
private void button1_Click(object sender, EventArgs e) {
bw = new BackgroundWorker();
bw.WorkerSupportsCancellation = true;
bw.DoWork += new DoWorkEventHandler(bw_DoWork); bw.RunWorkerCompleted += new RunWorkerCompletedEventHandler(bw_RunWorkerCompleted);
bw.RunWorkerAsync(); }
private void button2_Click(object sender, EventArgs e) {
bw.CancelAsync(); }
private void button3_Click(object sender, EventArgs e) {
Button b = (Button)sender; if (b.Text == \暂停\ {
mr.Reset();
b.Text = \继续\ } else {
mr.Set();
b.Text = \暂停\ } }
void bw_DoWork(object sender, DoWorkEventArgs e) {
for (int i = 0; i < 1000; i++) {
if (bw.CancellationPending) {
e.Cancel = true; return; }
this.Invoke((MethodInvoker)delegate {
this.richTextBox1.Text += i + Environment.NewLine; });
//接受指令 mr.WaitOne(); } }