-
C#教程之在多线程中调用winform窗体控件的实现方
本文实例讲述了在C#中实现多线程中调用winform窗体控件的方法,对于C#程序设计的学习有着很好的借鉴参考价值。具体方法如下:
首先,由于Windows窗体控件本质上不是线程安全的。因此如果有两个或多个线程适度操作某一控件的状态(set value),则可能会迫使该控件进入一种不一致的状态。还可能出现其他与线程相关的 bug,包括争用和死锁的情况。于是在调试器中运行应用程序时,如果创建某控件的线程之外的其他线程试图调用该控件,则调试器会引发一个 InvalidOperationException
本文用一个很简单的示例来讲解这个问题(在窗体上放一个TextBox和一个Button,点击Button后,在新建的线程中设置TextBox的值)
解决办法一: 关闭该异常检测的方式来避免异常的出现
经过测试发现此种方法虽然避免了异常的抛出,但是并不能保证程序运行结果的正确性 (比如多个线程同时设置TextBox1的Text时,很难预计最终TextBox1的Text是什么)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Text; using System.Windows.Forms; using System.Threading; namespace winformTest { public partial class Form1 : Form { public Form1() { InitializeComponent(); Control.CheckForIllegalCrossThreadCalls = false ; //这一行是关键 } private void button1_Click( object sender, EventArgs e) { SetTextBoxValue(); } void SetTextBoxValue() { TextBoxSetValue tbsv = new TextBoxSetValue( this .textBox1, "Method1" ); ThreadStart TS = new ThreadStart(tbsv.SetText); Thread T = new Thread(TS); T.Start(); } class TextBoxSetValue { private TextBox _TextBox ; private string _Value; public TextBoxSetValue(TextBox TxtBox, String Value) { _TextBox = TxtBox; _Value = Value; } public void SetText() { _TextBox.Text = _Value; } } } } |
解决办法二:通过委托安全调用
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Text; using System.Windows.Forms; namespace winformTest { public partial class Form2 : Form { public Form2() { InitializeComponent(); } private void button1_Click( object sender, EventArgs e) { SetTextBoxValue(); } private delegate void CallSetTextValue(); //通过委托调用 void SetTextBoxValue() { TextBoxSetValue tbsv = new TextBoxSetValue( this .textBox1, "Method2" ); if (tbsv.TextBox.InvokeRequired) { CallSetTextValue call = new CallSetTextValue(tbsv.SetText); tbsv.TextBox.Invoke(call); } else { tbsv.SetText(); } } class TextBoxSetValue { private TextBox _TextBox; private string _Value; public TextBoxSetValue(TextBox TxtBox, String Value) { _TextBox = TxtBox; _Value = Value; } public void SetText() { _TextBox.Text = _Value; } public TextBox TextBox { set { _TextBox = value; } get { return _TextBox; } } } } } |
第三解决办法:利用BackgroundWorker控件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Text; using System.Windows.Forms; using System.Threading; namespace winformTest { public partial class Form3 : Form { public Form3() { InitializeComponent(); } private void button1_Click( object sender, EventArgs e) { using (BackgroundWorker bw = new BackgroundWorker()) { bw.RunWorkerCompleted += SetTextBoxValue; bw.RunWorkerAsync(); } } void SetTextBoxValue( object sender, RunWorkerCompletedEventArgs e) { TextBoxSetValue tbsv = new TextBoxSetValue( this .textBox1, "Method3" ); tbsv.SetText(); } class TextBoxSetValue { private TextBox _TextBox; private string _Value; public TextBoxSetValue(TextBox TxtBox, String Value) { _TextBox = TxtBox; _Value = Value; } public void SetText() { _TextBox.Text = _Value; } } } } |
用户不喜欢反应慢的程序。在执行耗时较长的操作时,使用多线程是明智之举,它可以提高程序 UI 的响应速度,使得一切运行显得更为快速。在 Windows 中进行多线程编程曾经是 C++ 开发人员的专属特权,但是现在,可以使用所有兼容 Microsoft .NET 的语言来编写。
不过Windows 窗体体系结构对线程使用制定了严格的规则。如果只是编写单线程应用程序,则没必要知道这些规则,这是因为单线程的代码不可能违反这些规则。然而,一旦采用多线程,就需要理解 Windows 窗体中最重要的一条线程规则:除了极少数的例外情况,否则都不要在它的创建线程以外的线程中使用控件的任何成员。本规则的例外情况有文档说明,但这样的情况非常少。这适用于其类派生自 System.Windows.Forms.Control 的任何对象,其中几乎包括 UI 中的所有元素。所有的 UI 元素(包括表单本身)都是从 Control 类派生的对象。此外,这条规则的结果是一个被包含的控件(如,包含在一个表单中的按钮)必须与包含它控件位处于同一个线程中。也就是说,一个窗口中的所有控件属于同一个 UI 线程。实际中,大部分 Windows 窗体应用程序最终都只有一个线程,所有 UI 活动都发生在这个线程上。这个线程通常称为 UI 线程。这意味着您不能调用用户界面中任意控件上的任何方法,除非在该方法的文档说明中指出可以调用。该规则的例外情况(总有文档记录)非常少而且它们之间关系也不大。请注意,以下代码是非法的:
1
2
3
4
5
6
7
8
9
10
|
private Thread myThread; private void Form1_Load( object sender, EventArgs e) { myThread = new Thread( new ThreadStart(RunsOnWorkerThread)); myThread.Start(); } private void RunsOnWorkerThread() { label1.Text = "myThread线程调用UI控件" ; } |
如果您在 .NET Framework 1.0 版本中尝试运行这段代码,也许会侥幸运行成功,或者初看起来是如此。这就是多线程错误中的主要问题,即它们并不会立即显现出来。甚至当出现了一些错误时,在第一次演示程序之前一切看起来也都很正常。但不要搞错 — 我刚才显示的这段代码明显违反了规则,并且可以预见,任何抱希望于“试运行时良好,应该就没有问题”的人在即将到来的调试期是会付出沉重代价的。
下面我们来看看有哪些方法可以解决这一问题。
一、System.Windows.Forms.MethodInvoker 类型是一个系统定义的委托,用于调用不带参数的方法。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
private Thread myThread; private void Form1_Load( object sender, EventArgs e) { myThread = new Thread( new ThreadStart(RunsOnWorkerThread)); myThread.Start(); } private void RunsOnWorkerThread() { MethodInvoker mi = new MethodInvoker(SetControlsProp); BeginInvoke(mi); } private void SetControlsProp() { label1.Text = "myThread线程调用UI控件" ; } |
二、直接用System.EventHandle(可带参数)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
private Thread myThread; private void Form1_Load( object sender, EventArgs e) { myThread = new Thread( new ThreadStart(RunsOnWorkerThread)); myThread.Start(); } private void RunsOnWorkerThread() { //DoSomethingSlow(); string pList = "myThread线程调用UI控件" ; label1.BeginInvoke( new System.EventHandler(UpdateUI), pList); } //直接用System.EventHandler,没有必要自定义委托 private void UpdateUI( object o, System.EventArgs e) { //UI线程设置label1属性 label1.Text = o.ToString() + "成功!" ; } |
三、包装 Control.Invoke
虽然第二个方法中的代码解决了这个问题,但它相当繁琐。如果辅助线程希望在结束时提供更多的反馈信息,而不是简单地给出“Finished!”消息,则 BeginInvoke过于复杂的使用方法会令人生畏。为了传达其他消息,例如“正在处理”、“一切顺利”等等,需要设法向 UpdateUI 函数传递一个参数。可能还需要添加一个进度栏以提高反馈能力。这么多次调用 BeginInvoke 可能导致辅助线程受该代码支配。这样不仅会造成不便,而且考虑到辅助线程与 UI 的协调性,这样设计也不好。对这些进行分析之后,我们认为包装函数可以解决这两个问题。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
private Thread myThread; private void Form1_Load( object sender, EventArgs e) { myThread = new Thread( new ThreadStart(RunsOnWorkerThread)); myThread.Start(); } private void RunsOnWorkerThread() { ////DoSomethingSlow(); for ( int i = 0; i < 100; i++) { ShowProgress( Convert.ToString(i)+ "%" , i); Thread.Sleep(100); } } public void ShowProgress( string msg, int percentDone) { // Wrap the parameters in some EventArgs-derived custom class: System.EventArgs e = new MyProgressEvents(msg, percentDone); object [] pList = { this , e }; BeginInvoke( new MyProgressEventsHandler(UpdateUI), pList); } private delegate void MyProgressEventsHandler( object sender, MyProgressEvents e); private void UpdateUI( object sender, MyProgressEvents e) { lblStatus.Text = e.Msg; myProgressControl.Value = e.PercentDone; } public class MyProgressEvents : EventArgs { public string Msg; public int PercentDone; public MyProgressEvents( string msg, int per) { Msg = msg; PercentDone = per; } } |
ShowProgress 方法对将调用引向正确线程的工作进行封装。这意味着辅助线程代码不再担心需要过多关注 UI 细节,而只要定期调用 ShowProgress 即可。
如果我提供一个设计为可从任何线程调用的公共方法,则完全有可能某人会从 UI 线程调用这个方法。在这种情况下,没必要调用 BeginInvoke,因为我已经处于正确的线程中。调用 Invoke 完全是浪费时间和资源,不如直接调用适当的方法。为了避免这种情况,Control 类将公开一个称为 InvokeRequired 的属性。这是“只限 UI 线程”规则的另一个例外。它可从任何线程读取,如果调用线程是 UI 线程,则返回假,其他线程则返回真。这意味着我可以按以下方式修改包装:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
public void ShowProgress( string msg, int percentDone) { if (InvokeRequired) { // As before //... } else { // We're already on the UI thread just // call straight through. UpdateUI( this , new MyProgressEvents(msg,PercentDone)); } } |
线程打开窗体的问题:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Text; using System.Windows.Forms; namespace WindowsApplication36 { public partial class Form1 : Form { public Form1() { InitializeComponent(); } private void Form1_Load( object sender, EventArgs e) { } private void button1_Click( object sender, EventArgs e) { new System.Threading.Thread( new System.Threading.ThreadStart(invokeShow)).Start(); } public void invokeShow() { Form f1 = new Form(); this .Invoke( new System.EventHandler( this .showForm), new object [] { f1, null }); } public void showForm( object sender,EventArgs e) { Form f1 = sender as Form; f1.ShowDialog(); } } } |