每日一问 | 关于 RecyclerView$Adapter setHasStableIds(boolean)的一切

先来了解下这个方法是用来做什么的：

官方文档的解释是，如果set为true则表示每个Item都是唯一的。

好叭，这个描述好像没什么帮助，还是来看代码吧：

public void setHasStableIds(boolean hasStableIds) {
    if (hasObservers()) {
        throw new IllegalStateException("Cannot change whether this adapter has "
                + "stable IDs while the adapter has registered observers.");
    }
    mHasStableIds = hasStableIds;
}

它这里只是把参数赋值给mHasStableIds而已，与之对应的是hasStableIds方法：

public final boolean hasStableIds() {
    return mHasStableIds;
}

在RecyclerView源码中搜 .hasStableIds() 会看到一共有14处用到了这个方法，我们重点看两个地方：

private void scrapOrRecycleView(Recycler recycler, int index, View view) {
    final ViewHolder viewHolder = getChildViewHolderInt(view);
    if (viewHolder.shouldIgnore()) {
        return;
    }
    if (viewHolder.isInvalid() && !viewHolder.isRemoved()
            && !mRecyclerView.mAdapter.hasStableIds()) {
        removeViewAt(index);
        recycler.recycleViewHolderInternal(viewHolder);
    } else {
        detachViewAt(index);
        recycler.scrapView(view);
        mRecyclerView.mViewInfoStore.onViewDetached(viewHolder);
    }
}

这个方法是用来回收ViewHolder的，通常会在RecyclerView重新布局子View时使用。

在之前的问题中【RecyclerView的多级缓存机制，每级缓存到底起到什么样的作用？】我们分析过，RecyclerView的缓存分两种：一种是数据还有效的，另一种则相反，是需要重新绑定数据的。那么刚好就对应了上面这个scrapOrRecycleView方法的逻辑：

如果这个ViewHolder已经被标记无效而且还没有从RecyclerView中移除的话，就会先移除，然后尝试把它put到RecycledViewPool里面去（当然了，里面还会进一步判断能不能放在mCachedViews中）。

否则呢，就先detach，然后放到mAttachedScrap或mChangedScrap中。

注意！！！那个if的条件里，还有个!mRecyclerView.mAdapter.hasStableIds()，也就是说，只要mHasStableIds为true，就算这个ViewHolder被标记无效，也不会扔到mCachedViews/RecycledViewPool中，而是放在mAttachedScrap/mChangedScrap里面！

有什么区别吗？

在上面提到的那个问题中也有解释：mAttachedScrap/mChangedScrap只在RecyclerView布局子View时使用，也就是它们的 “有效期” 是在RecyclerView的onLayout方法结束前，当子View布局完成之后，这两个集合都会被清空（进一步放到mCachedViews/RecycledViewPool中）。

所以可以断定，hasStableIds是跟重新布局子View有关。

好，我们接着来看下一个调用到hasStableIds方法的地方：

void markKnownViewsInvalid() {
    ......
    if (mAdapter == null || !mAdapter.hasStableIds()) {
        // we cannot re-use cached views in this case. Recycle them all
        recycleAndClearCachedViews();
    }
}

如果Adapter没有设置hasStableIds为true，就会调用recycleAndClearCachedViews方法：

void recycleAndClearCachedViews() {
    final int count = mCachedViews.size();
    for (int i = count - 1; i >= 0; i--) {
        recycleCachedViewAt(i);
    }
    mCachedViews.clear();
    ......
}

void recycleCachedViewAt(int cachedViewIndex) {
    ViewHolder viewHolder = mCachedViews.get(cachedViewIndex);
    addViewHolderToRecycledViewPool(viewHolder, true);
    mCachedViews.remove(cachedViewIndex);
}

emmmm，清空mCachedViews（把mCachedViews中所有ViewHolder都放到RecycledViewPool中）。

也就是说，当markKnownViewsInvalid方法被调用时，如果Adapter的hasStableIds不为true，那么当前RecyclerView的所有 "有效" 缓存都会被清空。

