如何：对 Windows 窗体控件进行线程安全调用

如果使用多线程来提高 Windows 窗体应用程序的性能，则必须确保以线程安全方式调用控件。

访问 Windows 窗体控件本质上不是线程安全的。
如果有两个或多个线程操作某一控件的状态，则可能会迫使该控件进入一种不一致的状态。 还可能会出现其他与线程相关的 Bug，例如争用情况和死锁。
确保以线程安全方式访问控件非常重要。

在未使用 Invoke 方法的情况下，从不是创建某个控件的线程的其他线程调用该控件是不安全的。
以下非线程安全的调用的示例。

// This event handler creates a thread that calls a
// Windows Forms control in an unsafe way.
private void setTextUnsafeBtn_Click(
object sender,
EventArgs e)
{
this.demoThread =
new Thread(new ThreadStart(this.ThreadProcUnsafe));

this.demoThread.Start();
}

// This method is executed on the worker thread and makes
// an unsafe call on the TextBox control.
private void ThreadProcUnsafe()
{
this.textBox1.Text = "This text was set unsafely.";
}

 

.NET Framework 可帮助您检测以非线程安全方式访问控件这一问题。
在调试器中运行应用程序时，如果一个不是创建某个控件的线程的其他线程调用该控件，则调试器会引发一个 InvalidOperationException，并显示以下消息：“从不是创建控件控件名称
的线程访问它。”

此异常在调试期间和运行时的某些情况下可靠地发生。
在调试以 .NET Framework 2.0 版之前的 .NET Framework 编写的应用程序时，可能会出现此异常。
我们强烈建议您在发现此问题时进行修复，但您可以通过将 CheckForIllegalCrossThreadCalls 属性设置为
false 来禁用它。
这会使控件像在 Visual Studio .NET 2003 和 .NET Framework 1.1 中一样运行。

 

注意
如果在窗体上使用 ActiveX 控件，则在调试器中运行时可能会收到跨线程的 InvalidOperationException。 发生这种情况时，ActiveX 控件不支持多线程处理。 有关使用 Windows 窗体的 ActiveX 控件的更多信息，请参见 Windows 窗体和非托管应用程序。 如果您使用的是 Visual Studio，则可以通过禁用 Visual Studio 承载进程来阻止此异常。

对 Windows 窗体控件进行线程安全调用

对 Windows 窗体控件进行线程安全调用

查询控件的 InvokeRequired 属性。

如果 InvokeRequired 返回
true，则使用实际调用控件的委托来调用
Invoke。

如果 InvokeRequired 返回
false，则直接调用控件。

在下面的代码示例中，将在由后台线程执行的 ThreadProcSafe 方法中实现线程安全调用。
如果 TextBox 控件的
InvokeRequired 返回
true，则
ThreadProcSafe 方法会创建
SetTextCallback 的一个实例，并将该实例传递给窗体的
Invoke 方法。
这使得 SetText 方法被创建
TextBox 控件的线程调用，而且在此线程上下文中将直接设置
Text 属性。

 

// This event handler creates a thread that calls a
// Windows Forms control in a thread-safe way.
private void setTextSafeBtn_Click(
object sender,
EventArgs e)
{
this.demoThread =
new Thread(new ThreadStart(this.ThreadProcSafe));

this.demoThread.Start();
}

// This method is executed on the worker thread and makes
// a thread-safe call on the TextBox control.
private void ThreadProcSafe()
{
this.SetText("This text was set safely.");
}

// This method demonstrates a pattern for making thread-safe
// calls on a Windows Forms control.
//
// If the calling thread is different from the thread that
// created the TextBox control, this method creates a
// SetTextCallback and calls itself asynchronously using the
// Invoke method.
//
// If the calling thread is the same as the thread that created
// the TextBox control, the Text property is set directly.

private void SetText(string text)
{
// InvokeRequired required compares the thread ID of the
// calling thread to the thread ID of the creating thread.
// If these threads are different, it returns true.
if (this.textBox1.InvokeRequired)
{
SetTextCallback d = new SetTextCallback(SetText);
this.Invoke(d, new object[] { text });
}
else
{
this.textBox1.Text = text;
}
}

使用 BackgroundWorker 进行线程安全调用

在应用程序中实现多线程的首选方式是使用 BackgroundWorker 组件。
BackgroundWorker
组件使用事件驱动模型实现多线程。 后台线程运行 DoWork 事件处理程序，而创建控件的线程运行
ProgressChanged 和
RunWorkerCompleted 事件处理程序。
可以从 ProgressChanged 和
RunWorkerCompleted 事件处理程序调用控件。

使用 BackgroundWorker 进行线程安全调用

创建一个方法，该方法用于执行您希望在后台线程中完成的工作。
不要调用由此方法中的主线程创建的控件。

