BindingListAdapter

Introduction: Say goodbye to repeated, redundant custom Adapters , Make the developer's focus on the data, beacuse data-driven UI (告别反复、冗余的自定义 Adapter,让开发者的重点落在数据上,做到数据驱动 UI)
More: Author   ReportBugs   
Tags:

告别反复、冗余的自定义 Adapter,让开发者的重点落在数据上,做到数据驱动 UI

只需要关心 Item,编写 RecyclerView.Adapter 竟然如此简单(重新定义)

English Version

demo

demo.apk

示例

singletype multitype animtor

更多示例

PaoNet : https://github.com/ditclear/paonet

Download

implementation 'com.ditclear:bindinglistadapter:1.0.1'

快速开始

体验一下创建一个单类型 RecyclerView.Adapter,只需要简单的 3 步

  1. Item创建 databinding 形式的list_item.xml文件

    <?xml version="1.0" encoding="utf-8"?>
    <layout xmlns:android="http://schemas.android.com/apk/res/android"
            xmlns:app="http://schemas.android.com/apk/res-auto">
    
        <data>
    
            <variable
                    name="item"
                    type="String"/>
            <variable
                    name="presenter"
                    type="io.ditclear.bindingadapter.ItemClickPresenter"/>
        </data>
    
        <TextView
                android:layout_width="match_parent"
                android:layout_height="?actionBarSize"
                android:onClick="@{(v)->presenter.onItemClick(v,item)}"
                android:gravity="center"
                android:text="@{item}"/>
    </layout>
    
  2. Activity/Fragment文件中创建我们的数据源dataSource和对应的SingleTypeAdapter

    val dataSource=ObservableArrayList<T>() //通常位于 ViewModel 层
    val mAdapter by lazy {
        SingleTypeAdapter<T>(this, R.layout.list_item, dataSource)
       .apply{
           itemPresenter=this@currentActity
       }
    }
    
  3. 进行adapterrecyclerView的绑定

    recyclerView.apply{
        adapter = mAdapter
          layoutManager = LinearLayoutManager(context)
    }
    

Over,大功告成。接下来只需改变数据源DataSource即可

//add item
dataSource.add(item)
//remove item
dataSource.remove(item) // or dataSource.removeAt(indexOfItem)
//setNewList
dataSource.clear()
dataSource.addAll(newList)
//batch remove 
dataSouce.rangeRemove(startIndex ,offset) //kotin extension

//and so on

Why?

Android 的databinding框架提供了ObservableArrayList类,它提供了对应于 RecyclerView.Adapter 的几个回调。

        dataSource.addOnListChangedCallback(object : ObservableList.OnListChangedCallback<ObservableList<T>>() {
            override fun onChanged(contributorViewModels: ObservableList<T>) {
                notifyDataSetChanged()
            }

            override fun onItemRangeChanged(contributorViewModels: ObservableList<T>, i: Int, i1: Int) {
                notifyItemRangeChanged(i, i1)
            }

            override fun onItemRangeInserted(contributorViewModels: ObservableList<T>, i: Int, i1: Int) {
                notifyItemRangeInserted(i, i1)
            }

            override fun onItemRangeMoved(contributorViewModels: ObservableList<T>, i: Int, i1: Int, i2: Int) {
                notifyItemMoved(i, i1)
            }

            override fun onItemRangeRemoved(contributorViewModels: ObservableList<T>, i: Int, i1: Int) {
                if (contributorViewModels.isEmpty()) {
                    notifyDataSetChanged()
                } else {
                    notifyItemRangeRemoved(i,i1)
                }

            }
        })

所以只需要在对应的回调中调用 Adapter 对应的方法即可,再也不用手动调用 adapter.notifyDataChanged()了。

具体代码见SingleTypeAdapter.kt

而最 Magic 的地方在于使用了 DataBinding 技术之后我们不用再为 Adapter 的 Item 创建对应的 ViewHolder 类,当然也不需要再去findView然后设置什么textclick事件 。这也是为何在以前需要创建多个 Adapter 的原因。

在 DataBinding 中这些都不需要再考虑,开发者只需要注意数据对不对和在 xml 中绑定对应的值就好,具体到了单个 Item。

如何做到的?

仅需几行代码。。BindingViewAdapter.kt


override fun onBindViewHolder(holder: BindingViewHolder<ViewDataBinding>, position: Int) {
        val item = list[position]
        //pending binding itemModel
        holder.binding.setVariable(BR.item,item)
        //pending binding presenter
        holder.binding.setVariable(BR.presenter, itemPresenter)
        holder.binding.executePendingBindings()
        //set decorator
        itemDecorator?.decorator(holder, position, getItemViewType(position))
    }

 override fun onCreateViewHolder(parent: ViewGroup, viewType: Int) =
            BindingViewHolder(DataBindingUtil.inflate<ViewDataBinding>(mLayoutInflater, layoutRes, parent, false))

用前面的list_item.xml来作为例子

