对RecyclerView.Adapter做一个简单的封装

RecyclerView的适配器写起来非常繁琐，里面有很多地方都是重复的套路，以至于每写一个适配器都要手动去编写那些不必要的代码。为了省力，我们可以将那些重复的部分封装起来。

为了更好的讲解封装的思路，这里不先贴出封装后的代码，而是贴出封装前的RecyclerView适配器代码。如果不想看繁琐的讲解，请直接将页面移到底部查看完整代码以及用法（页内跳转不知道为什么不起作用，所以只能靠手动移到底部）。

RecordAdapter

public class RecordAdapter extends RecyclerView.Adapter<RecordAdapter.RecordHolder> {

    //上下文环境
    private Context context;
    //数据集合
    private List<Record> data;

    public RecordAdapter(Context context, List<Record> data) {
        this.context = context;
        this.data = data;
    }

    /**
     * 刷新数据
     * @param data
     */
    public void refresh(List<Record> data){
        this.data = data;
        notifyDataSetChanged();
    }

    @Override
    public RecordHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(context).inflate(R.layout.item_record, parent, false);
        return new RecordHolder(view);
    }

    @Override
    public void onBindViewHolder(RecordHolder holder, int position) {
        Record record = data.get(position);
        holder.bind(record);
    }


    @Override
    public int getItemCount() {
        return data == null ? 0 : data.size();
    }

    class RecordHolder extends RecyclerView.ViewHolder {

        TextView tvId;
        TextView tvRemark;
        TextView tvCreatedAt;

        public RecordHolder(View itemView) {
            super(itemView);
            tvId = (TextView) itemView.findViewById(R.id.tvId);
            tvRemark = (TextView) itemView.findViewById(R.id.tvRemark);
            tvCreatedAt = (TextView) itemView.findViewById(R.id.tvCreatedAt);
        }

        //绑定数据
        public void bind(Record record) {
            tvId.setText(record.getId().toString());
            tvRemark.setText(record.getRemark());
            tvCreatedAt.setText(record.getCreatedAt().toString());
        }
    }
}

这是一个适配器所要完成的几个最基本的工作，重写onCreateViewHolder()、 onBindViewHolder()、getItemCount()方法以及自定义ViewHolder。当然还有itemView布局中各个控件的监听事件的绑定，只不过此处只是一个简单的演示，所以没写。

接下来通过对比的方式讲解BaseRecyclerAdapter的封装思路

BaseRecyclerAdapter的成员变量以及构造器
public abstract class BaseRecyclerAdapter<T> extends RecyclerView.Adapter {

    //上下文环境
    private Context context;
    //数据集合
    private List<T> data;

    public BaseRecyclerAdapter(Context context, List<T> data) {
        this.context = context;
        this.data = data;
    }
}
对比RecordAdapterde的成员变量以及构造器
public class RecordAdapter extends RecyclerView.Adapter<RecordAdapter.RecordHolder> {

    //上下文环境
    private Context context;
    //数据集合
    private List<Record> data;

    public RecordAdapter(Context context, List<Record> data) {
        this.context = context;
        this.data = data;
    }

    ...
}

所有的适配器都有这两个成员变量，所以对这两个变量可以做一个封装。List的类型是自定义的，这里用泛型T表示。

BaseRecyclerAdapter中的getItemCount()方法
    @Override
    public int getItemCount() {
        return data == null ? 0 : data.size();
    }
对比RecordAdapterde中的getItemCount()方法
    @Override
    public int getItemCount() {
        return data == null ? 0 : data.size();
    }

一模一样！所有的getItemCount()都长这样所以没啥好说的。

在重写onCreateViewHolder()和onBindViewHolder()方法之前先完成BaseViewHolder

BaseRecyclerAdapter内部类BaseViewHolder
    /**
     * 封装 ViewHolder
     */
    class BaseViewHolder extends RecyclerView.ViewHolder {

        // item 中的控件缓存在这里
        private SparseArray<View> views;

        public BaseViewHolder(View itemView) {
            super(itemView);
            views = new SparseArray<>();
        }

        /**
         * 获取 itemView 中的控件
         *
         * @param id
         * @return
         */
        public View getView(int id) {
            View view = views.get(id);
            if (view == null) {
                view = itemView.findViewById(id);
                views.put(id, view);
            }
            return view;
        }
    }
对比RecordAdapterde内部类RecordHolder
    class RecordHolder extends RecyclerView.ViewHolder {

        // item 中的控件
        TextView tvId;
        TextView tvRemark;
        TextView tvCreatedAt;

        public RecordHolder(View itemView) {
            super(itemView);
            tvId = (TextView) itemView.findViewById(R.id.tvId);
            tvRemark = (TextView) itemView.findViewById(R.id.tvRemark);
            tvCreatedAt = (TextView) itemView.findViewById(R.id.tvCreatedAt);
        }

        //绑定数据
        public void bind(Record record) {
            tvId.setText(record.getId().toString());
            tvRemark.setText(record.getRemark());
            tvCreatedAt.setText(record.getCreatedAt().toString());
        }
    }