创建一个方法，用于在后台工作完成后报告结果。
可以调用由此方法中的主线程创建的控件。

将步骤 1 中创建的方法绑定到 BackgroundWorker 的实例的
DoWork 事件，并将步骤 2 中创建的方法绑定到同一实例的
RunWorkerCompleted 事件。

若要启动后台线程，请调用 BackgroundWorker 实例的
RunWorkerAsync 方法。

在下面的代码示例中，DoWork 事件处理程序使用
Sleep 来模拟需要花费一些时间完成的工作。
它不调用窗体的 TextBox 控件。
TextBox
控件的 Text 属性在
RunWorkerCompleted 事件处理程序中直接设置。

// This BackgroundWorker is used to demonstrate the
// preferred way of performing asynchronous operations.
private BackgroundWorker backgroundWorker1;

 

// This event handler starts the form's
// BackgroundWorker by calling RunWorkerAsync.
//
// The Text property of the TextBox control is set
// when the BackgroundWorker raises the RunWorkerCompleted
// event.
private void setTextBackgroundWorkerBtn_Click(
object sender,
EventArgs e)
{
this.backgroundWorker1.RunWorkerAsync();
}

// This event handler sets the Text property of the TextBox
// control. It is called on the thread that created the
// TextBox control, so the call is thread-safe.
//
// BackgroundWorker is the preferred way to perform asynchronous
// operations.

private void backgroundWorker1_RunWorkerCompleted(
object sender,
RunWorkerCompletedEventArgs e)
{
this.textBox1.Text =
"This text was set safely by BackgroundWorker.";
}

 

也可以使用 ProgressChanged 事件来报告后台任务的进度。
有关包含该事件的示例，请参见 BackgroundWorker。

示例

下面的代码示例是一个完整的 Windows 窗体应用程序，它包含一个带有三个按钮和一个文本框的窗体。
第一个按钮演示不安全的跨线程访问，第二个按钮演示使用 Invoke 实现的安全访问，而第三个按钮演示使用
BackgroundWorker 实现的安全访问。

注意
有关如何运行示例的说明，请参见如何：使用 Visual Studio 编译和运行完整的 Windows 窗体代码示例。 此示例需要引用 System.Drawing 和 System.Windows.Forms 程序集。

using System;
using System.ComponentModel;
using System.Threading;
using System.Windows.Forms;