这个方法只在processDataSetCompletelyChanged中有使用：

void processDataSetCompletelyChanged(boolean dispatchItemsChanged) {
    ......
    markKnownViewsInvalid();
}

继续看processDataSetCompletelyChanged在哪里使用：

public void swapAdapter(@Nullable Adapter adapter, boolean removeAndRecycleExistingViews) {
    ......
    processDataSetCompletelyChanged(true);
    requestLayout();
}

public void setAdapter(@Nullable Adapter adapter) {
    ......
    processDataSetCompletelyChanged(false);
    requestLayout();
}

嗯，在重新设置Adapter时调用，完全合理。

等等，还有一个地方：

private class RecyclerViewDataObserver extends AdapterDataObserver {

    @Override
    public void onChanged() {
        ......
        processDataSetCompletelyChanged(true);
        if (!mAdapterHelper.hasPendingUpdates()) {
            requestLayout();
        }
    }

    ......

}

！！！！！

有同学可能已经知道了！这个onChanged会在AdapterDataObservable的notifyChanged方法中调用：

static class AdapterDataObservable extends Observable<AdapterDataObserver> {

    protected final ArrayList<T> mObservers = new ArrayList<T>();

    public void notifyChanged() {
        for (int i = mObservers.size() - 1; i >= 0; i--) {
            mObservers.get(i).onChanged();
        }
    }

    ......

}

而这个notifyChanged：

public abstract static class Adapter<VH extends ViewHolder> {

    public final void notifyDataSetChanged() {
        mObservable.notifyChanged();
    }

    ......

}

notifyDataSetChanged！！！

捋一捋：在默认情况下，调用Adapter的notifyDataSetChanged方法，对应RecyclerView的所有 "有效" 缓存都会变成 "无效" 缓存，也就是全部都要经过onBindViewHolder重新绑定一次数据。但如果Adapter的hasStableIds为true的话，则可以继续保留这些有效缓存。

notifyDataSetChanged时，有效缓存的保留与不保留，分别会有怎么样的效果呢？

来写个Demo看看叭：

我们在RecyclerView每次布局和滚动的前后，都打印一次各个缓存集合的元素，以及在Adapter中打印ViewHolder的Create、Bind、Recycle等情况。

最后给Item设置点击和长按事件：

override fun onBindViewHolder(holder: ViewHolder, position: Int) {
    ......
    holder.itemView.setOnClickListener {
        data.add(holder.adapterPosition + 1, "Appended " + data[holder.adapterPosition])
        notifyDataSetChanged()
    }
    holder.itemView.setOnLongClickListener {
        data.remove(data[holder.adapterPosition])
        notifyDataSetChanged()
        true
    }
}

点击Item后，会在下面新增一个Item，长按Item则删除。注意现在用的都是notifyDataSetChanged方法。

篇幅原因，其他代码先不贴了，有同学想要我再发出来。

好，现在运行看下效果：

先是没有setHasStableIds为true的新增Item：

看看log：