可以看到RecordHolder中的成员变量是已经写死的，如果我们要做的封装的话就不能写死，所以只能用一个SparseArray<View>集合保存那些控件。而且RecordHolder在构造方法中就已经将那些控件绑定，在BaseViewHolder中显然不能这么做，它提供了public View getView(int id)方法。这方法可以从SparseArray<View>中取出控件，并且在取出的过程中动态的绑定控件。

这里简单介绍一下SparseArray集合：SparseArray和HashMap类似，都是以Key和Value的形式保存数据。（如果想要了解得更详细的话可以去问度娘）

getView()方法中的代码片段
if (view == null) {
    view = itemView.findViewById(id);
    views.put(id, view);
}

这部分代码的作用就是当SparseArray<View>集合中没有指定控件的时候会去itemView中找，这个过程就已经完成了控件的绑定了，所以不用像RecordAdapterde那样在构造器中就已经完成控件的绑定了。

我们还剩余两个方法没有搞定，一个是onCreateViewHolder()另一个是onBindViewHolder()，在这之前先做一件事情，将RecyclerView.Adapter改为RecyclerView.Adapter<BaseRecyclerAdapter.BaseViewHolder>

public abstract class BaseRecyclerAdapter<T> extends RecyclerView.Adapter<BaseRecyclerAdapter.BaseViewHolder> {

    //上下文环境
    private Context context;
    //数据集合
    private List<T> data;

    ...
}
BaseRecyclerAdapter中的onCreateViewHolder()方法
    @Override
    public BaseViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(context).inflate(getItemLayoutId(), parent, false);
        return new BaseViewHolder(view);
    }

    /**
     * 子类通过重写此方法设置 RecyclerView 的 item 项的布局视图
     *
     * @return
     */
    public abstract int getItemLayoutId();
对比RecordAdapter中的onCreateViewHolder()方法
    @Override
    public RecordHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(context).inflate(R.layout.item_record, parent, false);
        return new RecordHolder(view);
    }

除了R.layout.item_record这个参数需要手动设置，其他的代码都是固定不变的。这个参数可以通过抽象方法public abstract int getItemLayoutId()来设置，而我们通过在子类中重写这个方法就可以灵活的设置itemView。

BaseRecyclerAdapter中的onBindViewHolder()方法
    @Override
    public void onBindViewHolder(BaseRecyclerAdapter.BaseViewHolder holder, int position) {
        T t = data.get(position);
        bindData(holder, t);
    }

    /**
     * 将数据绑定到 itemView 视图上
     *
     * @param holder
     * @param t
     */
    public abstract void bindData(BaseViewHolder holder, T t);
对比RecordAdapter中的onBindViewHolder()方法
    @Override
    public void onBindViewHolder(RecordHolder holder, int position) {
        Record record = data.get(position);
        holder.bind(record);
    }

在BaseRecyclerAdapter中通过抽象方法public abstract void bindData(BaseViewHolder holder, T t)方法实现数据绑定，同样的我们需要在子类中重写该方法。

到这里BaseRecyclerAdapter就完成了，下面是完整代码

完整代码

BaseRecyclerAdapter
public abstract class BaseRecyclerAdapter<T> extends RecyclerView.Adapter<BaseRecyclerAdapter.BaseViewHolder> {

    //上下文环境
    private Context context;
    //数据集合
    private List<T> data;

    /**
     * 刷新数据
     *
     * @param data
     */
    public void refresh(List<T> data) {
        this.data = data;
        notifyDataSetChanged();
    }

    /**
     * 添加数据
     *
     * @param data
     */
    public void append(List<T> data) {
        this.data.addAll(data);
        notifyDataSetChanged();
    }

    public BaseRecyclerAdapter(Context context, List<T> data) {
        this.context = context;
        this.data = data;
    }

    @Override
    public BaseViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(context).inflate(getItemLayoutId(), parent, false);
        return new BaseViewHolder(view);
    }

    @Override
    public void onBindViewHolder(BaseRecyclerAdapter.BaseViewHolder holder, int position) {
        T t = data.get(position);
        bindData(holder, t);
    }

    @Override
    public int getItemCount() {
        return data == null ? 0 : data.size();
    }

    /**
     * 将数据绑定到itemView视图上
     *
     * @param holder
     * @param t
     */
    public abstract void bindData(BaseViewHolder holder, T t);

    /**
     * 子类通过重写此方法设置itemView项的布局视图
     *
     * @return
     */
    public abstract int getItemLayoutId();

    /**
     * 封装 ViewHolder
     */
    class BaseViewHolder extends RecyclerView.ViewHolder {

        // item 中的控件缓存在这里
        private SparseArray<View> views;

        public BaseViewHolder(View itemView) {
            super(itemView);
            views = new SparseArray<>();
        }

        /**
         * 获取 itemView 中的控件
         *
         * @param id
         * @return
         */
        public View getView(int id) {
            View view = views.get(id);
            if (view == null) {
                view = itemView.findViewById(id);
                views.put(id, view);
            }
            return view;
        }

    }
}