namespace CrossThreadDemo
{
public class Form1 : Form
{
// This delegate enables asynchronous calls for setting
// the text property on a TextBox control.
delegate void SetTextCallback(string text);

// This thread is used to demonstrate both thread-safe and
// unsafe ways to call a Windows Forms control.
private Thread demoThread = null;

// This BackgroundWorker is used to demonstrate the
// preferred way of performing asynchronous operations.
private BackgroundWorker backgroundWorker1;

private TextBox textBox1;
private Button setTextUnsafeBtn;
private Button setTextSafeBtn;
private Button setTextBackgroundWorkerBtn;

private System.ComponentModel.IContainer components = null;

public Form1()
{
InitializeComponent();
}

protected override void Dispose(bool disposing)
{
if (disposing && (components != null))
{
components.Dispose();
}
base.Dispose(disposing);
}

// This event handler creates a thread that calls a
// Windows Forms control in an unsafe way.
private void setTextUnsafeBtn_Click(
object sender,
EventArgs e)
{
this.demoThread =
new Thread(new ThreadStart(this.ThreadProcUnsafe));

this.demoThread.Start();
}

// This method is executed on the worker thread and makes
// an unsafe call on the TextBox control.
private void ThreadProcUnsafe()
{
this.textBox1.Text = "This text was set unsafely.";
}

// This event handler creates a thread that calls a
// Windows Forms control in a thread-safe way.
private void setTextSafeBtn_Click(
object sender,
EventArgs e)
{
this.demoThread =
new Thread(new ThreadStart(this.ThreadProcSafe));

this.demoThread.Start();
}

// This method is executed on the worker thread and makes
// a thread-safe call on the TextBox control.
private void ThreadProcSafe()
{
this.SetText("This text was set safely.");
}

// This method demonstrates a pattern for making thread-safe
// calls on a Windows Forms control.
//
// If the calling thread is different from the thread that
// created the TextBox control, this method creates a
// SetTextCallback and calls itself asynchronously using the
// Invoke method.
//
// If the calling thread is the same as the thread that created
// the TextBox control, the Text property is set directly.

private void SetText(string text)
{
// InvokeRequired required compares the thread ID of the
// calling thread to the thread ID of the creating thread.
// If these threads are different, it returns true.
if (this.textBox1.InvokeRequired)
{
SetTextCallback d = new SetTextCallback(SetText);
this.Invoke(d, new object[] { text });
}
else
{
this.textBox1.Text = text;
}
}

// This event handler starts the form's
// BackgroundWorker by calling RunWorkerAsync.
//
// The Text property of the TextBox control is set
// when the BackgroundWorker raises the RunWorkerCompleted
// event.
private void setTextBackgroundWorkerBtn_Click(
object sender,
EventArgs e)
{
this.backgroundWorker1.RunWorkerAsync();
}

// This event handler sets the Text property of the TextBox
// control. It is called on the thread that created the
// TextBox control, so the call is thread-safe.
//
// BackgroundWorker is the preferred way to perform asynchronous
// operations.

private void backgroundWorker1_RunWorkerCompleted(
object sender,
RunWorkerCompletedEventArgs e)
{
this.textBox1.Text =
"This text was set safely by BackgroundWorker.";
}

#region Windows Form Designer generated code

private void InitializeComponent()
{
this.textBox1 = new System.Windows.Forms.TextBox();
this.setTextUnsafeBtn = new System.Windows.Forms.Button();
this.setTextSafeBtn = new System.Windows.Forms.Button();
this.setTextBackgroundWorkerBtn = new System.Windows.Forms.Button();
this.backgroundWorker1 = new System.ComponentModel.BackgroundWorker();
this.SuspendLayout();
//
// textBox1
//
this.textBox1.Location = new System.Drawing.Point(12, 12);
this.textBox1.Name = "textBox1";
this.textBox1.Size = new System.Drawing.Size(240, 20);
this.textBox1.TabIndex = 0;
//
// setTextUnsafeBtn
//
this.setTextUnsafeBtn.Location = new System.Drawing.Point(15, 55);
this.setTextUnsafeBtn.Name = "setTextUnsafeBtn";
this.setTextUnsafeBtn.TabIndex = 1;
this.setTextUnsafeBtn.Text = "Unsafe Call";
this.setTextUnsafeBtn.Click += new System.EventHandler(this.setTextUnsafeBtn_Click);
//
// setTextSafeBtn
//
this.setTextSafeBtn.Location = new System.Drawing.Point(96, 55);
this.setTextSafeBtn.Name = "setTextSafeBtn";
this.setTextSafeBtn.TabIndex = 2;
this.setTextSafeBtn.Text = "Safe Call";
this.setTextSafeBtn.Click += new System.EventHandler(this.setTextSafeBtn_Click);
//
// setTextBackgroundWorkerBtn
//
this.setTextBackgroundWorkerBtn.Location = new System.Drawing.Point(177, 55);
this.setTextBackgroundWorkerBtn.Name = "setTextBackgroundWorkerBtn";
this.setTextBackgroundWorkerBtn.TabIndex = 3;
this.setTextBackgroundWorkerBtn.Text = "Safe BW Call";
this.setTextBackgroundWorkerBtn.Click += new System.EventHandler(this.setTextBackgroundWorkerBtn_Click);
//
// backgroundWorker1
//
this.backgroundWorker1.RunWorkerCompleted += new System.ComponentModel.RunWorkerCompletedEventHandler(this.backgroundWorker1_RunWorkerCompleted);
//
// Form1
//
this.ClientSize = new System.Drawing.Size(268, 96);
this.Controls.Add(this.setTextBackgroundWorkerBtn);
this.Controls.Add(this.setTextSafeBtn);
this.Controls.Add(this.setTextUnsafeBtn);
this.Controls.Add(this.textBox1);
this.Name = "Form1";
this.Text = "Form1";
this.ResumeLayout(false);
this.PerformLayout();

}

#endregion

[STAThread]
static void Main()
{
Application.EnableVisualStyles();
Application.Run(new Form1());
}

}
}

 

在运行该应用程序并单击“Unsafe Call”（不安全调用）按钮时，文本框中会立即显示“Written by the main thread”（由主线程写入）。
两秒钟后，当尝试进行不安全调用时，Visual Studio 调试器会指示出现异常。
调试器在尝试直接对文本框写入内容的后台线程中的行上停止。
您必须重新启动该应用程序才能测试其他两个按钮。 在单击“Safe Call”（安全调用）按钮时，文本框中会显示“Written by the main thread”（由主线程写入）。
两秒钟后，文本框会设置为“Written by the background thread (Invoke)”（由后台线程写入(Invoke)），这指示已调用
Invoke 方法。
在单击“Safe BW Call”（安全 BW 调用）按钮时，文本框中会显示“Written by the main thread”（由主线程写入）。
两秒钟后，文本框会设置为“Written by the main thread after the background thread completed”（在后台线程完成后由主线程写入），这指示已调用
BackgroundWorker 的
RunWorkerCompleted 事件的处理程序。

可靠编程

警告
使用任何一种多线程时，代码都容易产生非常严重而复杂的 bug。 有关更多信息，请在实现使用多线程的任何解决方案之前参见托管线程处理的最佳做法。