自动执行InvokeRequired代码模式

我已经痛苦地意识到，需要多长时间在事件驱动的GUI代码中编写以下代码模式，其中

private void DoGUISwitch() {
    // cruisin for a bruisin' through exception city
    object1.Visible = true;
    object2.Visible = false;
}

变成：

private void DoGUISwitch() {
    if (object1.InvokeRequired) {
        object1.Invoke(new MethodInvoker(() => { DoGUISwitch(); }));
    } else {
        object1.Visible = true;
        object2.Visible = false;
    }
}

这在C＃中是一个尴尬的模式，既要记住也要键入。有没有人想出某种捷径或构造可以在某种程度上实现自动化？如果有一种方法可以将函数附加到执行此检查的对象而不必完成所有额外工作（如object1.InvokeIfNecessary.visible = true类型快捷方式）的方法，那将很酷。

先前的答案已经讨论了每次调用Invoke（）都是不切实际的，即使这样，Invoke（）语法效率低下，仍然难以处理。

那么，有人知道快捷方式吗？

李的方法可以进一步简化

public static void InvokeIfRequired(this Control control, MethodInvoker action)
{
    // See Update 2 for edits Mike de Klerk suggests to insert here.

    if (control.InvokeRequired) {
        control.Invoke(action);
    } else {
        action();
    }
}

可以这样称呼

richEditControl1.InvokeIfRequired(() =>
{
    // Do anything you want with the control here
    richEditControl1.RtfText = value;
    RtfHelpers.AddMissingStyles(richEditControl1);
});

无需将控件作为参数传递给委托。C＃自动创建一个闭包。

更新：

根据其他几个海报Control可以概括为ISynchronizeInvoke：

public static void InvokeIfRequired(this ISynchronizeInvoke obj,
                                         MethodInvoker action)
{
    if (obj.InvokeRequired) {
        var args = new object[0];
        obj.Invoke(action, args);
    } else {
        action();
    }
}

DonBoitnott指出，与接口不同，Control该ISynchronizeInvoke接口需要该Invoke方法的对象数组作为的参数列表action。

更新2

Mike de Klerk建议进行的编辑（有关插入点，请参见第一个代码段中的注释）：

// When the form, thus the control, isn't visible yet, InvokeRequired  returns false,
// resulting still in a cross-thread exception.
while (!control.Visible)
{
    System.Threading.Thread.Sleep(50);
}

有关此建议的担忧，请参见下面的ToolmakerSteve的评论。

您可以编写一个扩展方法：

public static void InvokeIfRequired(this Control c, Action<Control> action)
{
    if(c.InvokeRequired)
    {
        c.Invoke(new Action(() => action(c)));
    }
    else
    {
        action(c);
    }
}

并像这样使用它：

object1.InvokeIfRequired(c => { c.Visible = true; });

编辑：正如Simpzon在评论中指出的，您还可以将签名更改为：

public static void InvokeIfRequired<T>(this T c, Action<T> action) 
    where T : Control

这是我在所有代码中一直使用的表格。

private void DoGUISwitch()
{ 
    Invoke( ( MethodInvoker ) delegate {
        object1.Visible = true;
        object2.Visible = false;
    });
} 

我已经基于此处的博客条目了。我没有让这种方法令我失望，因此我认为没有理由通过检查该InvokeRequired属性来使我的代码复杂化。

希望这可以帮助。

创建一个ThreadSafeInvoke.snippet文件，然后可以选择更新语句，右键单击并选择“环绕...”或Ctrl-K + S：

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippet Format="1.0.0" xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <Header>
    <Title>ThreadsafeInvoke</Title>
    <Shortcut></Shortcut>
    <Description>Wraps code in an anonymous method passed to Invoke for Thread safety.</Description>
    <SnippetTypes>
      <SnippetType>SurroundsWith</SnippetType>
    </SnippetTypes>
  </Header>
  <Snippet>
    <Code Language="CSharp">
      <![CDATA[
      Invoke( (MethodInvoker) delegate
      {
          $selected$
      });      
      ]]>
    </Code>
  </Snippet>
</CodeSnippet>

这是Lee，Oliver和Stephan的答案的改进/组合版本。

