RecyclerView中DiffUtil的一些注意事项

在Android开发中，一个耳熟能详的方法就是 notifyDataSetChanged ，在适配器（Adapter）的设计模式下，每当我们的列表数据发生变更时，就需要调用此方法来更新UI。然而，这个方法并不“ 节能 ”，它会同时刷新列表中的所有item，包括那些并没有变化的数据，这样就带来很多计算资源的浪费。要知道，从你的一个 setText 或者 setImageResource 方法调用到最终呈现到屏幕上，软件到硬件，中间经历了非常复杂的过程。基于能省则省的移动开发原则，有没有更好的办法呢？

这样做的好处就是避免了不必要的UI更新，DiffUtil计算出差异之后，只刷新产生变动的item。具体地，我们可以在Adapter的 onBindViewHolder 方法打断点或者日志观察，或者调用 registerAdapterDataObserver 方法监听item的各种操作情况。其次，以前的 notifyDataSetChanged 方法由于会刷新整个列表所以没有原生的动画效果，而DiffUtil内部最终调用了各种 notifyItemXXX 方法。

DiffUtil的使用也很简单：

1、先实现比较新旧数据的回调，可以是一个独立的类，也可以写成Adapter的内部类：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

public class BaseXXXAdapter<T> extends RecyclerView.Adapter {
    // ...

    private class DiffCallback extends DiffUtil.Callback {
        private List<T> oldData, newData;

        DiffCallback(List<T> oldData, List<T> newData) {
            this.oldData = oldData;
            this.newData = newData;
        }

        @Override
        public int getOldListSize() {
            return oldData.size();
        }

        @Override
        public int getNewListSize() {
            return newData.size();
        }

        @Override
        public boolean areItemsTheSame(int oldItemPosition, int newItemPosition) {
            T oldT = oldData.get(oldItemPosition);
            T newT = newData.get(newItemPosition);
            // 实际情况最好是在此处对比新旧数据的id（比如用户uid），这里为了方便示例直接equals对象了
            // 若此处返回true，则DiffUtil会再调用下面的areContentsTheSame方法，进一步对比UI是否有变化
            // 若此处返回false，则说明id都不同，肯定不是一个item
            return Objects.equals(oldT, newT);
        }

        @Override
        public boolean areContentsTheSame(int oldItemPosition, int newItemPosition) {
            // TODO 比较新旧数据（主要是UI展示内容）是否相同，这里为了方便示例直接返回true
            return true;
        }
    }
}

2、然后在Adapter内部实现一个update数据的方法：

1
2
3
4
5
6
7
8

@Override
public void updateData(List<T> newData) {
    DiffUtil.DiffResult result = DiffUtil.calculateDiff(new DiffCallback(getData(), newData));
    // 这里的getData即表示获取整个列表的数据，自行实现即可
    getData().clear();
    getData().addAll(newData);
    result.dispatchUpdatesTo(this);
}

注意这里的 dispatchUpdatesTo 可以在clear之前，也可以在addAll之后，实际效果暂未发现什么区别，之前查阅资料包括官方示例也都是最后执行dispatch，姑且认为这样算标准吧。

3、……咦，怎么才两步，确实就这么简单。重点还是 areItemsTheSame 和 areContentsTheSame 方法，后者大部分时候只需要对比每个item上UI展示出来的数据即可，因为用户只关心眼见的内容。

举个例子，一个通讯录列表里面有 [小明, 小红] 两个人，对应内存地址为 **[a1, a2]**，现在通过上述 updateData 方法更新了通讯录列表，UI内容变成了 **[小王, 小红]**，对应内存地址为 [b1, b2] 。对用户来说小红这个item看上去没有发生变化，但其实对应的数据类对象已经不同。 而且此时 onBindViewHolder 方法只会触发一次，将小明更新成小王，而不会触发小红那个position对应的 onBindViewHolder 。

上述细节很关键，如果开发过程中绑定（bind）数据 不恰当 的话，就容易造成各种奇异问题，比如网上资料最多的DiffUtil导致item点击事件数据错位问题、数组越界崩溃问题等等。

这里的“不恰当”，绝大部分情况下，总结出来：其实指的就是在 onBindViewHolder 方法中持有了某个位置（position）对应数据的不可变对象。最常见的误用示例就是在 onBindViewHolder 中设置某些控件的点击事件并引用数据对象：

1
2
3
4
5
6
7
8
9
10
11

// 此处假设item的数据类为User
@Override
public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
    MyItemViewHolder h = (MyItemViewHolder) holder;
    User user = getData().get(position);
    h.mNameTextView.setOnClickListener(v -> {
        // 第2种写法：User user = getData().get(position);
        // 假设这里是点击item跳转到该User对应的个人主页界面
        startWebView(user.getHomePageUrl());
    });
}

在不接入DiffUtil之前，上面这段代码没有任何问题，因为我们都是使用 notifyDataSetChanged 方法来更新UI，每次更新调用到 onBindViewHolder 时，点击事件都会重新设置，get出来的user对象自然也是最新的。一旦我们使用了DiffUtil，就会出问题了。

回到上面小王绿了小明的例子，在我们的 updateData 方法执行后，如果我们只对比了user的名字这个属性（其实也只需要对比这个属性），那么小红那一个item就不会触发对应的 onBindViewHolder ，即小红的点击事件回调里， 仍然持有着旧数据集的user对象（对应那个内存地址a2） 。但实际上小红应该对应 b2 那个内存了，这就造成 a2 内存无法释放，问题是不是显得有点严重了。

有同学说无所谓呀，反正点击事件依然有效。那如果我说网络数据刷新下来小红的 homePageUrl 变了呢？是不是还得把这个属性加入DiffUtil的对比方法中？这样最终会导致小红的 onBindViewHolder 方法也执行，跟 notifyDataSetChanged 岂不是没什么两样了？

此外，若get对象写成注释中的第2种写法，且列表第0个位置的item被删了呢？小红顶上去变成了第0个，此时由于小红的UI内容没变，只是位置变了，所以 onBindViewHolder 依然不会执行。以上面的示例代码来看，当再次点击小红时，就会直接出现数组越界的异常。因为position还是之前的1，而此时小红的position已经为0。

显然上述出现的这些问题不符合谷歌的设计初衷，也不符合我们使用DiffUtil的初衷。其实 解决办法 很简单，就是要对 onBindViewHolder 方法有一个正确的认知，其原则就是：