WPF异步ComboBox过滤实现问题求助

问题描述 #

我是异步方法新手，遇到如下问题（已编写简化示例）：

我有一个ComboBox，其Items绑定到包含若干名称的BindableCollection<string> NameList。

XAML代码 #

<ComboBox
    x:Name="SubbranchComboBox"
    Margin="20 0 0 0"
    Width="100"
    Height="20"
    IsEnabled="True"
    IsEditable="True"
    IsTextSearchEnabled="False"
    InputScope="Xml"
    ItemsSource="{Binding NameList}" 
    KeyUp="ComboBox_KeyUp">
    <ComboBox.ItemTemplate>
        <DataTemplate>
            <TextBlock Text="{Binding}" />
        </DataTemplate>
    </ComboBox.ItemTemplate>
</ComboBox>

过滤事件代码 #

该ComboBox_KeyUp事件用于实现输入短语的搜索过滤功能：

private void ComboBox_KeyUp(object sender, KeyEventArgs e)
{
    var combobox = (ComboBox)sender;
    var ctb = combobox.Template.FindName("PART_EditableTextBox", combobox) as TextBox;
    if (ctb == null) return;
    if (Keyboard.Modifiers.HasFlag(ModifierKeys.Shift) || Keyboard.Modifiers.HasFlag(ModifierKeys.Control) || Keyboard.Modifiers.HasFlag(ModifierKeys.Alt))
        return;
    var caretPos = ctb.CaretIndex;
    var searchedText = combobox.Text.ToLower();
    combobox.SelectedIndex = -1;
    combobox.IsDropDownOpen = true;

    CollectionView itemsViewOriginal = (CollectionView)CollectionViewSource.GetDefaultView(combobox.Items);
    itemsViewOriginal.Filter = ((o) =>
    {
        if (String.IsNullOrEmpty(searchedText))
        {
            return true;
        }
        else
        {
            if (((string)o).ToLower().Contains(searchedText.ToLower()))
            {
                return true;
            }
            else
            {
                return false;
            }
        }
    });
    itemsViewOriginal.Refresh();
    ctb.CaretIndex = caretPos;
}

完整示例代码 #

public partial class MainWindow : Window
{
    public BindableCollection<String> NameList { get; set; }
    public MainWindow()
    {
        InitializeComponent();
        DataContext = this;
        NameList = new BindableCollection<String>
            {
                "Tony",
                "Jerry",
                "George",
                "Harry",
                "Snape",
                "Sirius",
                "Dan",
                "Michael",
                "Mike",
                "Sebastian",
                "Simon",
                "Johny"
            };
    }

    private void ComboBox_KeyUp(object sender, KeyEventArgs e)
    {
        var combobox = (ComboBox)sender;
        var ctb = combobox.Template.FindName("PART_EditableTextBox", combobox) as TextBox;
        if (ctb == null) return;
        if (Keyboard.Modifiers.HasFlag(ModifierKeys.Shift) || Keyboard.Modifiers.HasFlag(ModifierKeys.Control) || Keyboard.Modifiers.HasFlag(ModifierKeys.Alt))
            return;
        var caretPos = ctb.CaretIndex;
        var searchedText = combobox.Text.ToLower();
        combobox.SelectedIndex = -1;
        combobox.IsDropDownOpen = true;

        CollectionView itemsViewOriginal = (CollectionView)CollectionViewSource.GetDefaultView(combobox.Items);
        itemsViewOriginal.Filter = ((o) =>
        {
            if (String.IsNullOrEmpty(searchedText))
            {
                return true;
            }
            else
            {
                if (((string)o).ToLower().Contains(searchedText.ToLower()))
                {
                    return true;
                }
                else
                {
                    return false;
                }
            }
        });
        itemsViewOriginal.Refresh();
        ctb.CaretIndex = caretPos;
    }
}

遇到的问题 #

尝试将过滤操作改为异步执行时，总是触发错误：The calling thread cannot access this object because a different thread owns it

解决建议 #

核心原因 #

WPF的控件和绑定的数据集合属于创建它们的UI线程，异步操作默认在后台线程执行，直接跨线程访问UI线程对象会触发权限错误。

实现方案 #