////////////////////////////////////
///               1
////////////////////////////////////
scrollVerticallyBy: -----------------------------------------------------------
scrollVerticallyBy: ------------------After scrollVerticallyBy-----------------
scrollVerticallyBy: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [Item 6, Item 7, Item 15],    mRecyclerPool: [],
scrollVerticallyBy: -----------------------------------------------------------
////////////////////////////////////
///               2
////////////////////////////////////
onViewRecycled: Item 15
onViewRecycled: Item 7
onViewRecycled: Item 6
onViewRecycled: -----------------------------------------------------------
onViewRecycled: ------------------After onViewRecycled-----------------
onViewRecycled: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [],    mRecyclerPool: [Item 15, Item 7, Item 6],
onViewRecycled: -----------------------------------------------------------
////////////////////////////////////
///               3
////////////////////////////////////
onLayoutChildren: -----------------------------------------------------------
onLayoutChildren: ------------------Before onLayoutChildren-----------------
onLayoutChildren: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [],    mRecyclerPool: [Item 15, Item 7, Item 6],
onLayoutChildren: -----------------------------------------------------------
onViewRecycled: Item 14
onViewRecycled: Item 13
onViewRecycled: Item 12
onViewRecycled: Item 11
onViewRecycled: Item 10
onViewRecycled: Item 9
onViewRecycled: Item 8
onViewRecycled: -----------------------------------------------------------
onViewRecycled: ------------------After onViewRecycled-----------------
onViewRecycled: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [],    mRecyclerPool: [Item 15, Item 7, Item 6, Item 14, Item 13],
onViewRecycled: -----------------------------------------------------------
////////////////////////////////////
///               4
////////////////////////////////////
onBindViewHolder: Item 13 ----------> Item 8
onBindViewHolder: Item 14 ----------> Item 9
onBindViewHolder: Item 6 ----------> Item 10
onBindViewHolder: Item 7 ----------> Appended Item 10
onBindViewHolder: Item 15 ----------> Item 11
onCreateViewHolder: Create ViewHolder
onBindViewHolder:  ----------> Item 12
onCreateViewHolder: Create ViewHolder
onBindViewHolder:  ----------> Item 13
////////////////////////////////////
///               5
////////////////////////////////////
onLayoutChildren: -----------------------------------------------------------
onLayoutChildren: ------------------After onLayoutChildren-----------------
onLayoutChildren: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [],    mRecyclerPool: [],
onLayoutChildren: -----------------------------------------------------------

稍微有点长，我们把它分为5部分：

1. 先看第1个：After scrollVerticallyBy，就是在RecyclerView处理完垂直滚动后打印的，可以看到这时候只有mCachedViews里面有3个Holder的缓存，其他三个都是空的；

2. 这里才是点击Item之后的逻辑，可以看到它连续回收了3个Holder，其实就是把mCachedViews的所有缓存，都移动到了mRecyclerPool中（跟我们上面分析的一样）；

3. 开始布局Item，这里同样会先回收一些Holder，与上面不同的是，这里是回收已经Attach到RecyclerView中的Holder，也就是正在显示的那些Item； 当所有Item都被回收之后，会看到mRecyclerPool已经满载了（默认情况下最多缓存数量是5个）；

4. 回收了Holder之后，接着就是拿出来重新绑定数据了，但是，此时mRecyclerPool中只有5个，实际上要Attach 7个到RecyclerView中，所以只能Create 2个Holder了；

5. 布局完成，会看到此时的4个缓存集合都是空的；

嗯，现在来看下长按删除：

log：

////////////////////////////////////
///               1
////////////////////////////////////
onLayoutChildren: -----------------------------------------------------------
onLayoutChildren: ------------------Before onLayoutChildren-----------------
onLayoutChildren: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [],    mRecyclerPool: [],
onLayoutChildren: -----------------------------------------------------------
onViewRecycled: Item 13
onViewRecycled: Item 12
onViewRecycled: Item 11
onViewRecycled: Appended Item 10
onViewRecycled: Item 10
onViewRecycled: Item 9
onViewRecycled: Item 8
onViewRecycled: -----------------------------------------------------------
onViewRecycled: ------------------After onViewRecycled-----------------
onViewRecycled: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [],    mRecyclerPool: [Item 13, Item 12, Item 11, Appended Item 10, Item 10],
onViewRecycled: -----------------------------------------------------------
////////////////////////////////////
///               2
////////////////////////////////////
onBindViewHolder: Item 10 ----------> Item 8
onBindViewHolder: Appended Item 10 ----------> Item 9
onBindViewHolder: Item 11 ----------> Appended Item 10
onBindViewHolder: Item 12 ----------> Item 11
onBindViewHolder: Item 13 ----------> Item 12
onCreateViewHolder: Create ViewHolder
onBindViewHolder:  ----------> Item 13
onCreateViewHolder: Create ViewHolder
onBindViewHolder:  ----------> Item 14
////////////////////////////////////
///               3
////////////////////////////////////
onLayoutChildren: -----------------------------------------------------------
onLayoutChildren: ------------------After onLayoutChildren-----------------
onLayoutChildren: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [],    mRecyclerPool: [],
onLayoutChildren: -----------------------------------------------------------

