开源框架BaseRecyclerViewAdapterHelper使用——RecyclerView万能适配器

前言

• 主要声明三点

• 第一：
  关于本文的BaseRecyclerViewAdapterHelper用法，自然是转载的官方原文。

• 第二：
  本文所有内容都是官网上所有的，所以我要特别声明：

1、本文其实只是按照自己的排版习惯重新排版而已；
2、在重写排版的基础上，增加了一些简单的Demo，以及我在写Demo过程中碰上的少量的问题，当然这些问题仅仅是我个人使用的时候碰上的，正如第一条所说的，我本身也是小白，也是在学习阶段，对很多东西也是理解的不够，所以会导致或多或少的问题，所以我像我其他文章一样，我还是强烈建议不幸看到本文的同行去看原文学习使用：BRVAH官方使用指南（持续更新）http://www.jianshu.com/p/b343fcff51b0

• 第三：
  该适配器虽号称万能适配器，但并非万能，有很多功能本身是实现不了的，还会和其他开源的冲突，比如不能和XRecyclerView一起使用（至少我用的时候是真的冲突）。

• 第四：
  关于文章中所提到的 "bug"，我相信都不存在，只是由于时间关系，无心再去研究，但是我也坚信你继续看本文，还是能够知道该适配器的使用方式的。

一、框架引入

• 先在项目的 build.gradle(Project:XXXX) 的 repositories 添加:

    allprojects {
        repositories {
            ...
            maven { url "https://jitpack.io" }
        }
    }

• 然后在Module的 build.gradle(Module:app) 的 dependencies 添加:

    dependencies {
            ......
            compile 'com.github.CymChad:BaseRecyclerViewAdapterHelper:2.9.22'
    }

注意： 一旦出现加载失败的情况，只有两种情况:

• 一是：配置没配置好

配置没配置好，有几种情况：
1. 只配置了 dependencies
2. 配置 repositories，但是位置错了，build.gradle(Project:XXXX) 文件下的repositories有两个，一个是buildscript下面的，一个是allprojects下面的，要配置到allprojects下面才是对的。
3. 版本号前面多一个v，这个是我的锅，在2.1.2版本之前都是带v的，之后（包含2.1.2）都不需要带v。

• 二是：网络原因（这个就不解释了）

二、Adapter的最基本使用方法

2.1 常用示例代码

• 和原生的adapter相比，减少70%的代码量。

• 首先看一段使用示例代码：

public class QuickAdapter extends BaseQuickAdapter<Status, BaseViewHolder> {
    public QuickAdapter() {
        super(R.layout.tweet, DataServer.getSampleData());
    }

    @Override
    protected void convert(BaseViewHolder viewHolder, Status item) {
        viewHolder.setText(R.id.tweetName, item.getUserName())
                .setText(R.id.tweetText, item.getText())
                .setText(R.id.tweetDate, item.getCreatedAt())
                .setVisible(R.id.tweetRT, item.isRetweet())
                .linkify(R.id.tweetText);
                 Glide.with(mContext).load(item.getUserAvatar()).crossFade().into((ImageView) viewHolder.getView(R.id.iv));
    }
}

• 从上文中的实例代码我们可以看出以下几点：

1、使用: 首先需要继承BaseQuickAdapter,然后BaseQuickAdapter<Status, BaseViewHolder>第一个泛型Status是数据实体类型，第二个BaseViewHolder是ViewHolder其目的是为了支持扩展ViewHolder。
2、赋值：可以直接使用viewHolder对象点相关方法通过传入viewId和数据进行，方法支持链式调用。如果是加载网络图片或自定义view可以通过viewHolder.getView(viewId)获取该控件。

• 当然这里有一个比较常用的方法：

viewHolder.getLayoutPosition() 获取当前item的position

2.2 最基本使用示例Demo

• 要是刚接触Android的朋友要是还是不知道怎么用，那我这里提供一个很简单的demo：

• 比如说我想要实现的效果大致如下：

   

  

• 第一步：在布局文件中引入RecyclerView
  activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <android.support.v7.widget.RecyclerView
        android:id="@+id/recycler_view"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />
</RelativeLayout>

• 第二步：编写条目布局文件
  item_rv.xml

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:padding="5dp">

    <ImageView
        android:id="@+id/iv_img"
        android:layout_width="150dp"
        android:layout_height="80dp" />

    <TextView
        android:id="@+id/tv_title"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_gravity="center_vertical"
        android:layout_marginLeft="10dp"
        android:layout_marginTop="10dp"
        android:layout_toRightOf="@+id/iv_img"
        android:text="我是标题"
        android:textColor="#f00"
        android:textSize="20sp" />

    <TextView
        android:id="@+id/tv_content"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_below="@+id/tv_title"
        android:layout_marginLeft="10dp"
        android:layout_marginTop="10dp"
        android:layout_toRightOf="@id/iv_img"
        android:text="我是描述" />
</RelativeLayout>

• 第三步：编写数据实体类型
  Model.java

public class Model {
    private String title;
    private String content;
    private String imgUrl;

    //生成set、get方法
    ......
}

• 第四步：编写适配器
  MyAdapter.java

public class MyAdapter extends BaseQuickAdapter<Model, BaseViewHolder> {

    public MyAdapter(@LayoutRes int layoutResId, @Nullable List<Model> data) {
        super(layoutResId, data);
    }

    @Override
    protected void convert(BaseViewHolder helper, Model item) {
        //可链式调用赋值
        helper.setText(R.id.tv_title, item.getTitle())
                .setText(R.id.tv_content, item.getContent())
                .setImageResource(R.id.iv_img, R.mipmap.ic_launcher);

        //获取当前条目position
        //int position = helper.getLayoutPosition();
    }
}

• 最后一步：在Activity中使用该适配器
  MainActivity.java

public class MainActivity extends AppCompatActivity {

    private RecyclerView recyclerView;
    private List<Model> datas;
    private MyAdapter adapter;

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

        //初始化RecyclerView
        recyclerView = (RecyclerView) findViewById(R.id.recycler_view);

        //模拟的数据（实际开发中一般是从网络获取的）
        datas = new ArrayList<>();
        Model model;
        for (int i = 0; i < 15; i++) {
            model = new Model();
            model.setTitle("我是第" + i + "条标题");
            model.setContent("第" + i + "条内容");
            datas.add(model);
        }

        //创建布局管理
        LinearLayoutManager layoutManager = new LinearLayoutManager(this);
        layoutManager.setOrientation(LinearLayoutManager.VERTICAL);
        recyclerView.setLayoutManager(layoutManager);

        //创建适配器
        adapter = new MyAdapter(R.layout.item_rv, datas);

        //给RecyclerView设置适配器
        recyclerView.setAdapter(adapter);
    }
}

• OK，运行，得到的效果就是上述的效果。

三、点击事件

• 上文中描述的就是使用BaseRecyclerViewAdapterHelper最基本的用法，因为怕刚接触Android的兄弟们不明朗或不相信这么简单的用法，所以做了上节简单的demo示例用法。

• 那么使用列表当然少不了点击事件，不论是整个条目的点击事件还是条目中子控件的点击事件，该适配器对点击事件也是做了及简化的处理：

3.1 条目事件

Item的点击事件

        //条目点击事件
        adapter.setOnItemClickListener(new BaseQuickAdapter.OnItemClickListener() {
            @Override
            public void onItemClick(BaseQuickAdapter adapter, View view, int position) {

                Toast.makeText(MainActivity.this, "点击了第" + (position + 1) + "条条目", Toast.LENGTH_SHORT).show();
            }
        });

Item的长按事件