Kotlin实现MultiTypeAdapter，RecyclerView显示多类型ViewHolder

目的#

1. 由于Recyclerview显示的内容可能为不同类型的数据，对应的布局也不同。为了适应一种或多种都能显示，设计一种模式，能否兼容。
2. 传统做法，在每个Adapter中复写getItemViewType，返回相应的ViewHolder的Type，然后在onCreateViewHolder中对ViewType进行判断，返回相应的ViewHolder。
3. 文章需要解决的问题就是2，只需写相应的ViewHolder而不用去修改Adapter
4. 本文参考文章
   http://www.jianshu.com/p/c6a44e18badb
   http://blog.csdn.net/maiduoudo/article/details/54619448

效果图

思路

实现支持多类型单ViewHolder的Adapter

1. 实现BaseViewHolder
   所有用到的ViewHolder的父类，拥有泛型和抽象方法abstract fun setData(t: T, position: Int, adapter: BaseAdapter)
2. 实现BaseAdapter
   继承RecyclerView.Adapter>()，拥有参数var mList: ArrayList? = null供Adapter设置数据源

实现支持多类型多ViewHolder的Adapter

1. 实现基类Visitable
   所有实体类的父类，并带有抽象方法abstract fun type(typeFactory: TypeFactory): Int

2. 实现类型解析工厂TypeFactory
   基类Visitable抽象方法type中的参数，提供解析实体类的类型

3. 实现MultiTypeAdapter
   MultiTypeAdapter是一个通用的、支持一个或多个类型数据的Adapter

实现支持多类型单ViewHolder的Adapter

针对同一类型的数据显示，只需单一的ViewHolder即可完成所有展示任务，但是对于不同的数据类型，也可以支持。

1. BaseViewHolder
   抽象的BaseViewHolder，带有泛型和抽象方法setData供设置数据

abstract class BaseViewHolder constructor(itemView: View) : RecyclerView.ViewHolder(itemView) {

    var context: Context = itemView.context

    abstract fun setData(t: T, position: Int, adapter: BaseAdapter)
}

2. BaseAdapter
   BaseAdapter带有参数mList作为数据源，并在onBindViewHolder中实现点击事件。

open class BaseAdapter : RecyclerView.Adapter>() {
    var mList: ArrayList? = null // 数据源
    override fun onBindViewHolder(holder: BaseViewHolder?, position: Int) {
        if (onItemClickListener != null && holder != null) {
            holder.itemView.setOnClickListener({
                run {
                    onItemClickListener?.onRecyclerViewItemClick(position)
                }
            })
        }
    }
    override fun getItemCount(): Int {
        return 0
    }
    override fun onCreateViewHolder(parent: ViewGroup?, viewType: Int): BaseViewHolder {
        return null!!
    }
    var onItemClickListener: OnRecyclerViewItemClickListener? = null
}

OnRecyclerViewItemClickListener.kt

interface OnRecyclerViewItemClickListener{
    fun onRecyclerViewItemClick(position: Int)
}

3.实现如上两步，自己写一个ViewHolder，在加一个数据源就可以展示数据了。如：

class MainListAdapter : BaseAdapter() {

    override fun onCreateViewHolder(parent: ViewGroup?, viewType: Int): BaseViewHolder {
        val view: View = LayoutInflater.from(parent?.context).inflate(R.layout.item_main, parent, false)
        return MainHolder(view)
    }

    override fun onBindViewHolder(holder: BaseViewHolder?, position: Int) {
        holder?.setData(mList?.get(position)!!, position, this)
        super.onBindViewHolder(holder, position)
    }

    override fun getItemCount(): Int {
        if (mList != null)
            return (mList as ArrayList).size
        else
            return 0
    }

    class MainHolder constructor(itemView: View) : BaseViewHolder(itemView) {

        var tvTitle: TextView = itemView.findViewById(R.id.tv_title)
        var tvContent: TextView = itemView.findViewById(R.id.tv_content)

        override fun setData(t: ActivityInfo, position: Int, adapter: BaseAdapter) {
            tvTitle.text = t.title
            tvContent.text = t.content
        }
    }
}

设置点击事件

adapter.onItemClickListener = (object : OnRecyclerViewItemClickListener {
            override fun onRecyclerViewItemClick(position: Int) {
                makeShortToast(activity, "title = ${results[position].title} , content =${results[position].content}")
                val intent = Intent(this@MainActivity,DestinationActivity::class.java)
                startActivity(intent)
            }
        })

多类型但是单ViewHolder的Adapter到此就可以实现。

多类型多ViewHolder的Adapter

