c# - BackgroundWorker RunWorkerCompleted 未在 UI 线程上执行
问题描述
我在 BackgroundWorker 周围写了一个小包装:
public class Worker
{
public void Execute<T>(Func<T> work, Action<Exception, T> workCompleted)
{
var worker = new BackgroundWorker();
worker.DoWork += (o, ea) => { ea.Result = work(); };
worker.RunWorkerCompleted += (o, ea) => { workCompleted(ea.Error, (T)ea.Result); };
worker.RunWorkerAsync();
}
}
我在视图模型(在 XAML 中创建)中使用它,如下所示:
public class MainWindowViewmodel : INotifyPropertyChanged
{
private ObservableCollection<Job> _jobs = new ObservableCollection<Job>();
public ICollectionView JobsView { get; } = CollectionViewSource.GetDefaultView(_jobs);
public RelayCommand RefreshJobsCommand => new RelayCommand(x => UpdateJobs()); /*edit1*/
private void UpdateJobs() /*executed via command binding*/
{
new Worker().Execute(() => _webServiceManager.JobService.GetJobsByDate(settings.Limit, DateTime.Now.AddDays(-365)), (ex, jobArray) =>
{
jobArray.toList().ForEach(j=>_jobs.Add(j));
});
}
}
将作业添加workCompleted
到 ObservableCollection_jobs
时,出现以下异常:
This type of CollectionView does not support changes to its SourceCollection from a thread different from the Dispatcher thread.
所以显然RunWorkerCompleted
回调不会在 UI 线程上运行。但据我所知,它应该在RunWorkerAsync
被调用的一个线程上运行?这应该是 UI 线程,因为它是从命令绑定(也是 UI 线程)的视图模型(从 XAML 创建)内部调用的,对吗?
我在这里想念什么?
Edit2:
我可以将问题缩小到作业的初始加载。这是由 ctor 完成的MainWindow
,并将导致所描述的问题。之后通过命令绑定使用 UI 按钮进行的任何其他更新都可以正常工作。
所以问题是,在初始加载时,MainWindow
ctor、ViewModel
ctor 和Worker.Execute()
在 UI 线程上执行,但workCompleted
不是,尽管SynchronizationContext
应该在调用时设置为 UI 线程RunWorkerAsync
。
每当通过命令绑定触发下一次加载时,workCompleted
也将其设置为SynchronizationContext
UI 线程。
知道为什么这首先不起作用吗?
public partial class MainWindow : Window
{
private MainWindowViewmodel _viewmodel;
public MainWindow(Connection connection)
{
InitializeComponent();
Debug.WriteLine("mainwindow-ctor: " + Thread.CurrentThread.ManagedThreadId.ToString());
_viewmodel = (MainWindowViewmodel)DataContext;
_viewmodel.UpdateJobs();
}
}
解决方案
RunWokerCompleted
处理事件的线程由调用方法SynchronizationContext.Current
时的属性决定RunWorkerAsync
。
因此,如果您的Execute
方法实际上在 WPF 应用程序中的 UI 线程上调用,其中SynchronizationContext.Current
属性返回 a DispatcherSynchronizationContext
,workCompleted
也将在此线程上调用。您可以通过调用Execute()
以下构造函数轻松地自己确认这一点MainWindow
:
public partial class MainWindow : Window
{
public MainWindow()
{
InitializeComponent();
new Worker().Execute(() => { Thread.Sleep(5000); return 0; }, (ex, jobArray) =>
{
MessageBox.Show(Thread.CurrentThread.ManagedThreadId.ToString());
});
}
}
顺便说一句,自 .NET Framework 4 以来,任务并行库 (TPL)是编写多线程和并行代码的首选方式。任务异步编程模型 (TAP) 以及 .NET 4.5 中引入的async
andawait
关键字使其更加容易使用。