BaseRecyclerViewAdapterHelper万能适配器

在我最近开发的一个Android项目当中，用到列表的地方非常多。用RecyclerView+BaseRecyclerViewAdapterHelper（开源框架）可以帮我们节省大量的代码（约节省三分之二），RecyclerView不用多说大家非常熟悉，谷歌推荐的列表控件，代替了传统的ListView，更加强大和灵活。BaseRecyclerViewAdapterHelper是一个非常强大的开源框架，它基本上可以解决我们开发中的列表布局。在这里记录一下这个框架。

框架引入

先在项目的 build.gradle中的 repositories 添加

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

然后在Module的 build.gradle中的 dependencies 添加

	dependencies {
            implementation 'com.github.CymChad:BaseRecyclerViewAdapterHelper:2.9.47'
    }

基本使用

首先我们在Activity中有一个RecyclerView

<?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="match_parent">

    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/recycler"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>

</LinearLayout>

再新建一个item布局，item布局是一个简单的头像和名字

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="horizontal"
    android:layout_width="match_parent"
    android:layout_height="60dp"
    android:layout_marginVertical="5dp">

    <ImageView
        android:id="@+id/iv_head"
        android:layout_width="50dp"
        android:layout_height="50dp"
        android:layout_marginStart="10dp"
        android:layout_gravity="center_vertical"
        android:src="@mipmap/ic_launcher"/>

    <TextView
        android:id="@+id/tv_name"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginStart="10dp"
        android:layout_gravity="center_vertical"
        android:text="张三"
        android:textSize="18sp"
        android:textColor="#000000"/>

</LinearLayout>

再根据item所需数据，编写数据实体类型

public class User {
    private String headUrl;
    private String name;

    public User(String headUrl, String name) {
        this.headUrl = headUrl;
        this.name = name;
    }

    public String getHeadUrl() {
        return headUrl;
    }

    public void setHeadUrl(String headUrl) {
        this.headUrl = headUrl;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

接下来就要用到我们的BaseRecyclerViewAdapterHelper框架来编写适配器

public class UserAdapter extends BaseQuickAdapter<User, BaseViewHolder> {
    public UserAdapter(int layoutResId, @Nullable List<User> data) {
        super(layoutResId, data);
    }

    @Override
    protected void convert(BaseViewHolder helper, User item) {
        Glide.with(mContext).load(item.getHeadUrl()).into((ImageView)helper.getView(R.id.iv_head));
        helper.setText(R.id.tv_name, item.getName());
    }
}

在这里我们用到图片加载框架，非常的好用，一行代码就可以加载url图片等，这里就不详细多说，GitHub地址：https://github.com/bumptech/glide

最后一步就是在我们的Activity使用该适配器

public class MainActivity extends AppCompatActivity {
    private RecyclerView recycler;

    private List<User> userList;

    private UserAdapter adapter;

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

        recycler = findViewById(R.id.recycler);

        //模拟数据，实际开发中一般是从后台获取数据
        userList = new ArrayList<>();
        for (int i = 0; i < 20; i++) {
            userList.add(new User("http://img2.imgtn.bdimg.com/it/u=3749323882,846155126&fm=26&gp=0.jpg",
                    "第" + i + "条"));
        }

        //设置布局管理
        recycler.setLayoutManager(new LinearLayoutManager(this));
        //创建适配器
        adapter = new UserAdapter(R.layout.item_recycler, userList);
        //给RecyclerView设置适配器
        recycler.setAdapter(adapter);
    }
}

这样就是RecyclerView+BaseRecyclerViewAdapterHelper的基本使用，效果如下

点击事件

使用列表那当然也少不了点击事件，不论是整个item的点击事件还是item中的子控件都可以实现。

item的点击事件

		adapter.setOnItemClickListener(new BaseQuickAdapter.OnItemClickListener() {
            @Override
            public void onItemClick(BaseQuickAdapter adapter, View view, int position) {
                Toast.makeText(MainActivity.this, "点击了第" + position + "条", Toast.LENGTH_SHORT).show();
            }
        });

item的长按事件

		adapter.setOnItemLongClickListener(new BaseQuickAdapter.OnItemLongClickListener() {
            @Override
            public boolean onItemLongClick(BaseQuickAdapter adapter, View view, int position) {
                Toast.makeText(MainActivity.this, "长按了第" + position  + "条", Toast.LENGTH_SHORT).show();
                return false;
            }
        });

item中子控件的点击事件
首先在适配器中绑定子控件

public class UserAdapter extends BaseQuickAdapter<User, BaseViewHolder> {
    public UserAdapter(int layoutResId, @Nullable List<User> data) {
        super(layoutResId, data);
    }

    @Override
    protected void convert(BaseViewHolder helper, User item) {
        Glide.with(mContext).load(item.getHeadUrl()).into((ImageView)helper.getView(R.id.iv_head));
        helper.setText(R.id.tv_name, item.getName());
        //绑定点击事件
        helper.addOnClickListener(R.id.iv_head);
        helper.addOnClickListener(R.id.tv_name);
    }
}

接着在activity中就可以监听到子控件的点击事件，根据view.getId()来区分点击了哪一个子控件

		adapter.setOnItemChildClickListener(new BaseQuickAdapter.OnItemChildClickListener() {
            @Override
            public void onItemChildClick(BaseQuickAdapter adapter, View view, int position) {
                switch (view.getId()) {
                    case R.id.iv_head:
                        Toast.makeText(MainActivity.this, "点击了第" + position + "的头像",
                                Toast.LENGTH_SHORT).show();
                        break;
                    case R.id.tv_name:
                        Toast.makeText(MainActivity.this, "点击了第" + position + "的名字",
                                Toast.LENGTH_SHORT).show();
                        break;
                    default:
                        break;
                }
            }
        });

子控件的长按事件也是如此。

常用方法

上面介绍了基本的使用方法，还有很多常用的方法这里列举一下：

方法名	说明
getData()	获取适配器中的数据
addData(data)	向列表中添加数据（可一条，可多条）
setData(position, data)	修改指定位置的数据
setNewData(List)	设置适配器新的数据
notifyDataSetChanged()	刷新适配器
remove(position)	删除指定数据

BaseRecyclerViewAdapterHelper还有很多其他功能，例如列表加载动画、下拉刷新、上拉加载、添加分组、自定义不同的item、拖拽item等，这里就不一一列举出来，有兴趣的可以去官方GitHub了解更多，地址如下：https://github.com/CymChad/BaseRecyclerViewAdapterHelper

初入安卓，有哪里写的不对，希望各位大佬指出来