public delegate void InvokeIfRequiredDelegate<T>(T obj)
    where T : ISynchronizeInvoke;

public static void InvokeIfRequired<T>(this T obj, InvokeIfRequiredDelegate<T> action)
    where T : ISynchronizeInvoke
{
    if (obj.InvokeRequired)
    {
        obj.Invoke(action, new object[] { obj });
    }
    else
    {
        action(obj);
    }
} 

该模板允许灵活且无需强制转换的代码，在专用委托人提供效率的同时，这些代码更具可读性。

progressBar1.InvokeIfRequired(o => 
{
    o.Style = ProgressBarStyle.Marquee;
    o.MarqueeAnimationSpeed = 40;
});

我宁愿使用方法委托的单个实例，而不是每次都创建一个新实例。就我而言，我过去常常显示Backroundworker的进度和（信息/错误）消息，这些消息从sql实例复制和转换大型数据。在大约70000个进度和消息调用之后，我的表单停止工作并显示新消息。当我开始使用单个全局实例委托时，这没有发生。

delegate void ShowMessageCallback(string message);

private void Form1_Load(object sender, EventArgs e)
{
    ShowMessageCallback showMessageDelegate = new ShowMessageCallback(ShowMessage);
}

private void ShowMessage(string message)
{
    if (this.InvokeRequired)
        this.Invoke(showMessageDelegate, message);
    else
        labelMessage.Text = message;           
}

void Message_OnMessage(object sender, Utilities.Message.MessageEventArgs e)
{
    ShowMessage(e.Message);
}

用法：

control.InvokeIfRequired(c => c.Visible = false);

return control.InvokeIfRequired(c => {
    c.Visible = value

    return c.Visible;
});

码：

using System;
using System.ComponentModel;

namespace Extensions
{
    public static class SynchronizeInvokeExtensions
    {
        public static void InvokeIfRequired<T>(this T obj, Action<T> action)
            where T : ISynchronizeInvoke
        {
            if (obj.InvokeRequired)
            {
                obj.Invoke(action, new object[] { obj });
            }
            else
            {
                action(obj);
            }
        }

        public static TOut InvokeIfRequired<TIn, TOut>(this TIn obj, Func<TIn, TOut> func) 
            where TIn : ISynchronizeInvoke
        {
            return obj.InvokeRequired
                ? (TOut)obj.Invoke(func, new object[] { obj })
                : func(obj);
        }
    }
}

我有点喜欢做一些不同的事情，如果需要，我喜欢用“动作”来称呼“我自己”，

    private void AddRowToListView(ScannerRow row, bool suspend)
    {
        if (IsFormClosing)
            return;

        if (this.InvokeRequired)
        {
            var A = new Action(() => AddRowToListView(row, suspend));
            this.Invoke(A);
            return;
        }
         //as of here the Code is thread-safe

这是一个方便的模式，IsFormClosing是我关闭表单时将其设置为True的字段，因为可能有一些后台线程仍在运行...

您永远不应编写看起来像这样的代码：

private void DoGUISwitch() {
    if (object1.InvokeRequired) {
        object1.Invoke(new MethodInvoker(() => { DoGUISwitch(); }));
    } else {
        object1.Visible = true;
        object2.Visible = false;
    }
}

如果您确实有看起来像这样的代码，则您的应用程序不是线程安全的。这意味着您具有已经从其他线程调用DoGUISwitch（）的代码。现在要检查它是否在另一个线程中为时已晚。在调用DoGUISwitch之前，必须先调用InvokeRequire。您不应从其他线程访问任何方法或属性。

参考：Control.InvokeRequired属性 ，您可以在其中阅读以下内容：

除了InvokeRequired属性之外，控件上还有四种可以线程安全调用的方法：Invoke，BeginInvoke，EndInvoke和CreateGraphics（如果已创建控件的句柄）。

在单CPU架构中没有问题，但是在多CPU架构中，您可以将部分UI线程分配给运行调用代码的处理器...并且如果该处理器与UI线程所在的处理器不同如果正在运行，则在调用线程结束时Windows会认为UI线程已结束并杀死应用程序进程，即您的应用程序将退出而不会出现错误。