通用RecyclerView Adapter之VastBindAdapter

Posted 2022-04-09 码上夏雨

前言

VastBindAdapter 为你提供了快速构建适合于你的 RecyclerView Adapter 的方式

依赖

点击 VastAdapter 查看源码，欢迎Star，fork，并在issue提出改进意见

implementation 'io.github.sakurajimamaii:VastAdapter:0.0.4'

快速开始

通过下面的示例，你可以快速将 VastBindAdapter 运用到你的项目当中。

实现 VastBindAdapterItem 接口

你需要让你列表项实现 VastBindAdapterItem 接口， VastBindAdapterItem 接口提供了事件点击和获取布局id的功能。

// 在Kotlin中使用
class Person(
    val firstName: String, val lastName: String,
    var vbAdpClickEventListener: VAapClickEventListener? = null,
    var vbAdpLongClickEventListener: VAdpLongClickEventListener? = null,
) :VastBindAdapterItem 

    override fun setVBAapClickEventListener(l: VAapClickEventListener?) 
        vbAdpClickEventListener = l
    

    override fun getVBAapClickEventListener(): VAapClickEventListener? 
        return vbAdpClickEventListener
    

    override fun setVBAdpLongClickEventListener(l: VAdpLongClickEventListener?) 
        vbAdpLongClickEventListener = l
    

    override fun getVBAdpLongClickEventListener(): VAdpLongClickEventListener? 
        return vbAdpLongClickEventListener
    

    override fun getVBAdpItemType(): Int 
        return R.layout.item_bind_textview
    

// 在Java中使用
// 你需要重写以下方法
public class Picture implements VastBindAdapterItem 

    private int drawable;
    private VAapClickEventListener clickEventListener;
    private VAdpLongClickEventListener longClickEventListener;

    public Picture(int drawable, VAapClickEventListener clickEventListener, VAdpLongClickEventListener longClickEventListener) 
        this.drawable = drawable;
        this.clickEventListener = clickEventListener;
        this.longClickEventListener = longClickEventListener;
    

    public int getDrawable() 
        return drawable;
    

    public void setDrawable(int drawable) 
        this.drawable = drawable;
    
    
    @Override
    public int getVBAdpItemType() 
        return R.layout.item_bind_imageview;
    

    @Override
    public void setVBAapClickEventListener(@Nullable VAapClickEventListener l) 
        clickEventListener = l;
    

    @Nullable
    @Override
    public VAapClickEventListener getVBAapClickEventListener() 
        return clickEventListener;
    

    @Override
    public void setVBAdpLongClickEventListener(@Nullable VAdpLongClickEventListener l) 
        longClickEventListener = l;
    

    @Nullable
    @Override
    public VAdpLongClickEventListener getVBAdpLongClickEventListener() 
        return longClickEventListener;
    

编辑对应的layout

对于同一列表内的元素，当你使用 data 标签将他们绑定进对应的布局时，他们的 name 字段应该是一样的。

例如：Person 和 Picture 在同一列表中，他们的布局文件内 name 字段均为 item 。

// Person对应的layout
<?xml version="1.0" encoding="utf-8"?>
<layout>
    <data>
        <variable
            name="item"
            type="com.gcode.vastutils.basebindadpexample.model.Person" />
    </data>
    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:orientation="vertical"
        android:layout_width="match_parent"
        android:layout_height="wrap_content">
        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:text="@item.firstName"/>
        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:text="@item.lastName"/>
    </LinearLayout>
</layout>

// Picture对应的layout
<?xml version="1.0" encoding="utf-8"?>
<layout>
    <data>
        <variable
            name="item"
            type="com.gcode.vastutils.basebindadpexample.model.Picture" />
    </data>
    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="vertical">
        <ImageView
            android:id="@+id/item_image"
            android:layout_width="100dp"
            android:layout_height="100dp"
            android:src="@item.drawable"
            android:contentDescription="@string/picture"
            android:layout_gravity="center_horizontal"/>
    </LinearLayout>
</layout>

实现Adapter

// 在Kotlin中使用
class BaseBindingAdapter(
    private val dataSource:MutableList<VastBindAdapterItem>
):BaseVastBindAdapter(dataSource)

    override fun setVariableId(): Int 
        return BR.item
    

// 在Java中使用
public class BaseBindAdapter extends VastBindAdapter 
    public BaseBindAdapter(@NonNull List<VastBindAdapterItem> dataSource) 
        super(dataSource);
    

    @Override
    public int setVariableId() 
        return BR.item;
    

在Activity中使用

下面的示例展示了在 Kotlin 和 Java 环境下的使用

// 在Kotlin中使用
private val datas:MutableList<VastBindAdapterItem> = ArrayList()

for(i in 0..10)
    datas.add(Person(i.toString(),i.toString(),null,null))
    datas.add(Picture(R.drawable.ic_knots,null,null))


