调用dispatchUpdatesTo时RecyclerView自动滚动至顶部的问题排查

在使用DiffUtil计算列表差异并调用dispatchUpdatesTo方法时，即便保存并恢复RecyclerView的滚动状态，列表仍会自动滚动到顶部。移除线程切换操作后，该问题消失。相关代码如下：

compositeDisposable.clear()
compositeDisposable += Single.fromCallable {
    DiffUtil.calculateDiff(diffUtilCallback(items, newItems))
}.subscribeOn(Schedulers.computation())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(
        Consumer {
            this.items.clear()
            this.items.addAll(newItems)
            it.dispatchUpdatesTo(this)
        }
    )

问题原因 #

1. 线程安全与数据集冲突：在子线程计算DiffUtil结果时，主线程的原数据集items可能被意外修改，或者DiffUtil基于的原数据和最终更新到主线程的数据集存在时间差，导致DiffResult的差异计算与实际数据更新不匹配，触发全量刷新。
2. 全量数据替换的影响：直接在回调中clear()原数据集再addAll()新数据，相当于全量替换数据集，即便DiffUtil计算了差异，这种操作也可能让DiffResult的局部更新失效，触发RecyclerView的全量重新布局，导致滚动位置丢失。
3. DiffUtilCallback实现不当：如果areItemsTheSame或areContentsTheSame方法判断逻辑错误，DiffUtil会认为所有item都发生了变化，从而触发全量刷新，滚动位置自然会重置到顶部。

解决方案 #

1. 保证DiffUtil计算时的数据集线程安全

在子线程计算DiffResult前，先创建原数据集的快照，避免主线程修改原数据导致的计算偏差：

compositeDisposable.clear()
compositeDisposable += Single.fromCallable {
    // 生成原数据集的快照，避免线程冲突
    val oldItemsSnapshot = ArrayList(items)
    val diffResult = DiffUtil.calculateDiff(MyDiffUtilCallback(oldItemsSnapshot, newItems))
    // 传递DiffResult和新数据的副本
    Pair(diffResult, ArrayList(newItems))
}.subscribeOn(Schedulers.computation())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(
        Consumer { (diffResult, newItemsCopy) ->
            // 更新数据集
            this.items.clear()
            this.items.addAll(newItemsCopy)
            // 触发差异更新
            diffResult.dispatchUpdatesTo(this)
        }
    )

2. 正确实现DiffUtilCallback

确保areItemsTheSame使用item的唯一标识判断，areContentsTheSame准确对比item内容：

class MyDiffUtilCallback(
    private val oldList: List<YourItemType>,
    private val newList: List<YourItemType>
) : DiffUtil.Callback() {
    override fun getOldListSize() = oldList.size
    override fun getNewListSize() = newList.size

    override fun areItemsTheSame(oldItemPos: Int, newItemPos: Int): Boolean {
        // 使用item的唯一ID判断是否为同一对象
        return oldList[oldItemPos].id == newList[newItemPos].id
    }

    override fun areContentsTheSame(oldItemPos: Int, newItemPos: Int): Boolean {
        // 对比item的所有内容字段，确保内容一致时不触发更新
        val oldItem = oldList[oldItemPos]
        val newItem = newList[newItemPos]
        return oldItem.title == newItem.title && oldItem.content == newItem.content
    }
}

3. 手动保存并恢复滚动状态（可选）

如果上述方法仍无法解决，可在数据更新前后手动保存和恢复滚动状态：

Consumer { (diffResult, newItemsCopy) ->
    val layoutManager = recyclerView.layoutManager as LinearLayoutManager
    // 保存当前滚动位置和偏移量
    val firstVisiblePos = layoutManager.findFirstVisibleItemPosition()
    val itemTopOffset = layoutManager.findViewByPosition(firstVisiblePos)?.top ?: 0

    // 更新数据集并触发差异更新
    this.items.clear()
    this.items.addAll(newItemsCopy)
    diffResult.dispatchUpdatesTo(this)

    // 等待RecyclerView布局完成后恢复滚动状态
    recyclerView.post {
        layoutManager.scrollToPositionWithOffset(firstVisiblePos, itemTopOffset)
    }
}

内容的提问来源于stack exchange，提问作者Sreelakshmi C