跨线程操作无效：从创建它的线程以外的线程访问控制

Question

我有一个场景。 （Windows 窗体、C#、.NET）

1. 有一个主窗体托管一些用户控件。
2. 用户控件执行一些繁重的数据操作，因此，如果我直接调用 UserControl_Load 方法，UI 在加载方法执行期间将变得无响应。
3. 为了克服这个问题，我在不同的线程上加载数据（尝试尽可能少地更改现有代码），
4. 我使用了一个后台工作线程，该线程将加载数据，完成后将通知应用程序它已完成其工作。
5. 现在真正的问题来了。 所有 UI（主窗体及其子用户控件）都是在主主线程上创建的。 在用户控件的 LOAD 方法中，我根据用户控件上某些控件（如文本框）的值获取数据。

伪代码如下所示：

CODE 1

UserContrl1_LoadDataMethod()
{
    if (textbox1.text == "MyName") // This gives exception
    {
        //Load data corresponding to "MyName".
        //Populate a globale variable List<string> which will be binded to grid at some later stage.
    }
}

它给出的异常是

跨线程操作无效：从创建它的线程以外的线程访问控制。

为了了解更多信息，我进行了一些谷歌搜索，并提出了一个建议，例如使用以下代码

代码 2

UserContrl1_LoadDataMethod()
{
    if (InvokeRequired) // Line #1
    {
        this.Invoke(new MethodInvoker(UserContrl1_LoadDataMethod));
        return;
    }

    if (textbox1.text == "MyName") // Now it won't give an exception
    {
    //Load data correspondin to "MyName"
        //Populate a globale variable List<string> which will be binded to grid at some later stage
    }
}

但似乎我仍然回到了第一个方向。 再次申请 变得没有反应。 这似乎是由于执行了第 1 行 if 条件所致。 加载任务再次由父线程完成，而不是我生成的第三个线程。

我不知道我的看法是对还是错。

我该如何解决这个问题以及执行 Line#1 if 块的效果是什么？

情况是这样的：我想根据控件的值将数据加载到全局变量中。 我不想从子线程更改控件的值。 我不会从子线程中执行此操作。

所以只有访问该值，才能从数据库中获取相应的数据。

Answer 1

跨线程操作有两种选择。

Control.InvokeRequired Property 

第二个是使用

SynchronizationContext Post Method

Control.InvokeRequired 仅当工作从 Control 类继承的控件时才有用，而 SynchronizationContext 可以在任何地方使用。 一些有用的信息如下链接

跨线程更新 UI | .Net

跨线程更新 UI使用 SynchronizationContext | .Net

Answer 2

行动 y； //在类内声明

label1.Invoke(y=()=>label1.Text="text");

Answer 3

只需使用这个：

this.Invoke((MethodInvoker)delegate
            {
                YourControl.Property= value; // runs thread safe
            });

Answer 4

同样的问题：how-to-update-the-gui -from-another-thread-in-c

两种方式：

1. 在 e.result 中返回值并使用它在 backgroundWorker_RunWorkerCompleted 事件中设置 yout 文本框值

2. 声明一些变量以在单独的类中保存这些类型的值（它将作为数据持有者）。 创建此类的静态实例，然后您可以通过任何线程访问它。

例子：

public  class data_holder_for_controls
{
    //it will hold value for your label
    public  string status = string.Empty;
}

class Demo
{
    public static  data_holder_for_controls d1 = new data_holder_for_controls();
    static void Main(string[] args)
    {
        ThreadStart ts = new ThreadStart(perform_logic);
        Thread t1 = new Thread(ts);
        t1.Start();
        t1.Join();
        //your_label.Text=d1.status; --- can access it from any thread 
    }

    public static void perform_logic()
    {
        //put some code here in this function
        for (int i = 0; i < 10; i++)
        {
            //statements here
        }
        //set result in status variable
        d1.status = "Task done";
    }
}

Answer 5

this.Invoke(new MethodInvoker(delegate
            {
                //your code here;
            }));

Answer 6

例如，从 UI 线程的 Control 获取文本：

Private Delegate Function GetControlTextInvoker(ByVal ctl As Control) As String

Private Function GetControlText(ByVal ctl As Control) As String
    Dim text As String

    If ctl.InvokeRequired Then
        text = CStr(ctl.Invoke(
            New GetControlTextInvoker(AddressOf GetControlText), ctl))
    Else
        text = ctl.Text
    End If

    Return text
End Function

Answer 7

与之前的答案相同，
但一个非常简短的补充，允许使用所有 Control 属性而不会出现跨线程调用异常。