// 设置给RecyclerView
val adapter = BaseBindingAdapter(datas)
dataRv.adapter = adapter
dataRv.layoutManager = LinearLayoutManager(this)

// 在java中使用
private ArrayList<VastBindAdapterItem> datas = new ArrayList<>();

for (int i = 0; i < 10; i++) 
    datas.add(new Picture(R.drawable.ic_knots, null, null));


// 设置给RecyclerView
BaseBindAdapter adapter = new BaseBindAdapter(datas);
dataRv.setAdapter(adapter);
dataRv.setLayoutManager(new LinearLayoutManager(this));

添加点击（或长按）事件

对于列表来说，点击事件是必不可少的，VastBindAdapter 支持你为列表设置通用点击事件，当然因为你的类实现了 VastBindAdapterItem 接口，因此你也可以单独为其设定点击事件。

通用点击事件设置

// 在Kotlin中使用
adapter.setOnItemClickListener(object :VastBindAdapter.OnItemClickListener
            override fun onItemClick(view: View, position: Int) 
                // Something you want to do
            
        )
adapter.setOnItemLongClickListener(object :VastBindAdapter.OnItemLongClickListener
            override fun onItemLongClick(view: View, position: Int): Boolean 
                // Something you want to do
                return true
            
        )

// 在java中使用
adapter.setOnItemClickListener((view, position) -> 
            // Something you want to do
        );
adapter.setOnItemLongClickListener((view, position) -> 
            // Something you want to do
            return true;
        );

设置单独点击事件

注意，如果你为某一项单独定义了点击事件，那么他不再支持通用点击事件。

// 在Kotlin中使用
// 定义点击事件
val click = object :VAapClickEventListener
    override fun vAapClickEvent(view: View, pos: Int) 
        showShortMsg("Hello,User.And position is $pos")
    


// 在设置数据源的时候设置
for(i in 0..10)
    datas.add(Person(i.toString(),i.toString(),click,null))
    datas.add(Picture(R.drawable.ic_knots,null,longClick))

// 在java中使用
// 定义点击事件
VAapClickEventListener click = (view, pos) -> 
    ToastUtils.showShortMsg(this,"Hello");
;

// 在设置数据源的时候设置
for (int i = 0; i < 10; i++) 
    datas.add(new Picture(R.drawable.ic_knots, click, null));

为Adapter添加其他功能

下面的示例向你展示了为Adapter增加判断数据源是否为空的功能

// 在kotlin中使用
class BaseBindingAdapter(
    private val dataSource:MutableList<VastBindAdapterItem>
):BaseVastBindAdapter(dataSource) 

    /**
     * 如果集合为空（不包含任何元素），则返回true，否则返回false。
     * @return Boolean
     */
    fun isItemEmpty() = items.isEmpty()

    override fun setVariableId(): Int 
        return BR.item
    

// 在java中使用
public class BaseBindAdapter extends VastBindAdapter 
    private ArrayList<VastBindAdapterItem> datas;

    public BaseBindAdapter(@NonNull List<VastBindAdapterItem> dataSource) 
        super(dataSource);
        datas.addAll(dataSource);
    

    @Override
    public int setVariableId() 
        return BR.item;
    

    public Boolean isEmpty()
        return datas.isEmpty();
    

当然你也可以参考示例应用

绑定适配器使用

在使用 DataBinding 时，我们有时需要自定义一些内容，下面的示例为你演示了如何在 VastBindAdapter 里面使用 @BindingAdapter 。

当然，如果你想了解更多，你可以点击绑定适配器了解更多。

class BaseBindingAdapter(
    private val dataSource:MutableList<VastBindAdapterItem>
):BaseVastBindAdapter(dataSource) 
    companion object 
        @JvmStatic @BindingAdapter("android:src")
        fun setImageUri(view: ImageView, imageUri: String?) 
            if (imageUri == null) 
                view.setImageURI(null)
             else 
                view.setImageURI(Uri.parse(imageUri))
            
        
    

    override fun setVariableId(): Int 
        return BR.item
    

public class BaseBindAdapter extends VastBindAdapter 

    @BindingAdapter("drawableStartCompat")
    public static void loadImage(TextView tv, int resId) 
        Drawable drawable = ResourcesCompat.getDrawable(App.context.getResources(),resId,null);
        tv.setCompoundDrawablesWithIntrinsicBounds(drawable,null,null,null);
    
    
    private ArrayList<VastBindAdapterItem> datas;

    public BaseBindAdapter(@NonNull List<VastBindAdapterItem> dataSource) 
        super(dataSource);
        datas.addAll(dataSource);
    

    @Override
    public int setVariableId() 
        return BR.item;
    

    public Boolean isEmpty()
        return datas.isEmpty();