其实也跟刚刚的新增Item差不多，同样是先将所有ViewHolder扔到mRecyclerPool中，然后重新拿出来绑定数据，但是mRecyclerPool默认最大容量是5，一共需要7个Item，所以只能Create2个了。布局完成之后，RecyclerView的缓存依然是空的。

好，这次加上setHasStableIds(true)并重写getItemId方法：

init {
    setHasStableIds(true)
}

override fun getItemId(position: Int): Long = data[position].hashCode().toLong()

来看看效果：

！！！

居然有动画了！

看看log：

scrollVerticallyBy: -----------------------------------------------------------
scrollVerticallyBy: ------------------After scrollVerticallyBy-----------------
scrollVerticallyBy: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [Item 22, Item 23, Item 31],    mRecyclerPool: [Item 6],
scrollVerticallyBy: -----------------------------------------------------------
onLayoutChildren: -----------------------------------------------------------
onLayoutChildren: ------------------Before onLayoutChildren-----------------
onLayoutChildren: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [Item 22, Item 23, Item 31],    mRecyclerPool: [Item 6],
onLayoutChildren: -----------------------------------------------------------
onBindViewHolder: Item 24 ----------> Item 24
onBindViewHolder: Item 25 ----------> Item 25
onBindViewHolder: Item 26 ----------> Item 26
onBindViewHolder: Item 27 ----------> Item 27
onBindViewHolder: Item 6 ----------> Appended Item 27
onBindViewHolder: Item 28 ----------> Item 28
onBindViewHolder: Item 29 ----------> Item 29
onLayoutChildren: -----------------------------------------------------------
onLayoutChildren: ------------------After onLayoutChildren-----------------
onLayoutChildren: mAttachedScrap: [Item 30],    mChangedScrap: null,    mCachedViews: [Item 22, Item 23, Item 31],    mRecyclerPool: [],
onLayoutChildren: -----------------------------------------------------------
onViewRecycled: Item 30
onViewRecycled: -----------------------------------------------------------
onViewRecycled: ------------------After onViewRecycled-----------------
onViewRecycled: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [Item 22, Item 23, Item 31],    mRecyclerPool: [Item 30],
onViewRecycled: -----------------------------------------------------------

emmmm，很明显，这次在布局前一个Item都没有被回收。

仔细看，在布局时还有个细节：setHasStableIds为true之后，虽然notifyDataSetChanged同样会导致当前Item全部重新绑定一次数据，但除了新增的【Appended Item 27】，其他Item的数据在Bind前后并没有变化，说明这些Holder并不是从mRecyclerPool中取出来的。

还有，【Appended Item 27】是复用了原来的【Item 6】，往上看，【Item 6】其实是存放在mRecyclerPool中的，在布局完成之后可以看到，mRecyclerPool已经被掏空了。

mAttachedScrap中存了个【Item 30】，它其实就是刚刚被新增的【Appended Item 27】挤出屏幕的那个。在RecyclerView布局完成之后，它就被回收了，可以看到最后它会移到mRecyclerPool里面去。

最后我们来看看删除的：

同样也是会播放动画。

log：

