Автоматизація шаблону коду 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

Зміни, запропоновані Майком де Клерком (див. Коментар у фрагменті першого коду для точки вставки):

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

EDIT: Як в коментарях вказує Сімпсон, ви також можете змінити підпис на:

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, а не створювати новий примірник кожен раз. У моєму випадку я показував прогрес та (інформацію / помилку) повідомлення від 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 () з іншого потоку. Занадто пізно перевіряти, чи немає в іншому потоці. Викликати InvokeRequire потрібно перед тим, як зателефонувати до DoGUISwitch. Ви не маєте доступу до будь-якого методу чи властивості з іншого потоку.

Довідка: властивість Control.InvokeRequired, де ви можете прочитати наступне:

Окрім властивості InvokeRequired, на контролі є чотири способи, безпечні для виклику: Invoke, BeginInvoke, EndInvoke та CreateGraphics, якщо ручка для керування вже створена.

В одній архітектурі центрального процесора немає жодних проблем, але в архітектурі декількох процесорів ви можете змусити частину потоку користувальницького інтерфейсу призначити процесору, де працює код виклику ... і якщо цей процесор відрізняється від місця, де потік інтерфейсу користувача Запускався тоді, коли виклик потоку закінчується Windows подумає, що потік користувальницького інтерфейсу закінчився і вбиває процес подачі заявки, тобто ваша програма вийде без помилок.