RecyclerView的使用总结以及常见问题解决方案

Q1：RecyclerView设置数据不显示

这个往往是因为你没有设置LayoutManger。 没有LayoutManger的话RecycleView是无法布局的，即是无法展示数据,下面是RecycleView布局的源码:

1
2
3
4
5
6
7
8
9
10
11
12
void dispatchLayout() {  //没有设置 Adapter 和 LayoutManager， 都不可能有内容
    if (mAdapter == null) {
            Log.e(TAG, "No adapter attached; skipping layout");
            // leave the state in START
            return;
    }
    if (mLayout == null) {
            Log.e(TAG, "No layout manager attached; skipping layout");
            // leave the state in START
            return;
    }
}

即Adapter或Layout任意一个为null,就不会执行布局操作。

Q2：RecyclerView数据多次滚动后出现混乱

RecycleView在滚动过程中ViewHolder是会不断复用的，因此就会带着上一次展示的UI信息(也包含滚动状态), 所以在设置一个ViewHolder的UI时，尽量要做resetUi()操作:

1
2
3
4
override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int) {
        holder.itemView.resetUi()
        //设置信息UI 
}

resetUi()这个方法就是用来把Ui还原为最初的操作。当然如果你的每一次bindData操作会对每一个UI对象重新赋值的话就不需要有这个操作。就不会出现itemView的UI混乱问题。

Q3：如何获取当前 ItemView展示的位置

我们可能会有这样的需求: 当RecycleView中的特定Item滚动到某个位置时做一些操作。比如某个Item滚动到顶部时，展示搜索框。那怎么实现呢？

首先要获取的Item肯定处于数据源的某个位置并且肯定要展示在屏幕。因此我们可以直接获取这个Item的ViewHolder:

1
2
3
4
5
6
7
val holder = recyclerView.findViewHolderForAdapterPosition(speicalItemPos) ?: return

val offsetWithScreenTop = holder.itemview.top

if(offsetWithScreenTop <= 0){  //这个ItemView已经滚动到屏幕顶部
    //do something
}

Q4：如何在固定时间内滚动一款距离

smoothScrollToPosition()大家应该都用过，如果滚动2、3个Item。那么整体的用户体验还是非常棒的。

但是，如果你滚动20个Item，那这个体验可能就会就很差了。

恩，滚动的时间有点长。因此对于这种case其实我推荐直接使用scrollToPosition(20)，效果要比这个好。 可是如果你就是想在200ms内从Item 1滚到Item 20怎么办呢？

可以参考StackOverflow上的一个答案。大致写法是这样的:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
//自定义 LayoutManager， Hook smoothScrollToPosition 方法
recyclerView.layoutManager = object : LinearLayoutManager(this, LinearLayoutManager.VERTICAL, false) {
    override fun smoothScrollToPosition(recyclerView: RecyclerView?, state: RecyclerView.State?, position: Int) {
        if (recyclerView == null) return
        val scroller = get200MsScroller(recyclerView.context, position * 500)
        scroller.targetPosition = position
        startSmoothScroll(scroller)
    }
}

private fun get200MsScroller(context: Context, distance: Int): RecyclerView.SmoothScroller = object : LinearSmoothScroller(context) {
    override fun calculateSpeedPerPixel(displayMetrics: DisplayMetrics): Float {
        return (200.0f / distance) //表示滚动 distance 花费200ms
    }
}

比如上面我把时间改为10000,那么就是用10s的时间完成这个滚动操作。

Q5：如何测量当前RecyclerView的高度

先描述一下这个需求: RecyclerView中的每个ItemView的高度都是不固定的。我数据源中有20条数据，在没有渲染的情况下我想知道这个20条数据被RecycleView渲染后的总共高度。

怎么做呢？我的思路是利用LayoutManager来测量，因为RecycleView在对子View进行布局时就是用LayoutManager来测量子View来计算还有多少剩余空间可用，源码如下:

1
2
3
4
5
6
void layoutChunk(RecyclerView.Recycler recycler, RecyclerView.State state,LayoutState layoutState, LayoutChunkResult result) {
     View view = layoutState.next(recycler);   //这个方法会向 recycler要一个View
     ...
     measureChildWithMargins(view, 0, 0);  //测量这个View的尺寸，方便布局, 这个方法是public
     ...
 }