onLayoutChildren: -----------------------------------------------------------
onLayoutChildren: ------------------Before onLayoutChildren-----------------
onLayoutChildren: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [Item 31, Item 30, Item 23],    mRecyclerPool: [Item 22],
onLayoutChildren: -----------------------------------------------------------
onBindViewHolder: Item 24 ----------> Item 24
onBindViewHolder: Item 25 ----------> Item 25
onBindViewHolder: Item 26 ----------> Item 26
onBindViewHolder: Appended Item 27 ----------> Appended Item 27
onBindViewHolder: Item 28 ----------> Item 28
onBindViewHolder: Item 29 ----------> Item 29
onBindViewHolder: Item 30 ----------> Item 30
onLayoutChildren: -----------------------------------------------------------
onLayoutChildren: ------------------After onLayoutChildren-----------------
onLayoutChildren: mAttachedScrap: [Item 27],    mChangedScrap: null,    mCachedViews: [Item 31, Item 23],    mRecyclerPool: [Item 22],
onLayoutChildren: -----------------------------------------------------------
onViewRecycled: Item 27
onViewRecycled: -----------------------------------------------------------
onViewRecycled: ------------------After onViewRecycled-----------------
onViewRecycled: mAttachedScrap: [],    mChangedScrap: null,    mCachedViews: [Item 31, Item 23],    mRecyclerPool: [Item 22, Item 27],
onViewRecycled: -----------------------------------------------------------

onBindViewHolder时，所有Item的数据都没有乱，被删除的那个【Item 27】同样也是被扔到mAttachedScrap里面，布局完成后，移到mRecyclerPool中，mCachedViews的缓存无变化。

总结

• setHasStableIds这个方法主要跟notifyDataSetChanged有关；

• 当HasStableIds被set为true时，通过scrapOrRecycleView方法回收的Holder则永远不会放到mRecyclerPool中；

• 重新设置Adapter和调用notifyDataSetChanged方法时，RecyclerView的有效缓存依然会保留；

• 由notifyDataSetChanged发起的重新布局，如果HasStableIds为true，则会最大程度保证不Create Holder。虽然当前所有Attached Item都会重新绑定一次数据，但mCachedViews中的缓存还在，所以后面如果要显示的Item刚好在mCachedViews中，就不用重新绑定数据了，理论上会提高流畅度（当然了，这么小的差距肉眼根本无法感知的）。

睡觉。

该方法为获取recyclerView ViewHolder缓存

 @Nullable
        ViewHolder tryGetViewHolderForPositionByDeadline(int position,
                boolean dryRun, long deadlineNs) {
             // 2) Find from scrap/cache via stable ids, if exists
                if (mAdapter.hasStableIds()) {
                    holder = getScrapOrCachedViewForId(mAdapter.getItemId(offsetPosition),
                            type, dryRun);
                    if (holder != null) {
                        // update position
                        holder.mPosition = offsetPosition;
                        fromScrapOrHiddenOrCache = true;
                    }
                }
    }