1. 将每个layout的ID作为ViewHolder的Type
2. 将每个ViewHolder需要展示的数据都继承Visitable
3. 在TypeFactory中注册，在Adapter的getItemType方法中去获取

Visitable

本例参照两篇文章，实现两种数据类型：Animal和Car，其中Animal有Mouse、Duck、Dog。

abstract class Visitable {
    abstract fun type(typeFactory: TypeFactory): Int
}

abstract class Animal : Visitable()

class Dog(val name: String = "Dog") : Animal() {
    var age: Int = 1

    override fun type(typeFactory: TypeFactory): Int {
        return typeFactory.type(this)
    }
}

class Car(val brand: String = "BENZ") : Visitable() {
    var price = 100000
    override fun type(typeFactory: TypeFactory): Int {
        return typeFactory.type(this)
    }
}

其中，Dog有name和age连个参数，Car有brand和price两个参数。

TypeFactory

定义接口TypeFactory，将每种数据类型添加一个方法fun type(t: T): Int。注意，这个T必须是Visitable或其子类。 createViewHolder方法为根据具体的typeId返回ViewHolder

interface TypeFactory {
    fun type(dog: Dog): Int
    fun type(car: Car): Int

    fun createViewHolder(type: Int, view: View): BaseViewHolder
}

class TypeFactoryForList : TypeFactory {

    override fun type(dog: Dog) = R.layout.item_top
    override fun type(car: Car) = R.layout.item_image

    override fun createViewHolder(type: Int, view: View): BaseViewHolder {
        when (type) {
            R.layout.item_top -> {
                return DogViewHolder(view)
            }
            R.layout.item_image -> {
                return CarViewHolder(view)
            }
            else -> return DogViewHolder(view)
        }
    }
}

DogViewHolder和CarViewHolder

我们可以在setData里设置点击事件等

class DogViewHolder constructor(view: View) : BaseViewHolder(view) {

    override fun setData(t: Visitable, position: Int, adapter: BaseAdapter) {
        if (t is Dog)
            Log.e("DogViewHolder", "I'm Dog. My name is ${t.name} , my age is ${t.age}")
    }
}

MultiTypeAdapter编写

由于mList并不是构造函数的参数，所以有许多为空的判断。可新增一个构造方法，将mList放入其中，这样就不会每次都要去判断为空了。

class MultiTypeAdapter : BaseAdapter() {

    var typeFactory: TypeFactory = TypeFactoryForList()

    override fun onBindViewHolder(holder: BaseViewHolder?, position: Int) {
        holder?.setData(mList?.get(position)!!, position, this)// 设置数据
    }

    override fun onCreateViewHolder(parent: ViewGroup?, viewType: Int): BaseViewHolder {
        val view: View = LayoutInflater.from(parent?.context).inflate(viewType, parent, false)
        return typeFactory.createViewHolder(viewType, view)// 根据Type去获取ViewHolder
    }

    override fun getItemCount(): Int {
        return mList?.size!!
    }

    override fun getItemViewType(position: Int): Int {
        return mList?.get(position)?.type(typeFactory)!!// 去获取ViewHolder类型
    }
}

调用

一段简单的调用

val rvList = findViewById(R.id.rv_destination)
        val list: ArrayList = ArrayList()
        val dog: Dog = Dog("Dog1")
        val car: Car = Car("Car1")
        list.add(dog)
        list.add(dog)
        list.add(car)
        list.add(car)

        val adapter = DestinationAdapter()
        adapter.mList = list
        val layoutManager = LinearLayoutManager(this)
        layoutManager.orientation = LinearLayout.VERTICAL
        rvList.layoutManager = layoutManager
        rvList.adapter = adapter

通过上述的代码编写，基本可以实现多类型多ViewHolder在同一Recyclerview种显示，并且可以很好的控制点击事件

Question

• 为何在DogViewHolder和CarViewHolder要使用Visitable而不适用Dog或Car。并且在setData方法中使用了if判断是否为Dog 或 Car？
• 原因在于：fun createViewHolder(type: Int, view: View): BaseViewHolder这段代码中，Kotlin在返回BaseViewHolder时，必须要实例化泛型，而java代码可以不实例化。DogViewHolder在创建时，这就会出现一下情况：
  1.不声明泛型，就是文章上述所写；
  2.声明泛型为，则在setData方法中的Dog并非我们之前定义的Dog，而是通过DogViewHolder声明的，此时也需要用if去判断是否为我们定义的Dog
  上述两种方式都需要去判断，否则无法使用Dog中的参数。
• 若有更好的解决方式，可以提供。