帮助方法

/// <summary>
/// Helper method to determin if invoke required, if so will rerun method on correct thread.
/// if not do nothing.
/// </summary>
/// <param name="c">Control that might require invoking</param>
/// <param name="a">action to preform on control thread if so.</param>
/// <returns>true if invoke required</returns>
public bool ControlInvokeRequired(Control c, Action a)
{
    if (c.InvokeRequired) c.Invoke(new MethodInvoker(delegate
    {
        a();
    }));
    else return false;

    return true;
}

示例用法

// usage on textbox
public void UpdateTextBox1(String text)
{
    //Check if invoke requied if so return - as i will be recalled in correct thread
    if (ControlInvokeRequired(textBox1, () => UpdateTextBox1(text))) return;
    textBox1.Text = ellapsed;
}

//Or any control
public void UpdateControl(Color c, String s)
{
    //Check if invoke requied if so return - as i will be recalled in correct thread
    if (ControlInvokeRequired(myControl, () => UpdateControl(c, s))) return;
    myControl.Text = s;
    myControl.BackColor = c;
}

Answer 8

我在 xamarin studio 之外的 Visual Studio winforms 原型项目中编写 iOS 手机单点触控应用程序控制器时发现需要这样做。 我更喜欢尽可能在 VS 中编程而不是在 xamarin studio 中编程，我希望控制器与手机框架完全解耦。 通过这种方式，为 Android 和 Windows Phone 等其他框架实现这一点对于将来的使用来说会更加容易。

我想要一个解决方案，其中 GUI 可以响应事件，而无需处理每次按钮单击背后的跨线程切换代码。 基本上让类控制器处理它以保持客户端代码简单。 您可能在 GUI 上有许多事件，如果您可以在类中的一个地方处理它会更干净。 我不是多主题专家，如果这有缺陷，请告诉我。

public partial class Form1 : Form
{
    private ExampleController.MyController controller;

    public Form1()
    {          
        InitializeComponent();
        controller = new ExampleController.MyController((ISynchronizeInvoke) this);
        controller.Finished += controller_Finished;
    }

    void controller_Finished(string returnValue)
    {
        label1.Text = returnValue; 
    }

    private void button1_Click(object sender, EventArgs e)
    {
        controller.SubmitTask("Do It");
    }
}

GUI 形式不知道控制器正在运行异步任务。

public delegate void FinishedTasksHandler(string returnValue);

public class MyController
{
    private ISynchronizeInvoke _syn; 
    public MyController(ISynchronizeInvoke syn) {  _syn = syn; } 
    public event FinishedTasksHandler Finished; 

    public void SubmitTask(string someValue)
    {
        System.Threading.ThreadPool.QueueUserWorkItem(state => submitTask(someValue));
    }

    private void submitTask(string someValue)
    {
        someValue = someValue + " " + DateTime.Now.ToString();
        System.Threading.Thread.Sleep(5000);
//Finished(someValue); This causes cross threading error if called like this.

        if (Finished != null)
        {
            if (_syn.InvokeRequired)
            {
                _syn.Invoke(Finished, new object[] { someValue });
            }
            else
            {
                Finished(someValue);
            }
        }
    }
}

Answer 9

如果您正在使用的对象没有，这是一种替代方法

(InvokeRequired)

如果您正在使用除主窗体之外的类中的主窗体以及主窗体中的对象但没有InvokeRequired

delegate void updateMainFormObject(FormObjectType objectWithoutInvoke, string text);

private void updateFormObjectType(FormObjectType objectWithoutInvoke, string text)
{
    MainForm.Invoke(new updateMainFormObject(UpdateObject), objectWithoutInvoke, text);
}

public void UpdateObject(ToolStripStatusLabel objectWithoutInvoke, string text)
{
    objectWithoutInvoke.Text = text;
}

它的工作方式与上面相同，但如果您没有带有 invokerequired 的对象，但可以访问 MainForm，则这是一种不同的方法

Answer 10

解决此问题的简单且可重用的方法。

扩展方法

public static class FormExts
{
    public static void LoadOnUI(this Form frm, Action action)
    {
        if (frm.InvokeRequired) frm.Invoke(action);
        else action.Invoke();
    }
}

示例用法

private void OnAnyEvent(object sender, EventArgs args)
{
    this.LoadOnUI(() =>
    {
        label1.Text = "";
        button1.Text = "";
    });
}

Answer 11

