如何从另一个线程更新GUI

技术背景

在开发GUI应用程序时，由于线程安全的问题，不能直接从非UI线程更新GUI控件。因为大多数GUI框架都要求所有GUI操作必须在UI线程上进行，否则可能会导致界面显示异常、崩溃等问题。因此，需要采用特定的方法来实现从其他线程安全地更新GUI。

实现步骤

1. 使用Invoke方法（.NET 2.0及以上）

这是一种常见的同步更新GUI的方法，通过Control.Invoke将代码委托给UI线程执行。

// Running on the worker thread
string newText = "abc";
form.Label.Invoke((MethodInvoker)delegate {
    // Running on the UI thread
    form.Label.Text = newText;
});

2. 封装通用方法（.NET 2.0及以上）

将Invoke操作封装成一个通用方法，便于对任何Control的属性进行线程安全的更新。

private delegate void SetControlPropertyThreadSafeDelegate(
    Control control,
    string propertyName,
    object propertyValue);

public static void SetControlPropertyThreadSafe(
    Control control,
    string propertyName,
    object propertyValue)
{
  if (control.InvokeRequired)
  {
    control.Invoke(new SetControlPropertyThreadSafeDelegate
    (SetControlPropertyThreadSafe), 
    new object[] { control, propertyName, propertyValue });
  }
  else
  {
    control.GetType().InvokeMember(
        propertyName, 
        BindingFlags.SetProperty, 
        null, 
        control, 
        new object[] { propertyValue });
  }
}

调用方式：

// thread-safe equivalent of
// myLabel.Text = status;
SetControlPropertyThreadSafe(myLabel, "Text", status);

3. 使用扩展方法（.NET 3.0及以上）

将上述方法改写为Control类的扩展方法，简化调用。

public static void SetPropertyThreadSafe(this Control control, string propertyName, object propertyValue)
{
    if (control.InvokeRequired)
    {
        control.Invoke(new Action(() => control.SetPropertyThreadSafe(propertyName, propertyValue)));
    }
    else
    {
        control.GetType().GetProperty(propertyName)?.SetValue(control, propertyValue);
    }
}

调用方式：

myLabel.SetPropertyThreadSafe("Text", status);

4. 使用Task-based Asynchronous Pattern (TAP)和async-await（.NET 4.5及以上）

这是现代的异步编程模式，推荐用于新开发项目。

private async void Button_Clicked(object sender, EventArgs e)
{
    var progress = new Progress<string>(s => label.Text = s);
    await Task.Factory.StartNew(() => SecondThreadConcern.LongWork(progress),
                                TaskCreationOptions.LongRunning);
    label.Text = "completed";
}

class SecondThreadConcern
{
    public static void LongWork(IProgress<string> progress)
    {
        // Perform a long running work...
        for (var i = 0; i < 10; i++)
        {
            Task.Delay(500).Wait();
            progress.Report(i.ToString());
        }
    }
}

最佳实践

• 尽量使用异步方法：特别是在处理长时间运行的任务时，使用async-await和Task可以避免阻塞UI线程，保持界面的响应性。
• 使用IProgress<T>：对于需要更新进度的任务，使用IProgress<T>接口可以方便地在后台任务中更新UI，并且会自动处理线程同步问题。
• 检查InvokeRequired：在调用Invoke或BeginInvoke之前，先检查InvokeRequired属性，避免不必要的调用。

常见问题

• ObjectDisposedException：如果在调用Invoke之前，用户关闭了窗体或销毁了控件，可能会抛出ObjectDisposedException异常。可以使用SynchronizationContext来避免这个问题。

public partial class MyForm : Form
{
    private readonly SynchronizationContext _context;
    public MyForm()
    {
        _context = SynchronizationContext.Current;
        ...
    }

    private MethodOnOtherThread()
    {
         ...
         _context.Post(status => someLabel.Text = newText, null);
    }
}

• 频繁调用BeginInvoke：如果过于频繁地调用BeginInvoke，可能会使消息队列过载，影响性能。应合理控制调用频率。
• 忽略InvokeRequired检查：如果在控件的窗口句柄尚未创建之前调用Invoke，会抛出异常。因此，建议始终在调用Invoke或BeginInvoke之前检查InvokeRequired属性。