深入源码分析RecyclerView缓存复用原理

前言

RecyclerView是Android日常开发中经常使用的控件，了解其源码，明白其中的缓存复用机制是十分有必要的；

四级缓存

我们都知道RecyclerView有四级缓存，缓存的都是ViewHolder对象，那都分别对应哪些缓存呢？各自缓存的作用是什么呢？这里先简单总结下：

层级	缓存变量	容量	数据结构	作用
1	mChangedScrap与 mAttachedScrap	X	ArrayList<ViewHolder>	用来缓存还在屏幕内的ViewHolder
2	mCachedViews	默认为2，可通过调用setViewCacheSize()方法调整	ArrayList<ViewHolder>	用来缓存移除屏幕之外的ViewHolder
3	mViewCacheExtension	X		自定义缓存，一般不使用
4	mRecyclerPool	每个itemViewType默认存储5个ViewHolder	SparseArray<ScrapData>	ViewHolder缓存池，复用时需要重新调用onBindViewHolder

其中ScrapData结构如下：

      static class ScrapData {final ArrayList<ViewHolder> mScrapHeap = new ArrayList<>();}

源码分析

缓存

我们从RecyclerView的onLayout方法开始跟踪：

    protected void onLayout(boolean changed, int l, int t, int r, int b) {...dispatchLayout();...}