您需要查看Backgroundworker 示例：
http://msdn.microsoft.com/en-us/library /system.componentmodel.backgroundworker.aspx
特别是它如何与 UI 层交互。 根据您的帖子，这似乎可以回答您的问题。

Answer 12

使用异步/等待和回调的新外观。 如果您将扩展方法保留在项目中，则只需要一行代码。

/// <summary>
/// A new way to use Tasks for Asynchronous calls
/// </summary>
public class Example
{
    /// <summary>
    /// No more delegates, background workers etc. just one line of code as shown below
    /// Note it is dependent on the XTask class shown next.
    /// </summary>
    public async void ExampleMethod()
    {
        //Still on GUI/Original Thread here
        //Do your updates before the next line of code
        await XTask.RunAsync(() =>
        {
            //Running an asynchronous task here
            //Cannot update GUI Thread here, but can do lots of work
        });
        //Can update GUI/Original thread on this line
    }
}

/// <summary>
/// A class containing extension methods for the Task class 
/// Put this file in folder named Extensions
/// Use prefix of X for the class it Extends
/// </summary>
public static class XTask
{
    /// <summary>
    /// RunAsync is an extension method that encapsulates the Task.Run using a callback
    /// </summary>
    /// <param name="Code">The caller is called back on the new Task (on a different thread)</param>
    /// <returns></returns>
    public async static Task RunAsync(Action Code)
    {
        await Task.Run(() =>
        {
            Code();
        });
        return;
    }
}

您可以向扩展方法添加其他内容，例如将其包装在 Try/Catch 语句中，允许调用者告诉它完成后返回什么类型，向调用者提供异常回调：

添加 Try Catch、自动异常记录和回调

    /// <summary>
    /// Run Async
    /// </summary>
    /// <typeparam name="T">The type to return</typeparam>
    /// <param name="Code">The callback to the code</param>
    /// <param name="Error">The handled and logged exception if one occurs</param>
    /// <returns>The type expected as a competed task</returns>

    public async static Task<T> RunAsync<T>(Func<string,T> Code, Action<Exception> Error)
    {
       var done =  await Task<T>.Run(() =>
        {
            T result = default(T);
            try
            {
               result = Code("Code Here");
            }
            catch (Exception ex)
            {
                Console.WriteLine("Unhandled Exception: " + ex.Message);
                Console.WriteLine(ex.StackTrace);
                Error(ex);
            }
            return result;

        });
        return done;
    }
    public async void HowToUse()
    {
       //We now inject the type we want the async routine to return!
       var result =  await RunAsync<bool>((code) => {
           //write code here, all exceptions are logged via the wrapped try catch.
           //return what is needed
           return someBoolValue;
       }, 
       error => {

          //exceptions are already handled but are sent back here for further processing
       });
        if (result)
        {
            //we can now process the result because the code above awaited for the completion before
            //moving to this statement
        }
    }

Answer 13

这不是解决此错误的推荐方法，但您可以快速抑制它，它会完成工作。 我更喜欢用它来制作原型或演示。 添加

CheckForIllegalCrossThreadCalls = false

到 Form1() 构造函数中。

Answer 14

按照最简单的（在我看来）方法从另一个线程修改对象：

using System.Threading.Tasks;
using System.Threading;

namespace TESTE
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            Action<string> DelegateTeste_ModifyText = THREAD_MOD;
            Invoke(DelegateTeste_ModifyText, "MODIFY BY THREAD");
        }

        private void THREAD_MOD(string teste)
        {
            textBox1.Text = teste;
        }
    }
}

Answer 15

UI 跨线程问题最干净（且正确）的解决方案是使用 SynchronizationContext，请参阅 在多线程应用程序中同步调用 UI 一文，它解释得非常好。

Answer 16

我发现需要在与表单相关的所有方法中散布的检查和调用代码过于冗长且不必要。 这是一个简单的扩展方法，可以让您完全摆脱它：

public static class Extensions
{
    public static void Invoke<TControlType>(this TControlType control, Action<TControlType> del) 
        where TControlType : Control
        {
            if (control.InvokeRequired)
                control.Invoke(new Action(() => del(control)));
            else
                del(control);
    }
}

然后您可以简单地执行以下操作：

textbox1.Invoke(t => t.Text = "A");

不再乱搞 - 简单。

Answer 17

.NET 中的控件通常不是线程安全的。 这意味着您不应该从该控件所在线程以外的线程访问该控件。 为了解决这个问题，您需要调用该控件，这正是您的第二个示例所尝试的。

