首页 > 代码库 > RecyclerView 知识梳理(2) - Adapter

RecyclerView 知识梳理(2) - Adapter

一、概述

当我们使用RecyclerView时,第一件事就是要继承于RecyclerView.Adapter,实现其中的抽象方法,来处理数据的展示逻辑,今天,我们就来介绍一下Adapter中的相关方法。

二、基础用法

我们从一个简单的线性列表布局开始,介绍RecyclerView.Adapter的基础用法。
首先,需要导入远程依赖包:

 compile‘com.android.support:recyclerview-v7:25.3.1‘

接着,继承于RecyclerView.Adapter来实现自定义的NormalAdapter

public class NormalAdapter extends RecyclerView.Adapter<NormalAdapter.NormalViewHolder> {

    private List<String> mTitles = new ArrayList<>();

    public NormalAdapter(List<String> titles) {
        mTitles = titles;
    }

    @Override
    public NormalViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View itemView = LayoutInflater.from(parent.getContext()).inflate(R.layout.layout_normal_item, parent, false);
        return new NormalViewHolder(itemView);
    }

    @Override
    public void onBindViewHolder(NormalViewHolder holder, int position) {
        holder.setTitle(mTitles.get(position));
    }

    @Override
    public int getItemCount() {
        return mTitles.size();
    }

    class NormalViewHolder extends RecyclerView.ViewHolder {

        private TextView mTextView;

        NormalViewHolder(View itemView) {
            super(itemView);
            mTextView = (TextView) itemView.findViewById(R.id.tv_title);
        }

        void setTitle(String title) {
            mTextView.setText(title);
        }

    }
}

当我们实现自己的Adapter时,至少要做四个工作:

  • 第一:继承于RecyclerView.ViewHolder,编写自己的ViewHolder
    • 这个子类用来描述RecyclerView中每个Item的布局以及和它关联的数据,它同时也是RecyclerView.Adapter<VH>中需要指定的VH类型。
    • 在构造方法中,除了需要调用super(View view)方法来传入Item的跟布局来给基类中itemView变量赋值,还应当提前执行findViewById来获得其中的子View以便我们之后对它们进行更新。
  • 第二:实现onCreateViewHolder(ViewGroup parent, int viewType)
    • RecyclerView需要我们提供类型为viewType的新ViewHolder时,会回调这个方法。
    • 在这里,我们实例化出了Item的根布局,并返回一个和它绑定的ViewHolder
  • 第三:实现onBindViewHolder(VH viewHolder, int position)
    • RecyclerView需要展示对应position位置的数据时会回调这个方法。
    • 通过viewHolder中持有的对应position上的View,我们可以更新视图。
  • 第四:实现getItemCount()
    • 返回Item的总数。

Activity中,我们给Adapter传递数据,使用方法和ListView基本相同,只是多了一句在设置LayoutManager的操作,这个我们后面再分析。

    private void init() {
        RecyclerView recyclerView = (RecyclerView) findViewById(R.id.rv_content);
        mTitles = new ArrayList<>();
        for (int i = 0; i < 20; i++) {
            mTitles.add("My name is " + i);
        }
        NormalAdapter normalAdapter = new NormalAdapter(mTitles);
        recyclerView.setLayoutManager(new LinearLayoutManager(this));
        recyclerView.setAdapter(normalAdapter);
    }

这样,一个RecyclerView的例子就完成了:

技术分享
 

三、只有一种ViewType下的复用情况分析

下面,我们来分析一下两个关键方法的调用时机:

  • onCreateViewHolder
  • onBindViewHolder

通过这两个方法回调的时机,我们可以对RecyclerView复用的机制有一个大概的了解。

3.1 初始进入

刚开始进入界面的时候,我们只展示了3Item,此时这两个方法的调用情况如下,可以看到,RecyclerView只实例化了屏幕内可见的ViewHolder,并且onBindViewHolder是在对应的onCreateViewHolder调用完后立即调用的:

技术分享
 

3.2 开始滑动

当我们手指触摸到屏幕,并开始向下滑动,我们会发现,虽然position=3Item还没有展示出来,但是这时候它的onCreateViewHolderonBindViewHolder就被回调了,也就是说,我们会预加载一个屏幕以外的Item