判断当前viewHolder和屏幕上的是否是同一个viewholder

 /**
  boolean validateViewHolderForOffsetPosition(ViewHolder holder) {
            // if it is a removed holder, nothing to verify since we cannot ask adapter anymore
            // if it is not removed, verify the type and id.
            if (holder.isRemoved()) {
                if (DEBUG && !mState.isPreLayout()) {
                    throw new IllegalStateException("should not receive a removed view unless it"
                            + " is pre layout" + exceptionLabel());
                }
                return mState.isPreLayout();
            }
            if (holder.mPosition < 0 || holder.mPosition >= mAdapter.getItemCount()) {
                throw new IndexOutOfBoundsException("Inconsistency detected. Invalid view holder "
                        + "adapter position" + holder + exceptionLabel());
            }
            if (!mState.isPreLayout()) {
                // don't check type if it is pre-layout.
                final int type = mAdapter.getItemViewType(holder.mPosition);
                if (type != holder.getItemViewType()) {
                    return false;
                }
            }
            if (mAdapter.hasStableIds()) {
                return holder.getItemId() == mAdapter.getItemId(holder.mPosition);
            }
            return true;
        }

##简单的说两个作用

1.RecyclerView的缓存规则相关了，其中第一重缓存getChangedScrapViewForPositionchange 丢弃的viewholder，第三重缓存getScrapOrCachedViewForId规则就是根据这个ID去获取的。

1. 更好的寻址作用，可以更快速的定位到当前的viewholder

所以从理论上来说，设置了true的情况下，其在recyclerview 内的缓存机制会得到更充分的使用。

正式用例，真实场景。TV开发，原本焦点定位在RecycleVIew的第5个位置。结果notifyDataChange之后，焦点定位到第1个位置。

这个时候设置setHasStableIds(true) 可以让焦点继续保存在第5个的位置。

小缘大佬的结论：

“在默认情况下，调用Adapter的notifyDataSetChanged方法，对应RecyclerView的所有 "有效" 缓存都会变成 "无效" 缓存，也就是全部都要经过onBindViewHolder重新绑定一次数据。但如果Adapter的hasStableIds为true的话，则可以继续保留这些有效缓存”

估计都在放假 -，- 鄙人小白 抛砖引玉下。

1. 很早以前 ，在列表刷新图片闪烁的时候会加上这句话。
2. 有什么好处自己尝试查看了源码 （但是看不懂 坐等源哥 解答）

public void setHasStableIds(boolean hasStableIds) {
            if (hasObservers()) {
                throw new IllegalStateException("Cannot change whether this adapter has "
                        + "stable IDs while the adapter has registered observers.");
            }
            mHasStableIds = hasStableIds;
        }

private void saveFocusInfo() {
        View child = null;
        if (mPreserveFocusAfterLayout && hasFocus() && mAdapter != null) {
            child = getFocusedChild();
        }

        final ViewHolder focusedVh = child == null ? null : findContainingViewHolder(child);
        if (focusedVh == null) {
            resetFocusInfo();
        } else {
            mState.mFocusedItemId = mAdapter.hasStableIds() ? focusedVh.getItemId() : NO_ID;
            mState.mFocusedItemPosition = mDataSetHasChangedAfterLayout ? NO_POSITION
                    : (focusedVh.isRemoved() ? focusedVh.mOldPosition
                            : focusedVh.getAdapterPosition());
            mState.mFocusedSubChildId = getDeepestFocusedViewWithId(focusedVh.itemView);
        }
    }

private void recoverFocusFromState() {
        ...
                // 如果设置为true 进入if
        ViewHolder focusTarget = null;
        if (mState.mFocusedItemId != NO_ID && mAdapter.hasStableIds()) {
            focusTarget = findViewHolderForItemId(mState.mFocusedItemId);
        }
        View viewToFocus = null;
        if (focusTarget == null || mChildHelper.isHidden(focusTarget.itemView)
                || !focusTarget.itemView.hasFocusable()) {
            if (mChildHelper.getChildCount() > 0) {
                viewToFocus = findNextViewToFocus();
            }
        } else {
            viewToFocus = focusTarget.itemView;
        }

                // 不为空，则进入逻辑 调用view焦点的 requestFocus方法
        if (viewToFocus != null) {
            if (mState.mFocusedSubChildId != NO_ID) {
                View child = viewToFocus.findViewById(mState.mFocusedSubChildId);
                if (child != null && child.isFocusable()) {
                    viewToFocus = child;
                }
            }
            viewToFocus.requestFocus();
        }
    }

/ **
      *调用此选项可尝试将焦点放在特定视图或其某一视图上
      * 子孙。
      *
      *如果视图无法聚焦（{@link #isFocusable}返回
      *否），或者它是否可聚焦且在触摸模式下不可聚焦
      *（{@link #isFocusableInTouchMode}），而设备处于触摸模式。
      *
      *另请参阅{@link #focusSearch（int）}，这就是您所说的所说的
      *有重点，您希望您的父母寻找下一个。
      *
      *这等效于使用参数调用{@link #requestFocus（int，Rect）}
      * {@link #FOCUS_DOWN}和<code> null </ code>。
      *
      * @return此视图或其后代之一是否真正受到关注。
      * /
    public final boolean requestFocus() {
        return requestFocus(View.FOCUS_DOWN);
    }

第一次回答，还望多多指正 （继续看你们秀朋友圈了 云旅游）