所以我们也可以利用layoutManager.measureChildWithMargins方法来测量，代码如下:

1
2
3
4
5
6
7
8
9
10
private fun measureAllItemHeight():Int {
    val measureTemplateView = SimpleStringView(this)
    var totalItemHeight =
    dataSource.forEach {  //dataSource当前中的所有数据
        measureTemplateView.bindData(it, 0) //设置好UI数据
        recyclerView.layoutManager.measureChild(measureTemplateView, 0, 0) //调用源码中的子View的测量方法
        currentHeight += measureTemplateView.measuredHeight
    }
    return totalItemHeight
}

但要注意的是，这个方法要等布局稳定的时候才可以用，如果你在Activity.onCreate中调用，那么应该post一下， 即:

1
2
3
recyclerView.post{
    val totalHeight = measureAllItemHeight()
}

Q6：IndexOutOfBoundsException: Inconsistency detected. Invalid item position 5(offset:5).state:9

这个异常通常是由于Adapter的数据源大小改变没有及时通知RecycleView做UI刷新导致的，或者通知的方式有问题。 比如如果数据源变化了(比如数量变少了),而没有调用notifyXXX, 那么此时滚动RecycleView就会产生这个异常。

解决办法很简单 : Adapter的数据源改变时应立即调用adapter.notifyXXX来刷新RecycleView 。

分析一下这个异常为什么会产生:

在RecycleView刷新机制一文介绍过，RecycleView的滚动操作是不会走RecycleView的正常布局过程的，它直接根据滚动的距离来摆放新的子View。 想象一下这种场景，原来数据源集合中
有8个Item，然后删除了4个后没有调用adapter.notifyXXX()，这时直接滚动RecycleView，比如滚动将要出现的是第6个Item，LinearLayoutManager就会向Recycler要第6个Item的View:

Recycler.tryGetViewHolderForPositionByDeadline():=>

1
2
3
4
5
6
final int offsetPosition = mAdapterHelper.findPositionOffset(position);  //position是6 
if (offsetPosition < 0 || offsetPosition >= mAdapter.getItemCount()) {    //但此时  mAdapter.getItemCount() = 5
        throw new IndexOutOfBoundsException("Inconsistency detected. Invalid item "
                + "position " + position + "(offset:" + offsetPosition + ")."
                + "state:" + mState.getItemCount() + exceptionLabel());
}

即这时就会抛出异常。如果调用了adapter.notifyXXX的话，RecycleView就会进行一次完全的布局操作，就不会有这个异常的产生。

其实还有很多异常和这个原因差不多，比如:IllegalArgumentException: Scrapped or attached views may not be recycled. isScrap:false(很多情况也是由于没有及时同步UI和数据)

所以在使用RecycleView时一定要注意保证数据和UI的同步，数据变化，及时刷新RecyclerView, 这样就能避免很多crash。

Q7：如何对RecyclerView进行封装

现在很多app都会使用RecyclerView来构建一个页面，这个页面中有各种卡片类型。为了支持快速开发我们通常会对RecycleView的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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/**
 * 对 RecyclerView.Adapter 的封装。方便业务书写。 业务只需要处理 (UI Bean) -> (UI View) 的映射逻辑即可
 */
abstract class CommonRvAdapter<T>(private val dataSource: List<T>) : RecyclerView.Adapter<RecyclerView.ViewHolder>() {

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RecyclerView.ViewHolder {
        val item = createItem(viewType)
        return CommonViewHolder(parent.context, parent, item)
    }

