调用跨线程事件的最简洁方法

Question

我发现 .NET 事件模型是这样的，我经常在一个线程上引发事件并在另一个线程上侦听它。 我想知道将事件从后台线程编组到我的 UI 线程的最简洁方法是什么。

根据社区的建议，我使用了这个：

// earlier in the code
mCoolObject.CoolEvent+= 
           new CoolObjectEventHandler(mCoolObject_CoolEvent);
// then
private void mCoolObject_CoolEvent(object sender, CoolObjectEventArgs args)
{
    if (InvokeRequired)
    {
        CoolObjectEventHandler cb =
            new CoolObjectEventHandler(
                mCoolObject_CoolEvent);
        Invoke(cb, new object[] { sender, args });
        return;
    }
    // do the dirty work of my method here
}

Answer 1

我在网上有一些代码。 它比其他建议好得多； 一定要检查一下。

示例用法：

private void mCoolObject_CoolEvent(object sender, CoolObjectEventArgs args)
{
    // You could use "() =>" in place of "delegate"; it's a style choice.
    this.Invoke(delegate
    {
        // Do the dirty work of my method here.
    });
}

Answer 2

几个观察：

• 不要在这样的代码中显式创建简单的委托，除非您是 2.0 之前的版本，否则您可以使用：

   BeginInvoke(new EventHandler<CoolObjectEventArgs>(mCoolObject_CoolEvent), 
               sender, 
               args);

• 此外，您不需要创建和填充对象数组，因为 args 参数是“params”类型，因此您只需传入列表即可。

• 我可能更喜欢Invoke不是BeginInvoke因为后者将导致代码被异步调用，这可能是也可能不是您所追求的，但是如果不调用EndInvoke处理后续异常将难以传播。 会发生的情况是，您的应用程序最终会收到TargetInvocationException 。

Answer 3

我避免多余的委托声明。

private void mCoolObject_CoolEvent(object sender, CoolObjectEventArgs args)
{
    if (InvokeRequired)
    {
        Invoke(new Action<object, CoolObjectEventArgs>(mCoolObject_CoolEvent), sender, args);
        return;
    }
    // do the dirty work of my method here
}

对于非事件，您可以使用System.Windows.Forms.MethodInvoker委托或System.Action 。

编辑：此外，每个事件都有一个相应的EventHandler委托，因此根本不需要重新声明一个。

Answer 4

我出于自己的目的制作了以下“通用”跨线程调用类，但我认为值得分享：

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;

namespace CrossThreadCalls
{
  public static class clsCrossThreadCalls
  {
    private delegate void SetAnyPropertyCallBack(Control c, string Property, object Value);
    public static void SetAnyProperty(Control c, string Property, object Value)
    {
      if (c.GetType().GetProperty(Property) != null)
      {
        //The given property exists
        if (c.InvokeRequired)
        {
          SetAnyPropertyCallBack d = new SetAnyPropertyCallBack(SetAnyProperty);
          c.BeginInvoke(d, c, Property, Value);
        }
        else
        {
          c.GetType().GetProperty(Property).SetValue(c, Value, null);
        }
      }
    }

    private delegate void SetTextPropertyCallBack(Control c, string Value);
    public static void SetTextProperty(Control c, string Value)
    {
      if (c.InvokeRequired)
      {
        SetTextPropertyCallBack d = new SetTextPropertyCallBack(SetTextProperty);
        c.BeginInvoke(d, c, Value);
      }
      else
      {
        c.Text = Value;
      }
    }
  }

你可以简单地从另一个线程使用 SetAnyProperty() ：

CrossThreadCalls.clsCrossThreadCalls.SetAnyProperty(lb_Speed, "Text", KvaserCanReader.GetSpeed.ToString());

在本例中，上面的 KvaserCanReader 类运行自己的线程并调用以设置主窗体上 lb_Speed 标签的文本属性。

Answer 5

如果要将结果发送到 UI 线程，请使用同步上下文。 我需要更改线程优先级，因此我不再使用线程池线程（注释掉代码）并创建了一个我自己的新线程。 我仍然能够使用同步上下文来返回数据库取消是否成功。

    #region SyncContextCancel

    private SynchronizationContext _syncContextCancel;

    /// <summary>
    /// Gets the synchronization context used for UI-related operations.
    /// </summary>
    /// <value>The synchronization context.</value>
    protected SynchronizationContext SyncContextCancel
    {
        get { return _syncContextCancel; }
    }

    #endregion //SyncContextCancel

    public void CancelCurrentDbCommand()
    {
        _syncContextCancel = SynchronizationContext.Current;

        //ThreadPool.QueueUserWorkItem(CancelWork, null);

        Thread worker = new Thread(new ThreadStart(CancelWork));
        worker.Priority = ThreadPriority.Highest;
        worker.Start();
    }

    SQLiteConnection _connection;
    private void CancelWork()//object state
    {
        bool success = false;

        try
        {
            if (_connection != null)
            {
                log.Debug("call cancel");
                _connection.Cancel();
                log.Debug("cancel complete");
                _connection.Close();
                log.Debug("close complete");
                success = true;
                log.Debug("long running query cancelled" + DateTime.Now.ToLongTimeString());
            }
        }
        catch (Exception ex)
        {
            log.Error(ex.Message, ex);
        }

        SyncContextCancel.Send(CancelCompleted, new object[] { success });
    }

    public void CancelCompleted(object state)
    {
        object[] args = (object[])state;
        bool success = (bool)args[0];

        if (success)
        {
            log.Debug("long running query cancelled" + DateTime.Now.ToLongTimeString());

        }
    }

Answer 6

我认为最干净的方法肯定是走 AOP 路线。 创建几个方面，添加必要的属性，您就不必再次检查线程关联性。

Answer 7

我一直想知道总是假设需要调用是多么昂贵......

private void OnCoolEvent(CoolObjectEventArgs e)
{
  BeginInvoke((o,e) => /*do work here*/,this, e);
}

Answer 8

作为一个有趣的旁注，WPF 的绑定会自动处理封送处理，因此您可以将 UI 绑定到在后台线程上修改的对象属性，而无需执行任何特殊操作。 事实证明，这对我来说是一个很好的节省时间。

在 XAML 中：

<TextBox Text="{Binding Path=Name}"/>

Answer 9

您可以尝试开发某种通用组件，它接受SynchronizationContext作为输入并使用它来调用事件。

Answer 10

我正在使用类似的东西

Invoke((Action)(() =>
        {
            //your code
        }));