使用

RecordAdapter.java
public class RecordAdapter extends BaseRecyclerAdapter<Record> {

    public RecordAdapter(Context context, List<Record> data) {
        super(context, data);
    }

    @Override
    public void bindData(BaseViewHolder holder, Record record) {
        TextView tvId = (TextView) holder.getView(R.id.tvId);
        TextView tvRemark = (TextView) holder.getView(R.id.tvRemark);
        TextView tvCreatedAt = (TextView) holder.getView(R.id.tvCreatedAt);

        tvId.setText(record.getId().toString());
        tvRemark.setText(record.getRemark());
        tvCreatedAt.setText(record.getCreatedAt().toString());
    }

    @Override
    public int getItemLayoutId() {
        return R.layout.item_record;
    }
}

创建一个RecordAdapter类，它继承自BaseRecyclerAdapter，并且在泛型T位置填Record。然后导入构造方法和重写两个抽象方法。

Record.java
public class Record {

    //ID
    private Integer id;
    //备注
    private String remark;
    //创建日期
    private Date createdAt;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getRemark() {
        return remark;
    }

    public void setRemark(String remark) {
        this.remark = remark;
    }

    public Date getCreatedAt() {
        return createdAt;
    }

    public void setCreatedAt(Date createdAt) {
        this.createdAt = createdAt;
    }
}
item_record.xml
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:layout_margin="10dp">

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="80dp"
        android:orientation="horizontal">

        <TextView
            android:id="@+id/tvId"
            android:layout_width="0dp"
            android:layout_height="match_parent"
            android:layout_weight="1"
            android:gravity="center"
            android:text="1"
            android:textSize="30sp"/>

        <android.support.v7.widget.ContentFrameLayout
            android:layout_width="0dp"
            android:layout_height="match_parent"
            android:layout_margin="5dp"
            android:layout_weight="3">

            <TextView
                android:id="@+id/tvRemark"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:layout_gravity="center_vertical"
                android:text="这里是备注"/>

            <TextView
                android:id="@+id/tvCreatedAt"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:layout_gravity="bottom|right"
                android:text="2018.6.6 11:00:00"/>
        </android.support.v7.widget.ContentFrameLayout>
    </LinearLayout>
</LinearLayout>
MainActivity.java
public class MainActivity extends AppCompatActivity {

    private RecyclerView recyclerView;
    private RecordAdapter adapter;
    private List<Record> records;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        recyclerView = (RecyclerView) findViewById(R.id.recyclerView);
        recyclerView.setLayoutManager(new LinearLayoutManager(this));
        adapter = new RecordAdapter(this, records);
        recyclerView.setAdapter(adapter);

        records = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            Record record = new Record();
            record.setId(i);
            record.setRemark("第" + i + "条备注");
            record.setCreatedAt(new Date());
            records.add(record);
        }

        adapter.refresh(records);
    }
}

运行效果如下

运行结果.png

最后

虽然这个类能够简化适配器的编写，但是仅仅适用于简单情况。如果要对item_record中的每一个控件绑定不同的监听器，这个类显然是做不到的。所以对于复杂的情况还是要使用原始的办法，也就是继承RecyclerView.Adapter去一步一步的写，没法偷懒。封装监听器的绑定在下一篇对RecyclerView.Adapter做一个简单的封装2中解决。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 206,968评论 6赞 482
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 88,601评论 2赞 382
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 153,220评论 0赞 344
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 55,416评论 1赞 279
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 64,425评论 5赞 374
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,144评论 1赞 285
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,432评论 3赞 401
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,088评论 0赞 261
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,586评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2赞 325
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1赞 334
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,783评论 4赞 324
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,343评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1赞 262
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2赞 355
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2赞 345

推荐阅读更多精彩内容

  • Android 控件 RecyclerView
    【Android 控件 RecyclerView】 概述 RecyclerView是什么 从Android 5.0...
    Rtia阅读 307,381评论 27赞 439
  • RecyclerView Adapter封装解析
    前言 关于adapter的封装，网上有很多开源库，开发的时候可以直接拿来用，省了很多事。最近闲来无事，想着自己动手...
    谁帮我起个名字阅读 1,277评论 3赞 16
  • 我与双十一的那些事（下）
    我双十一的战利品都基本到位，一些日常用品，像抽纸，湿巾；洗护用品，像洗发水，洗衣液，等等，还有更多，每年...
    垛垛阅读 431评论 0赞 1
  • 搜索引擎优化的概念
    搜索引擎优化的概念 优化工作不是一个一成不变的工作，他需要优化人员时时刻刻去寻找和优化用户...
    T小兜阅读 484评论 0赞 0
  • 2015.7.16 23:52
    竟然已经是这一天的尾巴了，困得无法自拔但还是要写点什么。 走了，匆匆忙忙。大大小小塞进车里的行李，宿舍门外堆着的凌...
    hellolibo阅读 133评论 0赞 1