技术分享
 

3.3 继续滑动

当我们继续往下滑动,position=3Item一被展示,那么position=4Item的两个方法就会被回调。

3.4 复用

postion=6Item被展示之后,按照前面的分析,这时候就应当回调position=7onCreateViewHolderonBindViewHolder方法了,但是我们发现,这时候只回调了onBindViewHolder方法,而传入的ViewHolder其实是position=0ViewHolder,也就是我们所说的复用:

技术分享
 


此时,屏幕中Items的展现情况为:

技术分享
 


目前不可见的Itemposition=0,1,2,所以,我们可以得出结论:在单一布局的情况,RecyclerView在复用的时候,会取相反方向中超出显示范围的第3Item来复用,而并不是超出显示范围的第一个Item进行复用。

四、多种类型的布局

4.1 基本使用

当我们需要在列表当中展示不同类型的Item时,我们一般需要重写下面的方法,告诉RecyclerView在对应的position上需要展示什么类型的Item

  • public int getItemViewType(int position)

RecyclerView在回调onCreateViewHolder的时候,同时也会把viewType传递进来,我们根据viewType来创建不同的布局。
下面,我们就来演示一下它的用法,这里我们返回三种不同类型的item

public class NormalAdapter extends RecyclerView.Adapter<NormalAdapter.NormalViewHolder> {

    private List<String> mTitles = new ArrayList<>();

    public NormalAdapter(List<String> titles) {
        mTitles = titles;
    }

    @Override
    public NormalViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View itemView = null;
        switch (viewType) {
            case 0:
                itemView = LayoutInflater.from(parent.getContext()).inflate(R.layout.layout_normal_item_1, parent, false);
                break;
            case 1:
                itemView = LayoutInflater.from(parent.getContext()).inflate(R.layout.layout_normal_item_2, parent, false);
                break;
            case 2:
                itemView = LayoutInflater.from(parent.getContext()).inflate(R.layout.layout_normal_item_3, parent, false);
                break;

        }
        NormalViewHolder viewHolder = new NormalViewHolder(itemView);
        Log.d("NormalAdapter", "onCreateViewHolder, address=" + viewHolder.toString());
        return viewHolder;
    }

    @Override
    public void onBindViewHolder(NormalViewHolder holder, int position) {
        Log.d("NormalAdapter", "onBindViewHolder, address=" + holder.toString() + ",position=" + position);
        int viewType = getItemViewType(position);
        String title = mTitles.get(position);
        holder.setTitle1("title=" + title + ",viewType=" + viewType);
    }

    @Override
    public int getItemCount() {
        return mTitles.size();
    }

    @Override
    public int getItemViewType(int position) {
        return position % 3;
    }

    class NormalViewHolder extends RecyclerView.ViewHolder {

        private TextView mTv1;

        NormalViewHolder(View itemView) {
            super(itemView);
            mTv1 = (TextView) itemView.findViewById(R.id.tv_title_1);
        }

        void setTitle1(String title) {
            mTv1.setText(title);
        }

    }
}

最终,会得到下面的界面:

技术分享
 

4.2 多种viewType下的复用情况分析

前面,我们已经研究过一种viewType下的复用情况,现在,我们再来分析一下多种viewType时候的复用情况。

4.2.1 初始进入

此时,我们屏幕中展示了postion=0~6这七个ItemonCreateViewHolderonBindViewHolder的回调和之前相同,只会生成屏幕内可见的ViewHolder

技术分享
 

4.2.2 开始滑动和继续滑动

这两种情况都和单个viewType时相同,会预加载屏幕以外的一个Item

技术分享
 

4.2.3 复用

关键,我们看一下何时会复用position=0/viewType=1Item

技术分享
 


此时,屏幕内最上方的Itemposition=4/viewType=1,最下方的Itemposition=11/viewType=2,按照之前的分析,RecyclerView会保留相反方向的2ViewHolder,也就是保留postion=2,3ViewHolder,并复用position=1ViewHolder,但是现在position=0ViewHolderviewType=1,不可以复用,因此,会继续往上寻找,这时候就找到了position=0ViewHolder进行复用。

五、数据更新

