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タイプショートカットのように、この追加のすべての作業を行わずに、このチェックを行う関数をオブジェクトにアタッチする方法があったら、すばらしいでしょう。

前の答えはちょうどたびに呼び出しを（）を呼び出すの非現実を議論してきた、とさえ[起動（）構文が非効率的との両方で、まだ対処しにくいです。

それで、誰かがショートカットを見つけましたか？

リーのアプローチはさらに簡略化できます

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ファイルを作成すると、更新ステートメントを選択し、右クリックして[Surround With ...]または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>

これは、リーズ、オリバーズ、ステファンの回答の改良/結合バージョンです。

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;
});

毎回新しいインスタンスを作成するのではなく、メソッドDelegateの単一のインスタンスを使用したいのです。私の場合、SQLインスタンスから大きなデータをコピーしてキャストするBackroundworkerからの進行状況と（情報/エラー）メッセージを表示するのが常でした。約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の4つのメソッドがあります（コントロールのハンドルが既に作成されている場合）。

シングルCPUアーキテクチャでは問題はありませんが、マルチCPUアーキテクチャでは、UIスレッドの一部を、呼び出し元のコードが実行されていたプロセッサに割り当てることができます...そのプロセッサがUIスレッドの場所と異なる場合実行中のスレッドが終了すると、WindowsはUIスレッドが終了したと見なし、アプリケーションプロセスを強制終了します。つまり、アプリケーションはエラーなしで終了します。