其中dispatchLayout()方法如下：

 void dispatchLayout() {if (mAdapter == null) {Log.e(TAG, "No adapter attached; skipping layout");return;}if (mLayout == null) {Log.e(TAG, "No layout manager attached; skipping layout");return;}mState.mIsMeasuring = false;if (mState.mLayoutStep == State.STEP_START) {//dispatchLayoutStep1()中会做以下几件事：1.处理适配器的更新；2.决定应该运行哪个动画；3.保存有关当前视图的信息；4.运行预测布局并保存其信息；dispatchLayoutStep1();mLayout.setExactMeasureSpecsFrom(this);//dispatchLayoutStep2()中会进行实际的布局操作dispatchLayoutStep2();} else if (mAdapterHelper.hasUpdates() || mLayout.getWidth() != getWidth()|| mLayout.getHeight() != getHeight()) {// 当宽高改变时，会再次调用 dispatchLayoutStep2()进行重新布局；mLayout.setExactMeasureSpecsFrom(this);dispatchLayoutStep2();} else {// always make sure we sync them (to ensure mode is exact)mLayout.setExactMeasureSpecsFrom(this);}//dispatchLayoutStep3（）处理相关动画dispatchLayoutStep3();}

这里我们重点关注下 dispatchLayoutStep2()方法；

    private void dispatchLayoutStep2() {...mLayout.onLayoutChildren(mRecycler, mState);...}

显然，由于dispatchLayoutStep2()主要工作是重新布局，那么肯定要进行子View的布局；
其中 mLayout.onLayoutChildren(mRecycler, mState);调用的是LayoutManager的onLayoutChildren方法，
这里，我们选择LinearLayoutManager来跟进流程；

### LinearLayoutManager.onLayoutChildrenpublic void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {...detachAndScrapAttachedViews(recycler);...}

onLayoutChildren会调用detachAndScrapAttachedViews(recycler)方法

     public void detachAndScrapAttachedViews(@NonNull Recycler recycler) {final int childCount = getChildCount();for (int i = childCount - 1; i >= 0; i--) { final View v = getChildAt(i);scrapOrRecycleView(recycler, i, v);}}

注意这里是倒序遍历，我们重点看看scrapOrRecycleView(recycler, i, v);方法；

   final ViewHolder viewHolder = getChildViewHolderInt(view);//如果viewHolder设置成ignore，则直接返回；if (viewHolder.shouldIgnore()) { if (DEBUG) {Log.d(TAG, "ignoring view " + viewHolder);}return;}//如果viewHolder数据非法无效 && viewHolder不指向数据集中移除的数据 && adapter没有设置stableId if (viewHolder.isInvalid() && !viewHolder.isRemoved()&& !mRecyclerView.mAdapter.hasStableIds()) {//移除当前子ViewremoveViewAt(index);//里面会调用mCachedViews和mRecyclerPool进行二级和四级缓存（三级缓存为自定义缓存）recycler.recycleViewHolderInternal(viewHolder);} else {//暂时将View解绑，以便后续可以通过ViewHolder重新绑定复用detachViewAt(index);//里面会根据条件调用mAttachedScrap或mChangedScrap进行一级缓存；recycler.scrapView(view);//从消失列表中移除viewHoldermRecyclerView.mViewInfoStore.onViewDetached(viewHolder);}

接下来，我们就重点分别看recycler.scrapView(view)和 recycler.recycleViewHolderInternal(viewHolder)方法；

一级缓存（mChangedScrap和mChangedScrap）

    void scrapView(View view) {final ViewHolder holder = getChildViewHolderInt(view);//如果ViewHolder标记为移除或失效的 || ViewHolder没有变化 || item 无动画或动画不复用if (holder.hasAnyOfTheFlags(ViewHolder.FLAG_REMOVED | ViewHolder.FLAG_INVALID) || !holder.isUpdated() || canReuseUpdatedViewHolder(holder)) {if (holder.isInvalid() && !holder.isRemoved() && !mAdapter.hasStableIds()) {throw new IllegalArgumentException("Called scrap view with an invalid view."));}holder.setScrapContainer(this, false);mAttachedScrap.add(holder);} else {if (mChangedScrap == null) {mChangedScrap = new ArrayList<ViewHolder>();}holder.setScrapContainer(this, true);mChangedScrap.add(holder);}}

从上述代码可以看出：当ViewHolder满足移除或失效||没有变化||没有动画或动画不复用时，缓存到mAttachedScrap集合中，否则缓存到mChangedScrap集合中；

二级缓存（mCachedViews）

        void recycleViewHolderInternal(ViewHolder holder) {...if (forceRecycle || holder.isRecyclable()) {if (mViewCacheMax > 0&& !holder.hasAnyOfTheFlags(ViewHolder.FLAG_INVALID| ViewHolder.FLAG_REMOVED| ViewHolder.FLAG_UPDATE| ViewHolder.FLAG_ADAPTER_POSITION_UNKNOWN)) {// 先获取mCachedViews的大小int cachedViewSize = mCachedViews.size();//如果mCachedViews大小超过或等于默认值2的时候if (cachedViewSize >= mViewCacheMax && cachedViewSize > 0) {recycleCachedViewAt(0);//将下标为0位置的元素从集合中移除，放入到四级缓存mRecyclerPool中cachedViewSize--; //集合大小-1}int targetCacheIndex = cachedViewSize; //将cachedViewSize赋值给targetCacheIndexif (ALLOW_THREAD_GAP_WORK&& cachedViewSize > 0&& !mPrefetchRegistry.lastPrefetchIncludedPosition(holder.mPosition)) {...//缓存新的holder至targetCacheIndex下标中，并设置cached为truemCachedViews.add(targetCacheIndex, holder);cached = true;}if (!cached) {//没有缓存成功，则放入到四级缓存mRecyclerPool中addViewHolderToRecycledViewPool(holder, true);recycled = true;}} ...}

从上述代码中可以看出：当满足移除屏幕条件时：
1. 当mCachedViews没满时，ViewHolder会直接缓存到mCachedViews中，如果缓存失败，则会缓存到四级缓存mRecyclerPool中；

2. 当mCachedViews满时，会先移除mCachedViews集合中下标为0位置的元素，并将其放置到缓存池mRecyclerPool中；然后将ViewHolder缓存到mCachedViews集合下标为1位置上，如果缓存失败，则会缓存到四级缓存mRecyclerPool中；

三级缓存（ViewCacheExtension）

为用户自定义缓存，可通过自定义ViewCacheExtension，并重写getViewForPositionAndType方法实现；

四级缓存（mRecyclerPool）

从上面二级缓存实现可以看到，会调用addViewHolderToRecycledViewPool(holder, true)实现四级缓存机制；

  void addViewHolderToRecycledViewPool(@NonNull ViewHolder holder, boolean dispatchRecycled) {//1.将viewHolder引用的recyclerView移除掉clearNestedRecyclerViewIfNotNested(holder);...//2.移除viewHolder相关监听if (dispatchRecycled) {dispatchViewRecycled(holder);}holder.mOwnerRecyclerView = null;//3.缓存至mRecyclerPool中；getRecycledViewPool().putRecycledView(holder);}

		###  getRecycledViewPool().putRecycledViewpublic void putRecycledView(ViewHolder scrap) {//1.先获取ViewHolder对象的itemViewTypefinal int viewType = scrap.getItemViewType();//2.根据itemViewType获取对应的ArrayList<ViewHolder>集合final ArrayList<ViewHolder> scrapHeap = getScrapDataForType(viewType).mScrapHeap;//3.如果集合中已经保存有5个ViewHolder了，那就不再进行缓存操作；if (mScrap.get(viewType).mMaxScrap <= scrapHeap.size()) {return;}//4.已经缓存的有，抛异常if (DEBUG && scrapHeap.contains(scrap)) {throw new IllegalArgumentException("this scrap item already exists");}//5.将ViewHolder进行`漂白`，清除相关标志、位置信息等等，因此复用缓存池中的ViewHolder需要重新进行绑定操作；scrap.resetInternal();//6.添加到缓冲池中；scrapHeap.add(scrap);}

缓存池mRecyclerPool结构理解

四级缓存简单小结

根据ViewHolder对应的itemViewType从缓存池中获取对应的ScrapData对象，ScrapData对象内部存储了ArrayList<ViewHolder> 集合，如果当前集合已满5个，则丢弃ViewHolder不进行缓存，如果集合不满，则先将ViewHolder进行数据漂白，清除相关信息后再添加到缓存集合中!

缓存流程图

复用

复用流程图

结语

如果以上文章对您有一点点帮助，希望您不要吝啬的点个赞加个关注，您每一次小小的举动都是我坚持写作的不懈动力！ღ( ´･ᴗ･` )