解決?WPF?綁定集合后數據變動界面卻不更新的問題

獨立觀察員 2020 年 9 月 9 日

?

在 .NET Core 3.1 的?WPF?程序中打算用?ListBox?綁定顯示一個集合（滿足需求即可，無所謂什么類型的集合），以下是 Xaml 代碼（瞟一眼就行，不是本文討論重點）：

<ListBox ItemsSource="{Binding SipRegistrations, Mode=OneWay}" SelectedValue="{Binding SelectedAccountBinding, Mode=OneWayToSource}"><ListBox.ItemTemplate><DataTemplate><TextBlock Text="{Binding SIPAccount.SIPUsername}"></TextBlock></DataTemplate></ListBox.ItemTemplate> </ListBox>

?

ViewModel 中有一個目標集合，當前是一個?List。

屬性變動通知有兩種實現方式，一是使用 PropertyChanged.Fody，二是使用自定義綁定基類 BindableBase，如下圖。

?

下面主要談論數據變動（集合增加內容）后，前臺的界面卻沒有更新的問題。具體來說就是，List.Add 之后，第一次有效果，但后面就沒效果了，界面始終只顯示一條數據。

?

原始（無效果）：

SipRegistrations.RemoveAll(x => x.SIPAccount.SIPUsername == sipAccount.SIPUsername); // 移除重復項（如果有的話） SipRegistrations.Add(binding); // 添加新項

猜想是因為 List 的引用并沒有變化，所以被認為該屬性沒有改變，進而也就沒有變動通知。

其實這種需要變動通知的情況，推薦使用的是?ObservableCollection：

?

但是本人之前使用?ObservableCollection?沒有成功過，反而是使用 List 是可以的，所以還是先看看用 List 怎么解決吧。

?

變體一（調試時有幾率有效果）：

// 添加聯系人到集合并處理界面綁定； SipRegistrations.RemoveAll(x => x.SIPAccount.SIPUsername == sipAccount.SIPUsername); List<SIPAccountBinding> tempList = SipRegistrations; // 臨時集合； SipRegistrations = new List<SIPAccountBinding>(); // 目標集合先置為空； tempList.Add(binding); // 臨時集合添加新項； SipRegistrations = tempList; // 臨時集合賦值給目標集合；

變體一通過臨時變量做中轉，強制讓目標集合（的引用）發生改變，但結果是只在調試時以很小的概率成功過。

由于這部分代碼是在異步邏輯里，所以有可能是在多線程環境，而 List 不是線程安全的，所以有了以下加鎖版本的變體二。

?

變體二（無效果，應該是和變體一類似）：

#region 成員/// <summary> /// 加鎖對象 /// </summary> private object _lockObj = new object();#endregion// 加鎖； lock (_lockObj) {// 添加聯系人到集合并處理界面綁定；SipRegistrations.RemoveAll(x => x.SIPAccount.SIPUsername == sipAccount.SIPUsername);List<SIPAccountBinding> tempList = SipRegistrations;SipRegistrations = new List<SIPAccountBinding>();tempList.Add(binding);SipRegistrations = tempList; }

?

加了鎖還是不行（不過鎖還是需要的），又想到，既然調試的時候有幾率成功，那么是不是和代碼運行速度有關呢？于是在目標集合置空和重新賦值之間加了個線程休眠，竟然真的可以，也就是以下的變體三。

?

變體三（有效果）：

lock (_lockObj) {// 添加聯系人到集合并處理界面綁定；SipRegistrations.RemoveAll(x => x.SIPAccount.SIPUsername == sipAccount.SIPUsername);List tempList = SipRegistrations;SipRegistrations = new List();Thread.Sleep(500); // 關鍵代碼；tempList.Add(binding);SipRegistrations = tempList; }

?

好了，以上就是解決方法了。

?

接下來再嘗試一下 ObservableCollection 吧：

#region 成員/// <summary> /// 加鎖對象 /// </summary> private object _lockObj = new object();public ObservableCollection<SIPAccountBinding> SipRegistrations { get; set; } = new ObservableCollection<SIPAccountBinding>();#endregionlock (_lockObj) {SipRegistrations.Remove(SipRegistrations.FirstOrDefault(x => x.SIPAccount.SIPUsername == sipAccount.SIPUsername));SipRegistrations.Add(binding); // 情況一//SipRegistrations.Append (binding); // 情況二 }Console.WriteLine($" 注冊聯系人 [{binding.RegisteredContact}] 為 [{sipAccount.SIPUsername}].");

?

這個有兩種情況（都不能成功）：

情況一，使用 Add 方法，結果是執行完 Add 方法后就返回了，后面的方法不再執行（不知道為什么），界面上是有幾率能添加一條。

情況二，使用 Append 方法，執行完 Append 后倒是可以繼續執行后面的代碼，但是界面上一條也出現不了。

?

后記：本文主要是拋磚引玉，大家有什么更好的方法，或者能解釋文中所描述現象的原理，請不吝賜教。

項目地址：https://gitee.com/DLGCY_GB28181/SimpleSIPServer

---

更新（20200909）：

經過在 https://dotnet9.com/?站長的技術討論群的討論，決定還是要使用 ObservableCollection。加上在網上搜到了文章《WPF ViewModel 中對 ObservableCollection 集合操作》，所以最終代碼為：

#region 成員/// <summary> /// 加鎖對象 /// </summary> private object _lockObj = new object();/// <summary> /// 集合對象 /// </summary> public ObservableCollection<SIPAccountBinding> SipRegistrations { get; set; } = new ObservableCollection<SIPAccountBinding>();#endregionlock (_lockObj) {ThreadPool.QueueUserWorkItem(delegate{SynchronizationContext.SetSynchronizationContext(new System.Windows.Threading.DispatcherSynchronizationContext(Application.Current.Dispatcher));SynchronizationContext.Current?.Post(pl =>{SipRegistrations.Remove(SipRegistrations.FirstOrDefault(x => x.SIPAccount.SIPUsername == sipAccount.SIPUsername));SipRegistrations.Add(binding);}, null);}); }Console.WriteLine($" 注冊聯系人 [{binding.RegisteredContact}] 為 [{sipAccount.SIPUsername}].");

?

甚至還可以簡化：

Application.Current.Dispatcher.Invoke(delegate {SipRegistrations.Remove(SipRegistrations.FirstOrDefault(x => x.SIPAccount.SIPUsername == sipAccount.SIPUsername));SipRegistrations.Add(binding); });

?

總結

以上是生活随笔為你收集整理的解决 WPF 绑定集合后数据变动界面却不更新的问题（使用 ObservableCollection）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。