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

时间:2008-08-22 13:34:03

标签: c# multithreading events

我发现.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
}

10 个答案:

答案 0 :(得分:43)

我在线some code for this。它比其他建议好得多;绝对检查一下。

样本用法:

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

答案 1 :(得分:27)

有几点意见:

  • 不要在类似的代码中显式创建简单的委托,除非你是pre-2.0所以你可以使用:
   BeginInvoke(new EventHandler<CoolObjectEventArgs>(mCoolObject_CoolEvent), 
               sender, 
               args);
  • 此外,您不需要创建和填充对象数组,因为args参数是“params”类型,因此您只需传入列表。

  • 我可能会赞成Invoke超过BeginInvoke,因为后者将导致代码被异步调用,这可能会或可能不会是您所追求的但会使后续异常处理变得困难无需呼叫EndInvoke即可传播。会发生什么情况,您的应用最终会获得TargetInvocationException

答案 2 :(得分:10)

我避免冗余的代表声明。

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代表,因此根本不需要重新声明一个。

答案 3 :(得分: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标签的text属性。

答案 4 :(得分:3)

我认为最简单的方法是绝对去AOP路线。制作一些方面,添加必要的属性,您再也不必检查线程关联。

答案 5 :(得分:3)

如果要将结果发送到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());

        }
    }

答案 6 :(得分:2)

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

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

答案 7 :(得分:2)

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

在XAML中:

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

答案 8 :(得分:0)

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

答案 9 :(得分:-3)

我正在使用类似的东西

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