holder.binding 即 DataBinding 框架为其生成的ListItemBinding对象

setVariable(BR.item,item)即将需要的对象给我们的 binding 文件,可以看一下ListItemBindingsetVariable方法

@Override
    public boolean setVariable(int variableId, @Nullable Object variable)  {
        boolean variableSet = true;
        if (BR.item == variableId) {
            setItem((java.lang.String) variable);
        }
        else if (BR.presenter == variableId) {
            setPresenter((io.ditclear.bindingadapter.ItemClickPresenter) variable);
        }
        else {
            variableSet = false;
        }
            return variableSet;
    }

BR.item 和 BR.presenter 便是我们需要的 Key 值。

那它们又是从哪来的呢?了解 DataBinding 的已经知道了

   <data>

        <variable
                name="item"
                type="String"/>
        <variable
                name="presenter"
                type="io.ditclear.bindingadapter.ItemClickPresenter"/>
    </data>

在 xml 文件中,即指定了我们需要的 key 和需要的对象类型。

因为在onBindViewHolder方法已经指定了它们的 key 值为 item 和 presenter。

所以任何相应的 xx_item.xml 文件中 variable 都需要是这两者,否则数据无法正常绑定。而且可以算得上是团队规范的一种。

所以,我们只需要关心怎么在 xml 将数据绑定到对于的 View 上就完事了,写一个 Adapter 竟然如此简单。

Usage

提供了 SingleTypeAdapter 和 MultiTypeAdapter

  • SingleTypeAdapter 单类型
val dataSource=ObservableArrayList<T>()
val mAdapter by lazy {
    SingleTypeAdapter<T>(this, R.layout.list_item, dataSource)
}
  • MultiTypeAdapter 多类型
val dataSource=ObservableArrayList<Any>()
val mAdapter by lazy {
    MultiTypeAdapter(this, dataSource, object : MultiTypeAdapter.MultiViewTyper {
        override fun getViewType(item: Any): Int =
            when(item){  //返回对应的 Item View type
                is ItemWrapper -> item.type
                is String -> ItemType.TYPE_5
                else -> throw Resources.NotFoundException("${item::class} 找不到相应的 ViewType")
            }

    }).apply {
        //将布局类型与布局对应
        addViewTypeToLayoutMap(ItemType.TYPE_0, R.layout.multi_type_0)
        addViewTypeToLayoutMap(ItemType.TYPE_1, R.layout.multi_type_1)
        addViewTypeToLayoutMap(ItemType.TYPE_2, R.layout.multi_type_2)
        addViewTypeToLayoutMap(ItemType.TYPE_3, R.layout.multi_type_3)
        addViewTypeToLayoutMap(ItemType.TYPE_4, R.layout.multi_type_4)
        addViewTypeToLayoutMap(ItemType.TYPE_5, R.layout.multi_type_5)
        }
    }

the same as ArrayList 具体见SingleTypeListKotlin.ktMultiTypeListKotlin.kt

改变数据源 dataSource 即可,通过回调在内部会调用 Adapter 相应的 notify 方法

因此方法与 ArrayList 相同

//add item
dataSource.add(item)
//remove item
dataSource.remove(item) // or dataSource.removeAt(indexOfItem)
//setNewList
dataSource.clear()
dataSource.addAll(newList)
//batch remove 
dataSouce.rangeRemove(startIndex ,offset) //kotin extension

//and so on

监听

提供了 ItemClickPresenter来处理点击事件。

//单类型,可根据 view 的 id 进行相应的处理
override fun onItemClick(v: View, item: String) {
     Toast.makeText(this,item,Toast.LENGTH_SHORT).show()
}
//多类型,根据 view 的 id 和 item 的类型进行区分处理或者获取到 index 然后更加 ViewType 来进行区分
 override fun onItemClick(v: View, item: Any) {
        when(item){
            is ItemWrapper -> Toast.makeText(this, item.bean, Toast.LENGTH_SHORT).show()
            is String -> Toast.makeText(this, item.split("").reversed().joinToString(""), Toast.LENGTH_SHORT).show()
        }
    }

装饰器

如果以上不能满足需求,可以通过设置 ItemDecorator 来进行附加的设置

override fun decorator(holder: BindingViewHolder<ViewDataBinding>, position: Int, viewType: Int) {
      //可根据 viewType 进行区分
    //do sth..
}

动画

提供两种可选动画ScaleInItemAnimatorAlphaInItemAnimator

    mAdapter.itemAnimator = ScaleInItemAnimator(interpolator = OvershootInterpolator())
    mAdapter.itemAnimator = AlphaInItemAnimator(interpolator = DecelerateInterpolator())

可通过实现itemAnimator接口进行自定义动画

interface ItemAnimator{

    fun scrollUpAnim(v:View)

    fun scrollDownAnim(v: View)
}

Thanks To

markzhai/DataBindingAdapter

License

MIT

Support Me
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea