c# - Winform服务总线消息接收方如何避免跨线程操作not valid异常

Question

这个问题已经有答案了:

Cross-thread operation not valid: Control accessed from a thread other than the thread it was created on (22 个回答)

已关闭 2 年前。

开发了一个运行良好的 Azure 服务总线消息接收器控制台应用程序 console app 。

控制台应用程序代码如下:

using System.IO;
using Microsoft.ServiceBus.Messaging;

class Program
{
    static void Main(string[] args)
    {
        const string connectionString = "Endpoint=sb://sbusnsXXXX.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=bkjk3Qo5QFoILlnay44ptlukJqncoRUaAfR+KtZp6Vo=";
        const string queueName = "bewtstest1";
        var queueClient = QueueClient.CreateFromConnectionString(connectionString, queueName);

        try
        {
            queueClient.OnMessage(message => {
                string body = new StreamReader(message.GetBody<Stream>(), Encoding.UTF8).ReadToEnd();                                        
                Console.WriteLine(body);
                message.Complete();                    
            });
            Console.ReadLine();
        }
        catch (Exception ex)
        {
            queueClient.OnMessage(message => {
                Console.WriteLine(ex.ToString());
                message.Abandon();                    
            });
            Console.ReadLine();
        }            
    }
}

尝试转换为 WinForms 应用程序，以便我可以将服务总线消息显示为列表框中的字符串。
我使用控制台应用程序代码创建了一个新类 ( Azure )，并在主窗体中调用该方法。

Azure 级:

using System.IO;
using Microsoft.ServiceBus.Messaging;

public class Azure
{
    public static void GetQueue(Form1 form)
    {
        const string connectionString = "Endpoint=sb://sbusnsXXXX.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=bkjk3Qo5QFoILlnay44ptlukJqncoRUaAfR+KtZp6Vo=";
        const string queueName = "bewtstest1";
        var queueClient = QueueClient.CreateFromConnectionString(connectionString, queueName);

        try
        {
            queueClient.OnMessage(message => {
                string body = new StreamReader(message.GetBody<Stream>(), Encoding.UTF8).ReadToEnd();
                //Form1 f = new Form1();                
                form.listBox1.Items.Add(body);
                Console.WriteLine(body);
                message.Complete();
            });
            Console.ReadLine();
        }
        catch (Exception ex)
        {
            queueClient.OnMessage(message => {
                Console.WriteLine(ex.ToString());
                message.Abandon();
            });
            Console.ReadLine();
        }
    }
}

主窗体:

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();
        Azure.GetQueue(this);
    }
}

代码可以编译，但是当收到新的服务总线消息时，出现以下异常:

System.InvalidOperationException: 'Cross-thread operation not valid: Control 'listBox1' accessed from a thread other than the thread it was created on.'

关于如何避免此异常的任何想法(请注意，我已尝试使用 InvokeRequired 但无法编译代码)？

(感觉我已经很接近了，因为当我停止并重新运行程序时，表单会加载列表框中的消息，如下所示:listbox with message!)

Answer 1

当然，你不能从另一个线程引用在UI线程中创建的控件；正如您所注意到的， Invalid Cross-thread operation当您尝试执行以下操作时会引发异常:Windows 窗体应用程序必须是单线程的，STAThreadAttribute Class 中很好地解释了原因。文档。

注意:删除所有 Console.ReadLine() ，您不能在 WinForms 中使用它(没有控制台)。

这里有一些可能适合您的实现，按照与您的上下文相关的顺序排列(嗯，至少我是这么认为的。您选择您喜欢的)。

▶ Progress<T> : 这个类使用起来非常简单。您只需要定义它的返回类型( T 类型，它可以是任何东西，一个简单的 string ，一个类对象等)。您可以就地定义它(调用线程方法的地方)并传递其引用。仅此而已。
接收引用的方法调用其 Report()方法，传递 T 定义的值.
该方法在创建 Progress<T> 的线程中执行对象。
如您所见，您不需要将 Control 引用传递给 GetQueue() :

表格侧面:

// [...]
var progress = new Progress<string>(msg => listBox1.Items.Add(msg));

Azure.GetQueue(progress);
// [...]

Azure 类端:

public static void GetQueue(IProgress<string> update)
{    
    // [...]
    try {
        queueClient.OnMessage(message => {
            string body = new StreamReader(message.GetBody<Stream>(), Encoding.UTF8).ReadToEnd();
            update.Report(body);
            message.Complete();
         });
    }
    // [...]
}

<小时/>

▶ SynchronizationContext ( WindowsFormsSynchronizationContext ) Post() :该类用于同步线程上下文，其Post()方法将异步消息分派(dispatch)到生成类对象的同步上下文，由Current引用。属性(property)。
当然，参见Parallel Computing - It's All About the SynchronizationContext .

实现与之前没有太大不同:您可以使用 Lambda 作为 SendOrPostCallback Post() 方法的委托(delegate)。
安Action<string> delegate 用于发布到 UI 线程，而不需要传递对 Azure.GetQueue() 的 Control 引用。方法:

表格侧面:

// Add static Field for the SynchronizationContext object
static SynchronizationContext sync = null;

// Add a method that will receive the Post() using an Action delegate
private void Updater(string message) => listBox1.Items.Add(message);

// Call the method from somewhere, passing the current sync context
sync = SynchronizationContext.Current;
Azure.GetQueue(sync, Updater);
// [...]

Azure 类端:

public static void GetQueue(SynchronizationContext sync, Action<string> updater)
{    
    // [...]
    try {
        queueClient.OnMessage(message => {
            string body = new StreamReader(message.GetBody<Stream>(), Encoding.UTF8).ReadToEnd();
            sync.Post((spcb) => { updater(body); }, null);
            message.Complete();
         });
    }
    // [...]
}

<小时/>

▶ Control.BeginInvoke() :您可以使用BeginInvoke()在创建 Control 句柄的线程上异步执行委托(delegate)(通常作为 Lambda)。
当然，您必须将 Control 引用传递给 Azure.GetQueue()方法。
这就是为什么在本例中，此方法的优先级较低(但您无论如何都可以使用它)。

<子> BeginInvoke()不需要检查Control.InvokeRequired :可以从任何线程调用此方法，包括 UI 线程。调用Invoke()相反，需要进行该检查，因为如果从 UI 线程使用它可能会导致死锁

表格侧面:

Azure.GetQueue(this, Updater);
// [...]

// Add a method that will act as the Action delegate
private void Updater(string message) => listBox1.Items.Add(message);

Azure 类端:

public static void GetQueue(Control control, Action<string> action)
{    
    // [...]
    try {
        queueClient.OnMessage(message => {
            string body = new StreamReader(message.GetBody<Stream>(), Encoding.UTF8).ReadToEnd();
            control.BeginInvoke(new Action(()=> action(body));
            message.Complete();
         });
    }
    // [...]
}

<小时/>

您还可以使用System.Windows.Threading.Dispatcher管理线程的排队工作项，调用其 BeginInvoke() (首选)或 Invoke()方法。
其实现类似于SynchronizationContext one 及其方法被称为 Control.BeginInvoke()方法已经提到了。

我不会在这里实现它，因为调度程序需要引用 WindowsBase.dll (通常是 WPF)，这可能会在非 DpiAware 的 WinForms 应用程序中导致不良影响。
您可以在这里阅读相关内容:
DPI Awareness - Unaware in one Release, System Aware in the Other

无论如何，如果您有兴趣，请告诉我。