深入瞭解WPF中ObservableCollection及跨線程處理ObservableCollection

WPF的ObservableCollection在增刪改的時候，通過繼承INotifyCollectionChanged使用CollectionChanged通過依賴屬性發生了變化。（本篇的例子從：https://blog.lindexi.com/post/win10-uwp-%E9%80%9A%E7%9F%A5%E5%88%97%E8%A1%A8.html、  https://blog.lindexi.com/post/WPF-%E5%A4%9A%E7%BA%BF%E7%A8%8B%E4%B8%8B%E8%B7%A8%E7%BA%BF%E7%A8%8B%E5%A4%84%E7%90%86-ObservableCollection-%E6%95%B0%E6%8D%AE.html  中引用 ）

public class FooList<T> : Collection<T>, INotifyCollectionChanged
{
    protected override void InsertItem(int index, T item)
    {
        base.InsertItem(index, item);

        Application.Current.Dispatcher.InvokeAsync(() =>
        {
            CollectionChanged?.Invoke(this,
          new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Add, item, index));
        });
    }

    protected override void RemoveItem(int index)
    {
        var item = this[index];

        base.RemoveItem(index);

        Application.Current.Dispatcher.InvokeAsync(() =>
        {
            CollectionChanged?.Invoke(this,
          new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Remove, item, index));
        });
    }

    protected override void SetItem(int index, T item)
    {
        var oldItem = this[index];
        base.SetItem(index, item);
        Application.Current.Dispatcher.InvokeAsync(() =>
        {
            CollectionChanged?.Invoke(this,
          new NotifyCollectionChangedEventArgs(NotifyCollectionChangedAction.Replace, item, oldItem, index));
        });
    }

    public event NotifyCollectionChangedEventHandler? CollectionChanged;
}

從上面的例子可以看出，ObservableCollection集合是不需要再進行屬性通知的，所以下麵的寫法是不需要的

        public ObservableCollection<string> ObservableCollection
        {
            set
            {
                _observableCollection = value;
                OnPropertyChanged();
            }
            get
            {
                return _observableCollection;
            }
        }

        private ObservableCollection<string> _observableCollection;

在跨線程處理 ObservableCollection 數據，大多數時候都會拋出 System.NotSupportedException:“該類型的 CollectionView 不支持從調度程式線程以外的線程對其 SourceCollection 進行的更改。” 等異常。原因是ObservableCollection 是非線程安全的，因此所以在單一的時刻，只能有一個線程進行處理。如果 ObservableCollection 被 UI 元素捕獲，例如加入到 ItemsSource 裡面，那麼此時的 ObservableCollection 不僅只能被單一線程處理，還要求這個線程是 UI 線程。針對以上情況，採取3中辦法處理。

1、現在後臺線程處理完ObservableCollection，再賦值給 ListView 的 ItemsSource 屬性，實現更新界面邏輯。

private async void Button1_Click(object sender, RoutedEventArgs e)
    {
        var list = await Task.Run(() =>
        {
            ObservableCollection<string> data = new ObservableCollection<string>();
            for (int i = 0; i < 100; i++)
            {
                data.Add(Random.Shared.Next(1000).ToString());
            }
            return data;
        });

        // 以上代碼使用 await 等待，可以自動切回主線程

        ListView.ItemsSource = list;
    }

2、在確保 UI 線程不會改動到 ObservableCollection 列表的時候，可以採用如下方法，在後臺線程拷貝一份作為新的 ObservableCollection 對象，然後對此新的對象進行處理。完成之後，再將新的 ObservableCollection 對象賦值給到 UI 進行綁定。

private async void Button2_Click(object sender, RoutedEventArgs e)
    {
        // 假定 ListView.ItemsSource 存在源了
        if (ListView.ItemsSource is not ObservableCollection<string> list)
        {
            // 如果假設失敗，強行給一個源
            list = new();
            ListView.ItemsSource = list;
        }

        var newList = await Task.Run(() =>
        {
            var data = new ObservableCollection<string>(list);

            // 模擬對原有的列表進行處理
            if (data.Count > 0)
            {
                for (int i = 0; i < 100; i++)
                {
                    data.Move(Random.Shared.Next(data.Count), Random.Shared.Next(data.Count));
                }
            }

            return data;
        });

        ListView.ItemsSource = newList;
    }

3、第三個方法是自己實現一個類似 ObservableCollection 的類型。例子就是開篇的Foolist類，但是缺點就是在通知 UI 線程集合變更之後，剛好 UI 線程去讀取此集合新的值的時候，集合本身就被其他線程更改了內容，那麼此時的邏輯就不是符合預期的。