    override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int) {
        val commonViewHolder = holder as CommonViewHolder<T>
        commonViewHolder.adapterItemView.bindData(dataSource[position], position)
    }

    override fun getItemCount() = dataSource.size

    override fun getItemViewType(position: Int): Int {
        return getItemType(dataSource[position])
    }

    /**
     * @param viewType 需要创建的ItemView的viewType, 由 {@link getItemType(item: T)} 根据数据产生
     * @return 返回这个 viewType 对应的 AdapterItemView
     * */
    abstract fun createItem(viewType: Int): AdapterItemView<T>

    /**
     * @param T 代表dataSource中的一个data
     *
     * @return 返回 显示 T 类型的data的 ItemView的 类型
     * */
    abstract fun getItemType(item: T): Int

    /**
     * Wrapper 的ViewHolder。 业务不必理会RecyclerView的ViewHolder
     * */
    private class CommonViewHolder<T>(context: Context?, parent: ViewGroup, val adapterItemView: AdapterItemView<T>)
    //这一点做了特殊处理，如果业务的AdapterItemView本身就是一个View，那么直接当做ViewHolder的itemView。 否则inflate出一个view来当做ViewHolder的itemView
        : RecyclerView.ViewHolder(if (adapterItemView is View) adapterItemView else LayoutInflater.from(context).inflate(adapterItemView.getLayoutResId(), parent, false)) {
        init {
            adapterItemView.initViews(itemView)
        }
    }
}

/**
 * 能被 CommonRvAdapter 识别的一个 ItemView 。 业务写一个RecyclerView中的ItemView，只需要实现这个接口即可。
 * */
interface AdapterItemView<T> {

    fun getLayoutResId(): Int

    fun initViews(var1: View)

    fun bindData(data: T, post: Int)
}

为什么我认为这是一个不错的封装?

业务如果写一个新的Adapter的话只需要实现两个方法:

1
2
3
abstract fun createItem(viewType: Int): AdapterItemView<T>

abstract fun getItemType(item: T): Int

即业务写一个Adapter只需要对 UI 数据 -> UI View 做映射即可, 不需要关心RecycleView.ViewHolder的逻辑。

因为抽象了AdapterItemView, ItemView足够灵活

由于封装了RecycleView.ViewHolder的逻辑，因此对于UI item view业务方只需要返回一个实现了AdapterItemView的对象即可。可以是一个View,也可以不是一个View, 这是因为CommonViewHolder在构造的时候对它做了兼容:

1
val view : View = if (adapterItemView is View) adapterItemView else LayoutInflater.from(context).inflate(adapterItemView.getLayoutResId(), parent, false)

即如果实现了AdapterItemView的对象本身就是一个View,那么直接把它当做ViewHolder的itemview,否则就inflate出一个View作为ViewHolder的itemview。

其实这里我比较推荐实现AdapterItemView的同时直接实现一个View,即不要把inflate的工作交给底层框架。比如这样:

1
2
3
4
5
6
7
8
9
10
11
12
private class SimpleStringView(context: Context) : FrameLayout(context), AdapterItemView<String> {

    init {
        LayoutInflater.from(context).inflate(getLayoutResId, this)  //自己去负责inflate工作
    }

    override fun getLayoutResId() = R.layout.view_test

    override fun initViews(var1: View) {}

    override fun bindData(data: String, post: Int) { simpleTextView.text = data }
}

为什么呢？原因有两点 :

  1. 继承自一个View可复用性很高，封装性很高。即这个SimpleStringView不仅可以在RecycleView中当一个itemView,也可以在任何地方使用。
  2. 方便单元测试，直接new这个View就好了。

但其实直接继承自一个View是有坑的，即上面那行inflate代码LayoutInflater.from(context).inflate(getLayoutResId, this)

它其实是把xml文件inflate成一个View。然后add到你ViewGroup中。因为SimpleStringView就是一个FrameLayout，所有相当于add到这个FrameLayout中。这其实就有问题了。比如你的布局文件是下面这种:

1
2
3
<FrameLayout>
.....
</FrameLayout>

这就相当于你可能多加了一层无用的父View

所有如果是直接继承自一个View的话，我推荐这样写:

  1. 布局文件中尽可能使用<merge>标签来消除这层无用的父View, 即上面的<FrameLayout>改为<merge>
  2. 很简单的布局的可以直接在代码中写，不要inflate。这样其实也可以减少inflate的耗时，稍微提高了一点性能吧。

当然，如果你不需要对这个View做复用的话你可以不用直接继承自View,只实现AdapterItemView接口, inflate的工作交给底层框架即可。这样是不会产生上面这个问题的。