Bug系列之onFailedToRecycleView引发的诡异问题

发表于 更新于 评论： 阅读次数：

项目中遇到一个RecyclerView相关的诡异问题，跟到最后发现问题根本原因是View复用失败。RecyclerView.onFailedToRecycleView()方法用于处理View复用失败的情况，我们通常不会关注到这个方法。本文介绍了其用法。

问题描述

页面结构如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
<XRecyclerView>
    <RefreshHeader />

    <ContentHeader>
        <View />
        <View />
        <弹幕 />
    </ContentHeader>

    <RecyclerViewItem />

    <RecyclerViewItem />
</XRecyclerView>
  1. 最外层的XRecyclerView继承自RecyclerView
  2. RefreshHeader由XRecyclerView自动添加，以支持下拉刷新
  3. ContentHeader中的弹幕控件使用RecyclerView实现。数据条数多于4条时循环播放弹幕，少于3条时播放完成后逐渐隐藏

问题现象：当滚动列表到底部再回到顶部时，<ContentHeader>错乱，变成了一个空的RecyclerViewItem。但也不一定要滚动到底部，只要弹幕移出可见区域，问题就可能发生。

注意，上面的结构中使用了嵌套RecyclerView。这也许是个坑。

一开始百思不得奇解，凭经验认为应该是RecyclerView中View复用的问题。但怪就怪在为什么ContentHeader会变成RecyclerViewItem。

另外我还注意到：

  1. 弹幕循环播放时，问题不复现
  2. RecyclerViewItem数量为0时，问题不复现

问题分析

打印日志看一下。(好吧，其实在准确的位置打印日志并展开分析之前我各种折腾浪费了不少时间)

1
2
3
4
5
6
7
8
9
@Override
public int getItemViewType(int position) {
    ...
}

@Override
public ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
    System.out.println("onCreateViewHolder viewType=" + viewType);
}

发现两个不符合预期的地方：

  1. 日志输出为onCreateViewHolder viewType=10002，而10002并不是我们自己在getItemViewType(int position)中定义的。10002从哪里来？
  2. onCreateViewHolder viewType=10002会输出两次。为什么onCreateViewHolder调用两次？

10002从哪里来

这要从XRecyclerView特性说起来。XRecyclerView继承自RecyclerView，支持header和footer，有点类似于ListView。

Google官方明确地从RecyclerView中移除了对header和footer的支持。不知到底是为了保持API简单(移除长尾特性)，还是说明支持header和footer是不好的设计，因为特殊item完全也能实现header和footer，当然实现起来不如直接支持header和footer来得方便。RecyclerView ins and outs - Google I/O 2016

这里只就header展开分析，footer情况类似。直接上代码。

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 void addHeaderView(View view) {
    if (pullRefreshEnabled && !(mHeaderViews.get(0) instanceof ArrowRefreshHeader)) {
        ArrowRefreshHeader refreshHeader = new ArrowRefreshHeader(mContext);
        mHeaderViews.add(0, refreshHeader);
        mRefreshHeader = refreshHeader;
        mRefreshHeader.setProgressStyle(mRefreshProgressStyle);
    }
    mHeaderViews.add(view);
    sHeaderTypes.add(HEADER_INIT_INDEX + mHeaderViews.size());
}

@Override
public void setAdapter(Adapter adapter) {
    mAdapter = adapter;
    mWrapAdapter = new WrapAdapter(mHeaderViews, mFootViews, adapter);
    super.setAdapter(mWrapAdapter);
    mAdapter.registerAdapterDataObserver(mDataObserver);
    mDataObserver.onChanged();
}

private class WrapAdapter extends RecyclerView.Adapter<ViewHolder> {
    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        if (viewType == TYPE_REFRESH_HEADER) {
            mCurrentPosition++;
            return new SimpleViewHolder(mHeaderViews.get(0));
        } else if (isContentHeader(mCurrentPosition)) {
            if (viewType == sHeaderTypes.get(mCurrentPosition - 1)) {
                mCurrentPosition++;
                View view = mHeaderViews.get(headerPosition++);
                return new SimpleViewHolder(view);
            }
        } else if (viewType == TYPE_FOOTER) {
            return new SimpleViewHolder(mFootViews.get(0));
        }
        return adapter.onCreateViewHolder(parent, viewType);
    }
}
  • XRecyclerView.addHeaderView()方法用于添加头部，XRecyclerView会持有作为header的View
  • XRecyclerView.setAdapter()是关键所在，它会将原始的Adapter包装成WrapAdapter
  • WrapAdapter的特别之处在于它为header创建SimpleViewHolder，非header则代理给原始的Adapter

上面最后一点，可以解释我们遇到的问题。可能因为某种原因，有个header没被正确地识别出来，结果走到了return adapter.onCreateViewHolder(parent, viewType)这个分支。于是我们的自己的Adapter中看到了10002这个预期外的viewType。

再来看为什么XRecyclerView的header没被正确地识别出来。WrapAdapter.onCreateViewHolder()方法对mCurrentPosition的计算很有问题。想象一下，如果onCreateViewHolder()被重复调用，mCurrentPosition会是什么结果。我原以为这是个bug，但仔细想想，考虑到header数量的不确定性，好像找不到更好的方式来计算mCurrentPosition。

联系起来思考：可能是onCreateViewHolder()被多次调用导致mCurrentPosition不对，进一步导致header没有被识别出来，最终引起后面的一系列错误。

为什么onCreateViewHolder调用两次

onCreateViewHolder()通常只为每个位置调用一次，调用后创建出来的ViewHolder可回收复用。

