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();
}
}
void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
if (e.Cancelled)
{
this.richTextBox1.Text += "线程已经停止";
}
else
{
this.richTextBox1.Text += "线程已经完成";
}
}
到目前为止BackgroundWorker的大部分功能都实现了，上面的代码在很多博客中都能找到，都是只执行了一个后台线程。如果我们有1千个耗时的任务，那么一个线程远远不够，我们需要创建多条线程，让他分段执行，比如创建10个线程，把1千个任务分成不同的等分让10个线程分别去执行。
我们使用list泛型 List<BackgroundWorker>，然后使用bw.RunWorkerAsync(i) 传递参数到bw_DoWork里，在bw_DoWork里使用e.Argument接受参数。
List<BackgroundWorker> bws = new List<BackgroundWorker>();
int t = 10;
private void button1_Click(object sender, EventArgs e)
{
for (int i = 0; i < t; i++)
{
BackgroundWorker bw = new BackgroundWorker();
bw.DoWork += new DoWorkEventHandler(bw_DoWork);
bws.Add(bw);
bw.RunWorkerAsync(i);
}
}
void bw_DoWork(object sender, DoWorkEventArgs e)
{
int j = Convert.ToInt32(e.Argument);
for (int i = j; i < 1000; i = i + t)
{
if (((BackgroundWorker)sender).CancellationPending)
{
e.Cancel = true;
return;
}
string item = String.Format("线程{0}正在操作数据{1}", j + 1, i);
this.Invoke((MethodInvoker)delegate
{
this.richTextBox1.Text += item + Environment.NewLine;
});
//Thread.Sleep(200);
}
}
由于上面代码不是耗时操作，又开启线程10个，操作过快，造成界面假死状态，可以使用Sleep让线程休眠。
我们继续完善代码，加入停止操作，加入完成后和停止的事件，由于是多线程，判断是线程操作是否完成，我们用bws.Remove(sender as BackgroundWorker); 方法删除线程，然后使用bws.Count == 0来判断是否操作完成。
List<BackgroundWorker> bws = new List<BackgroundWorker>();
int t = 10;
private void button1_Click(object sender, EventArgs e)
{
for (int i = 0; i < t; i++)
{
BackgroundWorker bw = new BackgroundWorker();
bw.DoWork += new DoWorkEventHandler(bw_DoWork);
bw.WorkerSupportsCancellation = true;
bw.RunWorkerCompleted += new RunWorkerCompletedEventHandler(bw_RunWorkerCompleted);
bws.Add(bw);
bw.RunWorkerAsync(i);
}
}
private void button2_Click(object sender, EventArgs e)
{
for (int i = 0; i < t; i++)
{
bws[i].CancelAsync();
}
}
void bw_DoWork(object sender, DoWorkEventArgs e)
{
int j = Convert.ToInt32(e.Argument);
for (int i = j; i < 1000; i = i + t)
{
if (((BackgroundWorker)sender).CancellationPending)
{
e.Cancel = true;
return;
}
string item = String.Format("线程{0}正在操作数据{1}", j + 1, i);
this.Invoke((MethodInvoker)delegate
{
this.richTextBox1.Text += item + Environment.NewLine;
});
Thread.Sleep(200);
}
}
void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
bws.Remove(sender as BackgroundWorker);
if (bws.Count == 0)
{
if (e.Cancelled)
{
this.richTextBox1.Text += "线程已经停止";
}
else
{
this.richTextBox1.Text += "线程已经完成";
}
}
}
上面代码中的停止不是能立即停止，这个就和开车一样，开的越快，刹车的后拖行的距离越长，同理，开启的线程的越多，完全暂停需要的时间越长，不知我说的是否正确。另外我也想问一下是否能真正的全部线程停止，点停止后全部线程立即停止。
下面我们继续加入暂停和继续的功能，一样的道理，我们使用List<ManualResetEvent>。
List<BackgroundWorker> bws = new List<BackgroundWorker>();
List<ManualResetEvent> mrs = new List<ManualResetEvent>();
int t = 10;
private void button1_Click(object sender, EventArgs e)
{
for (int i = 0; i < t; i++)
{
BackgroundWorker bw = new BackgroundWorker();
bw.DoWork += new DoWorkEventHandler(bw_DoWork);
bw.WorkerSupportsCancellation = true;
bw.RunWorkerCompleted += new RunWorkerCompletedEventHandler(bw_RunWorkerCompleted);
bws.Add(bw);
bw.RunWorkerAsync(i);
mrs.Add(new ManualResetEvent(true));
}
}
private void button2_Click(object sender, EventArgs e)
{
for (int i = 0; i < t; i++)
{
bws[i].CancelAsync();
}
}
private void button3_Click(object sender, EventArgs e)
{
Button b = (Button)sender;
if (b.Text == "暂停")
{
for (int i = 0; i < mrs.Count; i++)
{
mrs[i].Reset();
}
b.Text = "继续";
}
else
{
for (int i = 0; i < mrs.Count; i++)
{
mrs[i].Set();
}
b.Text = "暂停";
}
}
void bw_DoWork(object sender, DoWorkEventArgs e)
{
int j = Convert.ToInt32(e.Argument);
for (int i = j; i < 1000; i = i + t)
{
if (((BackgroundWorker)sender).CancellationPending)
{
e.Cancel = true;
return;
}
string item = String.Format("线程{0}正在操作数据{1}", j + 1, i);
this.Invoke((MethodInvoker)delegate
{
this.richTextBox1.Text += item + Environment.NewLine;
});
Thread.Sleep(200);
mrs[j].WaitOne();
}
}
void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
bws.Remove(sender as BackgroundWorker);
if (bws.Count == 0)
{
if (e.Cancelled)
{
this.richTextBox1.Text += "线程已经停止";
}
else
{
this.richTextBox1.Text += "线程已经完成";
}
}
}
至此，所有的代码都奉上了，多个线程操作会带来很多意向不到的麻烦，比如多个线程同时把数据写入一个文件，多线程更新datatable等，会让软件莫名其妙的自动退出，.net2.0里还没有绝对线程安全的数据集，很多大佬都说用lock，但我对lock也是一知半解，还请大家赐教赐教，如上有什么说的不对，也请大家多多指点。