5.1 更新方式

当数据源发生变化的时候,我们一般会通过Adatper. notifyDataSetChanged()来进行界面的刷新,RecyclerView.Adapter也提供了相同的方法:

public final void notifyDataSetChanged()

除此之外,它还提供了下面几种方法,让我们进行局部的刷新:

//position的数据变化
notifyItemChanged(int postion)
//在position的下方插入了一条数据
notifyItemInserted(int position)
//移除了position的数据
notifyItemRemoved(int postion)
//从position开始,往下n条数据发生了改变
notifyItemRangeChanged(int postion, int n)
//从position开始,插入了n条数据
notifyItemRangeInserted(int position, int n)
//从position开始,移除了n条数据
notifyItemRangeRemoved(int postion, int n)

下面是一些简单的使用方法:

   //在头部添加多个数据.
   public void addItems() {
        mTitles.add(0, "add Items, name=0");
        mTitles.add(0, "add Items, name=1");
        mNormalAdapter.notifyItemRangeInserted(0, 2);
    }
    //移除头部的多个数据.
    public void removeItems() {
        mTitles.remove(0);
        mTitles.remove(0);
        mNormalAdapter.notifyItemRangeRemoved(0, 2);
    }
    //移动数据.
    public void moveItems() {
        mTitles.remove(1);
        mTitles.add(2, "move Items name=0");
        mNormalAdapter.notifyItemMoved(1, 2);
    }

5.2 比较

数据的更新分为两种:

  • Item changes:除了Item所对应的数据被更新外,没有其它的变化,对应notifyXXXChanged()方法。
  • Structural changesItems在数据集中被插入、删除或者移动,对应notifyXXXInsert/Removed/Moved方法。

notifyDataSetChanged会把当前所有的Item和结构都视为已经失效的,因此它会让LayoutManager重新绑定Items,并对他们重新布局,这在我们知道已经需要更新某个Item的时候,其实是不必要的,这时候就可以选择进行局部更新来提高效率。

六、监听ViewHolder的状态

RecyclerView.Adapter中还提供了一些回调,让我们能够监听某个ViewHolder的变化:

    @Override
    public void onViewRecycled(NormalViewHolder holder) {
        Log.d("NormalAdapter", "onViewRecycled=" + holder);
        super.onViewRecycled(holder);
    }

    @Override
    public void onViewDetachedFromWindow(NormalViewHolder holder) {
        Log.d("NormalAdapter", "onViewDetachedFromWindow=" + holder);
        super.onViewDetachedFromWindow(holder);
    }

    @Override
    public void onViewAttachedToWindow(NormalViewHolder holder) {
        Log.d("NormalAdapter", "onViewAttachedToWindow=" + holder);
        super.onViewAttachedToWindow(holder);
    }

下面,我们就从实例来讲解这几个方法的调用时机,初始时刻,我们的界面为:

技术分享
 
  • 初始进入时,position=0~6onViewAttachedToWindow被回调:
    技术分享
     
  • 当滑动到postion=7可见时,它的onViewAttachedToWindow被回调:
    技术分享
     
  • postion=0被移出屏幕可视范围内,它的onViewDetachedFromWindow被回调:
    技术分享
     
  • 而当我们继续往下滑动,当position=2被移出屏幕之后,此时position=0onViewRecycled被回调:
    技术分享
     

    现在回忆一下之前我们对复用情况的分析,RecyclerView最多会保留相反方向上的两个ViewHolder,此时虽然position=1,2不可见,但是依然需要保留它们,这时候会回收position=0ViewHolder以备之后被复用。

七、监听RecyclerViewRecyclerView.Adapter的关系

RecyclerViewAdapter是通过setAdapter方法来绑定的,因此在Adapter中也通过了绑定的监听:

public void onAttachedToRecyclerView(RecyclerView recyclerView) {}
public void onDetachedFromRecyclerView(RecyclerView recyclerView) {}

八、小结

这篇文章,主要总结了一些RecyclerView.Adapter中平时我们不常注意的细节问题,也通过实例了解到了关键方法的含义,最后,推荐一个Adapter的开源库:BaseRecyclerViewAdapterHelper

RecyclerView 知识梳理(2) - Adapter