那有没有异常情况呢？在网上搜到了RecyclerView.Adapter.onFailedToRecycleView(ViewHolder holder)方法，看名字知道可能是处理异常情况的。

onFailedToRecycleView

Called by the RecyclerView if a ViewHolder created by this Adapter cannot be recycled due to its transient state. Upon receiving this callback, Adapter can clear the animation(s) that effect the View’s transient state and return true so that the View can be recycled. Keep in mind that the View in question is already removed from the RecyclerView.
In some cases, it is acceptable to recycle a View although it has transient state. Most of the time, this is a case where the transient state will be cleared in onBindViewHolder(RecyclerView.ViewHolder, int) call when View is rebound to a new position. For this reason, RecyclerView leaves the decision to the Adapter and uses the return value of this method to decide whether the View should be recycled or not.
Note that when all animations are created by RecyclerView.ItemAnimator, you should never receive this callback because RecyclerView keeps those Views as children until their animations are complete. This callback is useful when children of the item views create animations which may not be easy to implement using an RecyclerView.ItemAnimator.
You should never fix this issue by calling holder.itemView.setHasTransientState(false); unless you’ve previously called holder.itemView.setHasTransientState(true);. Each View.setHasTransientState(true) call must be matched by a View.setHasTransientState(false) call, otherwise, the state of the View may become inconsistent. You should always prefer to end or cancel animations that are triggering the transient state instead of handling it manually.

翻译一下

如果当前Adapter创建的ViewHolder由于其临时状态不能被回收复用，则RecyclerView会调用onFailedToRecycleView方法。Adapter可以在这个回调方法中清理影响/导致ViewHolder临时状态的动画并返回true。返回true可以让View被回收复用。但要注意，这个有问题的View此时已经从RecyclerView中移除。
某些情况下，一些View虽然有临时状态但仍然可被回收复用。大多数时候，这些临时状态会在当前View绑定到新的位置 时由onBindViewHolder(RecyclerView.ViewHolder, int)给清理掉。所以RecyclerView把决定权留给Adapter，并使用onFailedToRecycleView()方法的返回值作为View是否被回收的依据。
注意，所有由RecyclerView.ItemAnimator创建的动画，都不会导致onFailedToRecycleView()调用，因为RecyclerView会一直保留带这种动画的View直到动画完成。onFailedToRecycleView()回调对于处理那些创建复杂动画的View非常有效。这里的复杂动画指的是那些无法用RecyclerView.ItemAnimator实现的动画
注意，你不能简单地调用holder.itemView.setHasTransientState(false);来避免这个问题，除非你之前调用过holder.itemView.setHasTransientState(true);。每个View.setHasTransientState(true)调用必须跟View.setHasTransientState(false)调用配对，否则View的状态不一致。你通常应当结束或取消引起View临时状态的动画，而不是手动调用View.setHasTransientState(false)来应对这种情况

文档说得很明白，onFailedToRecycleView(ViewHolder holder)是View不能被RecyclerView回收复用时的回调方法。我们可以在这个方法清理View的临时状态。

  1. ContentHeader是否无法被回收？
  2. 什么原因导致ContentHeader无法被回收？弹幕的动画吗?

在WrapAdapter.onFailedToRecycleView()中打印日志，发现该方法果然被调用了，证明ContentHeader回收失败，所以下次使用ContentHeader会重新创建而不是直接绑定数据。这解释了为什么onCreateViewHolder()调用两次。

弹幕条数多于4条时会循环播放，少于3条时播放完成后逐渐隐藏。前者是使用RecyclerView.ItemAnimator实现的，而后者是自定义动画。根据文档，正是这里的自定义动画导致ContentHeader不能被回收。

1
2
3
4
5
6
7
8
9
10
11
@Override
public boolean onFailedToRecycleView(ViewHolder holder) {
    System.out.println("create 10002: onFailedToRecycleView");
    return super.onFailedToRecycleView(holder);
}

@Override
public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
    if (viewType == 10002) {
        System.out.println("create 10002");
}
1
2
3
4
02-21 11:36:13.462 15618-15618/com.tencent.PmdCampus I/System.out: create 10002
02-21 11:36:20.022 15618-15618/com.tencent.PmdCampus I/System.out: create 10002
02-21 11:36:23.802 15618-15618/com.tencent.PmdCampus I/System.out: create 10002: onFailedToRecycleView
02-21 11:36:23.812 15618-15618/com.tencent.PmdCampus I/System.out: create 10002

解决方法

找到原因之后，问题其实就解决了一半。解决方法是重写WrapAdapter.onFailedToRecycleView()方法，代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
@Override
public boolean onFailedToRecycleView(ViewHolder holder) {
    if (holder instanceof WrapAdapter.SimpleViewHolder) {
        WrapAdapter.SimpleViewHolder h = (SimpleViewHolder) holder;
        BBViewImpl v = (BBViewImpl) h.itemView.findViewById(R.id.bb);
        if (v != null) {
            // 清理动画
            v.stop();
        }
        return true;
    }
    return super.onFailedToRecycleView(holder);
}

界面错乱问题解决！

总结

第一，注意RecyclerView中View的动画可能导致出现临时状态。对于有临时状态的View，RecyclerView默认是不回收的

第二，我们在使用RecyclerView时通常只关注onCreateViewHolder()和onBindViewHolder()，但必要时也应关注onFailedToRecycleView()方法。某些诡异的UI问题很可能源于View无法回收，此时不妨在这个回调方法中加些错误日志来快速诊断一下