使用 Dispatcher 在 WPF 列表框中异步加载项目列表

Question

我正在创建一个 WPF 解决方案，它使用 MVVM 模式异步加载搜索控件中的搜索项。作为 WPF 用户控件的搜索控件是用一个文本框创建的，用于输入搜索文本和搜索按钮，以及一个隐藏的列表框，当它在其中加载搜索项目列表时，该列表框将可见。此用户控件依次嵌入到另一个 WPF 视图中，该视图具有某些项目的树视图。此视图有一个视图模型，其中加载树视图的搜索项的逻辑将加载到搜索控件中。一直以来，这一直在同步发生，无需使用任何 Dispatcher 调用。但是，在更改请求之后，我想使用 Dispatcher 在不同的线程中异步发生这种情况。

谁能告诉我如何在视图模型类中处理搜索控件的调度程序，以便使用我的视图模型不知道视图的 MVVM 模式对其调用 BeginInvoke？任何线索将不胜感激。

public ObservableCollection<Details> CatalogSearchResults { get; private set; }

private void ExecuteSearchCommand(object parameter)
    {
        CatalogSearchResults.Clear();
        if (string.IsNullOrEmpty(parameter.ToString())) return;

        searchtext = (string)parameter;
        searchtext.Trim();

        SetSearchResults();
    }

private void SetSearchResults() 
    { 
    BackgroundWorker bw = new BackgroundWorker(); 

    bw.DoWork += LoadResults; 
    bw.RunWorkerCompleted += this.LoadResultsCompleted; 

    bw.RunWorkerAsync(); 
    } 

private void LoadResults(object sender, DoWorkEventArgs args) 
{ 
        IsSearchInProgress = true;
        foreach (var category in _rootCategory.Recurse(FindChildren))
        {
            if (category.CommentDetails != null)
            {
                //limitation - there is no direct way to add range to observable collection.
                //Using linq query would result in two loops rather than one.
                foreach (var node in category.Details)
                {
                    if (node.Name.IndexOf(searchtext, StringComparison.CurrentCultureIgnoreCase) >= 0
                        || node.PrecannedText.IndexOf(searchtext,            StringComparison.CurrentCultureIgnoreCase) >= 0)
                    {
                        Application.Current.Dispatcher.BeginInvoke(DispatcherPriority.Normal,
                            (ThreadStart)delegate { CatalogSearchResults.Add(node); }); 
                          Thread.Sleep(100); 
                    }
                }
            }
        }
        IsSearchInProgress = false;
}

在 xaml 中，我将 Search 控件的 Items 属性绑定到 CatalogSearchResults：

 <ctrl:SearchControl x:Name="Ctrl" Grid.RowSpan="2" HorizontalAlignment="Stretch" VerticalAlignment="Top"   ToolTip="Search" Command="{Binding SearchCommand}"   Grid.ColumnSpan="3"                                                                             
            CommandParameter="{Binding Text, RelativeSource={RelativeSource Self}}"                                                                                
            Items ="{Binding CatalogSearchResults}" > </ctrl:SearchControl>

谢谢， 苏米亚

Answer 1

这是一个简单的实现，展示了如何在 DoWork 运行时使用 BackgroundWorker 更新 UI 线程上的对象 - 在此示例中，UI 中有一个 ListBox 绑定到 FilteredItems 和 @987654325 @ 是 IEnumerable 类型的 UserControl 的属性：

    FilteredItems = new ObservableCollection<object>();
    BackgroundWorker bw = new BackgroundWorker();
    bw.WorkerReportsProgress = true;
    bw.DoWork += bw_DoWork;
    bw.RunWorkerCompleted += bw_RunWorkerCompleted;
    bw.ProgressChanged += bw_ProgressChanged;
    bw.RunWorkerAsync();

    private void bw_DoWork(object sender, DoWorkEventArgs e)
    {
        BackgroundWorker bw = (BackgroundWorker) sender;
        var result = ItemsSource
           .OfType<object>()
           .Where(x => x.ToString().Contains(_FilterText));
        foreach (object o in result)
        {
            // Pass each object found to bw_ProgressChanged in the UserState argument.
            // This updates the UI as each item is found.
            bw.ReportProgress(0, o);
        }
    }

    void bw_ProgressChanged(object sender, ProgressChangedEventArgs e)
    {
        // FilteredItems is bound to the UI, but it's OK to update it here because
        // the ProgressChanged event handler runs on the UI thread.
        FilteredItems.Add(e.UserState);
    }

    private void bw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
        if (e.Error != null)
        {
            MessageBox.Show(e.Error.Message);
        }
    }

请注意，每次找到项目时调用ReportProgress 效率非常低，因为您正在使用Invoke 调用跨线程编组找到的每个项目。根据过滤实际花费的时间，最好累积一堆结果并将List<object> 传递给bw_ReportProgress，而不是仅仅传递一个object。

Answer 2

这取决于很多因素（而且您的描述有点令人困惑），但我给出了一个冗长的答案here 可能会对此事有所了解。基本上，单独使用dispatcher不会自动使代码多线程；你需要一些真正的多线程机制，比如 BackgroundWorker 或 Task Parallel Library。根据您的设置方式以及您在另一个线程中所做的确切操作，您可能确实需要在调度程序线程上调用一些操作 - 但是 BackgroundWorker 在大多数情况下会自动执行此操作，所以我会使用它来做一些简单的事情.任务并行库还对调度程序进行了特殊处理，您应该在 MSDN 或任何 TPL 教程上找到更多信息。

如果您直到现在还没有大量处理多线程，我给出的最佳建议是尽可能多地收集有关它的信息，因为到目前为止已经无数次说过，多线程是困难！ :)

Answer 3

根据需要进行修改。 'Items' 只是从 VM 公开的字符串的 observableCollection

    private void SetSearchResults()
    {
        BackgroundWorker bw = new BackgroundWorker();

        bw.DoWork += LoadResults;
        bw.RunWorkerCompleted += this.LoadResultsCompleted;

        bw.RunWorkerAsync();
    }

    private void LoadResultsCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
    }

    private void LoadResults(object sender, DoWorkEventArgs args)
    {
        List<string> results = GetResults();

        foreach (string result in results)
        {
             Application.Current.Dispatcher.Invoke(
                    DispatcherPriority.Normal, (ThreadStart)delegate { Items.Add(result); } //Dont worry about access to modified closure in this case
             Thread.Sleep(100);
        }
    }

在 XAML 中

<ListBox ItemsSource={Binding Items}/>

Answer 4

应用程序中的所有视图都有相同的调度程序，您可以使用Application.Current.Dispatcher 访问它。

但无论如何，您不需要调度程序在工作线程上执行操作。您只需要它在 UI 上执行操作，因为 UI 元素只能从 UI 线程访问。但即便如此，您通常也不需要显式操作调度程序。您可以从工作线程更新 ViewModel 的属性，绑定到该属性的控件将正常更新，因为 PropertyChanged 事件会自动编组到 UI 调度程序。

不起作用的工作是从工作线程修改绑定的ObservableCollection<T>：您需要使用Dispatcher.Invoke 从 UI 线程执行此操作。您也可以使用specialized ObservableCollection<T> that raises event on the UI thread。