WPF Prism6.0启动偶发跨线程集合绑定异常定位与排查方法

问题背景 #

• 基于Prism 6.0开发的WPF应用，包含多个集合数据展示界面，多数视图在应用启动阶段完成加载，后续按需显示
• 启动阶段偶发抛出异常，现有异常调用栈仅能判定为跨线程访问集合类错误，无有效定位信息，根因排查难度高
• 异常原始调用栈如下：

at System.ThrowHelper.ThrowArgumentOutOfRangeException(ExceptionArgument argument, ExceptionResource resource)
at System.Collections.Generic.List`1.get_Item(Int32 index)
at System.Collections.ObjectModel.Collection`1.get_Item(Int32 index)
at System.Collections.ObjectModel.ReadOnlyCollection`1.System.Collections.ICollection.CopyTo(Array array, Int32 index)
at System.Collections.ArrayList.InsertRange(Int32 index, ICollection c)
at System.Collections.ArrayList.AddRange(ICollection c)
at System.Collections.ArrayList..ctor(ICollection c)
at System.Windows.Data.ListCollectionView.<RefreshOverride>b__1_0()
at MS.Internal.Data.SynchronizationInfo.AccessCollection(IEnumerable collection, Action accessMethod, Boolean writeAccess)
at System.Windows.Data.BindingOperations.AccessCollection(IEnumerable collection, Action accessMethod, Boolean writeAccess)
at System.Windows.Data.ListCollectionView.RefreshOverride()
at System.Windows.Data.CollectionView.RefreshInternal()
at System.Windows.Data.CollectionView.RefreshOrDefer()
at System.Windows.Data.ListCollectionView.ProcessCollectionChanged(NotifyCollectionChangedEventArgs args)
at System.Windows.Data.CollectionView.ProcessChangeLog(ArrayList changeLog, Boolean processAll)
at System.Windows.Data.CollectionView.ProcessInvoke(Object arg)
at MS.Internal.Data.DataBindOperation.Invoke()
at MS.Internal.Data.DataBindEngine.ProcessCrossThreadRequests()
at System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs)
at System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler)

可落地排查方案 #

1. 调试器定向中断抓取现场 #

• 打开Visual Studio调试异常设置，勾选公共语言运行时异常中System.ArgumentOutOfRangeException的「引发时中断」选项（不要仅勾选用户未处理时中断），复现异常时调试器会直接停在异常抛出点
• 异常命中后，在调试器调用栈窗口切换到System.Windows.Data.ListCollectionView.RefreshOverride帧，通过监视窗口查看当前实例的SourceCollection属性：
  • 该属性值就是触发异常的原始集合实例，可直接获取集合的泛型参数确定元素类型
  • 顺着该集合的绑定链路向上溯源，可定位到对应的视图模型属性、绑定的UI控件

2. 开启WPF绑定诊断日志 #

• 为绑定系统开启高等级诊断跟踪，异常触发时VS输出窗口会直接打印对应集合绑定的源对象、属性路径，无需手动遍历所有绑定
• 针对启动阶段预加载的视图，临时在所有绑定到UI的集合属性setter、CollectionChanged事件入口添加断点，记录每次触发操作的线程ID，和UI线程ID做比对，非UI线程触发集合修改且未做线程调度的位置就是直接问题点

3. 自定义集合封装做线程校验 #

• 对项目中所有绑定到UI的ObservableCollection<T>做统一子类封装，重写所有修改集合的方法（Add/Remove/Clear/Insert/RemoveAt等）以及OnCollectionChanged触发逻辑，在入口处校验当前线程是否持有UI线程调度权限：

public class ThreadSafeObservableCollection<T> : ObservableCollection<T>
{
    protected override void OnCollectionChanged(NotifyCollectionChangedEventArgs e)
    {
        if (!Application.Current.Dispatcher.CheckAccess())
        {
            // 此处添加条件断点，命中时可直接查看调用栈、集合类型、当前修改操作
            throw new InvalidOperationException($"类型为{typeof(T).FullName}的集合被非UI线程非法访问");
        }
        base.OnCollectionChanged(e);
    }

    // 其他集合修改方法同理添加线程校验逻辑
}

• 该方案可在非法跨线程访问发生的第一时间命中断点，不会等到WPF绑定引擎异步处理跨线程请求时才抛异常，避免原始触发点的调用栈丢失

4. Prism 6.0 特定场景排查 #

• 检查模块初始化逻辑：Prism模块初始化如果采用后台线程并行执行，初始化过程中直接修改绑定到UI的集合、未调度到UI线程，是启动阶段该类异常的高频触发点
• 检查事件聚合器订阅逻辑：如果事件订阅使用ThreadOption.PublisherThread选项，后台线程发布事件时，订阅方法直接修改UI绑定集合就会触发跨线程问题，启动阶段后台预加载数据触发事件的场景需重点排查
• 检查异步回调逻辑：视图模型构造函数、INavigationAware接口实现中发起的异步任务（数据拉取、配置读取等），如果在回调中直接修改集合、未通过Dispatcher切回UI线程，也会触发该问题

异常根因说明 #

给出的调用栈无法直接定位问题，是因为异常抛出时机滞后：非UI线程修改集合后，CollectionChanged事件会被调度到UI线程异步执行，调度过程中后台线程可能再次修改集合，导致ListCollectionView内部缓存的变更日志索引和实际集合长度不匹配，最终抛出索引越界异常，此时调用栈已经完全丢失了最初触发非法修改的非UI线程调用链路。

内容的提问来源于stack exchange，提问作者Pramod B R