美文网首页Android
对RecyclerView.Adapter做一个简单的封装

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

作者: 柠檬果然酸 | 来源:发表于2018-06-06 22:26 被阅读0次

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中解决。

相关文章

网友评论

    本文标题:对RecyclerView.Adapter做一个简单的封装

    本文链接:https://www.haomeiwen.com/subject/criyjftx.html