但是，在您的情况下，您所做的只是将长时间运行的方法传递回主线程。 当然，这并不是您真正想要做的。 您需要重新考虑一下这一点，以便您在主线程上所做的只是在这里或那里设置一个快速属性。

Answer 18

我在使用 FileSystemWatcher 时遇到了这个问题，并发现以下代码解决了该问题：

fsw.SynchronizingObject = this

然后控件使用当前表单对象来处理事件，因此将位于同一线程上。

Answer 19

根据 Prera​​k K 的更新评论（已删除）：

我想我没有正确提出问题。

情况是这样的：我想根据控件的值将数据加载到全局变量中。 我不想从子线程更改控件的值。 我不会从子线程中执行此操作。

因此只有访问该值，才能从数据库中获取相应的数据。

您想要的解决方案应该如下所示：

UserContrl1_LOadDataMethod()
{
    string name = "";
    if(textbox1.InvokeRequired)
    {
        textbox1.Invoke(new MethodInvoker(delegate { name = textbox1.text; }));
    }
    if(name == "MyName")
    {
        // do whatever
    }
}

在尝试切换回控件的线程之前，在单独的线程中进行认真的处理。 例如：

UserContrl1_LOadDataMethod()
{
    if(textbox1.text=="MyName") //<<======Now it wont give exception**
    {
        //Load data correspondin to "MyName"
        //Populate a globale variable List<string> which will be
        //bound to grid at some later stage
        if(InvokeRequired)
        {
            // after we've done all the processing, 
            this.Invoke(new MethodInvoker(delegate {
                // load the control with the appropriate data
            }));
            return;
        }
    }
}

Answer 20

UI 中的线程模型

请阅读线程模型< /a> 在 UI 应用程序中（旧 VB 链接位于此处）以理解基本概念。 该链接导航到描述 WPF 线程模型的页面。 然而，Windows 窗体采用了相同的想法。

UI 线程

• 只有一个线程（UI 线程），允许访问 System.Windows.Forms.Control 及其子类成员。
• 尝试访问 System.Windows.Forms.Control< 的成员/a> 来自与 UI 线程不同的线程将导致跨线程异常。
• 由于只有一个线程，所有 UI 操作都会作为工作项排队到该线程中：

• 如果有UI线程没有工作，那么就有空闲间隙可供非UI相关的计算使用。
• 为了利用提到的间隙，请使用 System.Windows。 Forms.Control.Invoke 或 系统.Windows.Forms.Control.BeginInvoke 方法：

BeginInvoke 和 Invoke 方法

• 的计算开销被调用的方法应该很小，事件处理方法的计算开销也应该很小，因为那里使用了 UI 线程 - 与负责处理用户输入的线程相同。 无论这是否是 System.Windows.Forms.Control .调用或System.Windows。 Forms.Control.BeginInvoke。
• 要执行计算昂贵的操作，请始终使用单独的线程。 由于 .NET 2.0 BackgroundWorker 致力于执行昂贵的计算Windows 窗体中的操作。 但是，在新的解决方案中，您应该使用此处所述的异步等待模式。
• 使用 System.Windows.Forms.Control.Invoke< /a> 或 System.Windows.Forms.Control .BeginInvoke 方法仅用于更新用户界面。 如果您使用它们进行繁重的计算，您的应用程序将阻止：

调用

• System.Windows.Forms.Control.Invoke 导致单独的线程等待调用方法完成：

BeginInvoke

• System.Windows.Forms.Control.BeginInvoke 不会导致单独的线程等待调用的方法完成：

代码解决方案

阅读问题的答案 如何从 C# 中的另一个线程更新 GUI？。
对于 C# 5.0 和 .NET 4.5，推荐的解决方案位于此处。

Answer 21

您只想使用 Invoke 或 BeginInvoke 来完成更改 UI 所需的最少工作。 您的“重”方法应该在另一个线程上执行（例如通过BackgroundWorker），然后使用Control.Invoke/Control.BeginInvoke只是为了更新用户界面。 这样你的 UI 线程就可以自由地处理 UI 事件等。

请参阅我的 线程文章 了解更多信息WinForms 示例 - 尽管本文是在 BackgroundWorker 到了现场，这方面恐怕还没有更新。 BackgroundWorker 只是稍微简化了回调。

Answer 22

我知道现在已经太晚了。 然而，即使在今天，您是否在访问跨线程控件时遇到困难？ 这是迄今为止最短的答案：P

Invoke(new Action(() =>
                {
                    label1.Text = "WooHoo!!!";
                }));

这就是我从线程访问任何表单控件的方式。