1. 后台线程执行过滤逻辑：将耗时的过滤计算放到线程池，避免阻塞UI响应。
2. UI线程更新视图：过滤完成后，通过Dispatcher切换回UI线程，再更新CollectionView的过滤规则并刷新视图。
3. 可选：输入防抖：连续输入时延迟触发过滤，减少不必要的异步调用。

修改后的异步过滤代码 #

private async void ComboBox_KeyUp(object sender, KeyEventArgs e)
{
    var combobox = (ComboBox)sender;
    var ctb = combobox.Template.FindName("PART_EditableTextBox", combobox) as TextBox;
    if (ctb == null) return;
    if (Keyboard.Modifiers.HasFlag(ModifierKeys.Shift) || 
        Keyboard.Modifiers.HasFlag(ModifierKeys.Control) || 
        Keyboard.Modifiers.HasFlag(ModifierKeys.Alt))
        return;

    var caretPos = ctb.CaretIndex;
    var searchedText = combobox.Text.ToLower();
    combobox.SelectedIndex = -1;
    combobox.IsDropDownOpen = true;

    // 后台线程执行过滤逻辑
    var filteredItems = await Task.Run(() =>
    {
        var originalList = NameList.ToList();
        if (string.IsNullOrEmpty(searchedText))
            return originalList;
        return originalList.Where(item => item.ToLower().Contains(searchedText)).ToList();
    });

    // 切换回UI线程更新视图
    await Application.Current.Dispatcher.InvokeAsync(() =>
    {
        var itemsView = (CollectionView)CollectionViewSource.GetDefaultView(combobox.Items);
        itemsView.Filter = o => filteredItems.Contains((string)o);
        itemsView.Refresh();
        ctb.CaretIndex = caretPos;
    });
}

防抖优化（可选） #

添加防抖逻辑避免连续输入频繁触发异步操作：

private DispatcherTimer _debounceTimer;

public MainWindow()
{
    InitializeComponent();
    DataContext = this;
    // 初始化防抖定时器，延迟500ms执行
    _debounceTimer = new DispatcherTimer { Interval = TimeSpan.FromMilliseconds(500) };
    _debounceTimer.Tick += DebounceTimer_Tick;

    // 初始化NameList
    NameList = new BindableCollection<String>
    {
        "Tony",
        "Jerry",
        "George",
        "Harry",
        "Snape",
        "Sirius",
        "Dan",
        "Michael",
        "Mike",
        "Sebastian",
        "Simon",
        "Johny"
    };
}

private void ComboBox_KeyUp(object sender, KeyEventArgs e)
{
    var combobox = (ComboBox)sender;
    var ctb = combobox.Template.FindName("PART_EditableTextBox", combobox) as TextBox;
    if (ctb == null) return;
    if (Keyboard.Modifiers.HasFlag(ModifierKeys.Shift) || 
        Keyboard.Modifiers.HasFlag(ModifierKeys.Control) || 
        Keyboard.Modifiers.HasFlag(ModifierKeys.Alt))
        return;

    var caretPos = ctb.CaretIndex;
    var searchedText = combobox.Text.ToLower();
    combobox.SelectedIndex = -1;
    combobox.IsDropDownOpen = true;

    // 重置定时器
    _debounceTimer.Stop();
    _debounceTimer.Tag = new Tuple<ComboBox, TextBox, int, string>(combobox, ctb, caretPos, searchedText);
    _debounceTimer.Start();
}

private async void DebounceTimer_Tick(object sender, EventArgs e)
{
    _debounceTimer.Stop();
    var tuple = (Tuple<ComboBox, TextBox, int, string>)_debounceTimer.Tag;
    var combobox = tuple.Item1;
    var ctb = tuple.Item2;
    var caretPos = tuple.Item3;
    var searchedText = tuple.Item4;

    // 后台过滤
    var filteredItems = await Task.Run(() =>
    {
        var originalList = NameList.ToList();
        if (string.IsNullOrEmpty(searchedText))
            return originalList;
        return originalList.Where(item => item.ToLower().Contains(searchedText)).ToList();
    });

    // UI线程更新
    await Application.Current.Dispatcher.InvokeAsync(() =>
    {
        var itemsView = (CollectionView)CollectionViewSource.GetDefaultView(combobox.Items);
        itemsView.Filter = o => filteredItems.Contains((string)o);
        itemsView.Refresh();
        ctb.CaretIndex = caretPos;
    });
}

内容的提问来源于stack exchange，提问作者Michał Piasecki