MoreType

new method to build data in RecyclerView with Kotlin!

Github: https://github.com/Werb/MoreType

关键词:【数据驱动视图】

之前在写公司的项目的时候，需要写大量的界面，这就意味着每一个界面都要写一个 Adapter，同时还要对不同的视图根据 getItemViewType() 写不同的 ViewHolder，在存在多种视图的时候，一个 Adapter 中的代码就会很冗余，而且耦合度很高，对后续的修改很不友好。

我们任意一个界面都是依靠服务器返回的数据构建的，所以我就在想，能不能简单的使用数据来驱动视图，这就也是 MoreType 的核心所在【数据驱动视图】。

我并不是第一个想到这个概念的人，我最早看到这个概念的实践，是 drakeet 的 MultiType 。当时看完他的项目之后，有一种醍醐灌顶的畅快，这就是我所希望的【数据驱动视图】。

大概在一个月前，开始接触 Kotlin，Kotlin 是一个让开发者用起来很爽的语言，不必深陷烦人的空指针异常，简洁的代码风格，在初次尝时候我就喜欢上了它，所以我决定用 Kotlin 来开发一个【数据驱动视图】的第三方库，从而就有了 MoreType 的产生【给你更多的可能】。

目前 MoreType 仍在开发，当前版本为 0.1.0-beta 版本，因为是基于 AS Preview 开发的，可能会有一些未知的 Bug

Release 版本将会在这个月底发布.

Preview

MoreType - new method to build data in RecyclerView with Kotlin!_第1张图片

Dependency

compile 'com.werb.moretype:moretype:0.1.0-beta'

implementation 'com.werb.moretype:moretype:0.1.0-beta'

Usage

Keyword: 【数据驱动视图】

Step 1. 创建一个数据模型类，例如:

data class SingleText(val title: String, val desc: String, val url: String)

class SingleText {
    var title: String? = null
    var desc: String? = null
    var url: String? = null
}

Step 2. 创建一个类 xxxViewType 继承抽象类 `MoreViewType()` 例如:

import kotlinx.android.synthetic.main.item_view_single_type_one.view.*

class SingleTypeOneViewType: MoreViewType() {

    override fun getViewLayout(): Int = R.layout.item_view_single_type_one

    override fun getViewModel(): KClass = SingleText::class

    override fun bindData(data: SingleText, holder: MoreViewHolder) {
        holder.itemView.title.text = data.title
        holder.itemView.desc.text = data.desc
        holder.itemView.icon.setImageURI(data.url)

    }
}

使用 kotlin-android-extensions 替代 findViewById()

getViewLayout()：返回视图的 layout
getViewModel()：返回视图所对应的数据模型 data::class
bindData(): 绑定数据，处理点击等

Step 3. 在使用 `RecyclerView` 的地方，声明 `MoreAdapter()`对象，`register` 需要的 `viewType`，同时和 `RecyclerView` 绑定

import kotlinx.android.synthetic.main.activity_single_register.*

class SingleRegisterActivity: AppCompatActivity() {

    private val adapter = MoreAdapter()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_single_register)

        list.layoutManager = LinearLayoutManager(this)

        /* register viewType and attach to recyclerView */
        adapter.register(TitleViewType())
                .register(SingleTypeOneViewType())
                .attachTo(list)

        /* load any data List or model object */
        adapter.loadData(DataServer.getSingleRegisterData())

    }

}

使用 kotlin-android-extensions 替代 findViewById()

完成这三步，一个根据【数据驱动视图】的列表就已经构建完成。

Feature

Multi Register: Register one2more ViewType

通常我们的数据和视图是一对一的关系，比如瀑布流。MoreType 同时提供一种数据类型对应多种视图的情况，例如私信界面。

adapter.register(TitleViewType())
        .multiRegister(Message::class, object : MultiLink {
            override fun link(data: Message): MoreViewType? {
                if (data.me) {
                    return MessageOutViewType()
                } else {
                    return MessageInViewType()
                }
            }
        })
        .attachTo(multi_register_list)

Multi Register 必须显式声明 Data::class

Animation: Provides five types of Animation

提供五种动画支持: Alpha , Scale , SlideInBottom , SlideInLeft , SlideInRight

    adapter.register(TitleViewType())
            .register(AnimViewType())
            /* assign Animation */
            .renderWithAnimation(AlphaAnimation())
            /* set Animation start position in list */
            .startAnimPosition(1)
            /* set is always show animation or show in first display */
            .firstShowAnim(true)
            .attachTo(anim_list)

同时支持自定义动画, 创建一个类实现接口 MoreAnimation and 重写 getItemAnimators(view: View) 例如:

class SlideInLeftAnimation : MoreAnimation {

    override fun getItemAnimators(view: View): Array{
        return arrayOf(ObjectAnimator.ofFloat(view, "translationX", -view.rootView.width.toFloat(), 0f))
    }

}

ItemClick: Support onItemClick and onItemLongClick

两种方式实现点击事件: In ViewType and In Activity

In ViewType 中处理点击事件 : 在viewType中使用 view.setOnClickListener {}

In Activity 中处理点击事件 :

在 viewType 中使用 holder.addOnClickListener(view: View) or holder.addOnClickListener(viewId: Int) 绑定点击事件
在 Activity 中通过 viewType().setMoreClickListener() 处理点击事件

sample

Refresh and loadMore

Refresh: 使用 SwipeRefreshLayout 就可以实现下拉刷新

LoadMore: 通过构建 Footer.class 和 FootViewType 实现数据和视图的绑定, 当 RecyclerView 滚动在底部时显示 FootViewType，在数据请求成功后移除 FootViewType

sample

全局 ViewType

在自定义 Application中注册全局 ViewType

class MyApp: Application() {

   companion object {
       @Volatile lateinit var myApp: MyApp
           private set
   }

    override fun onCreate() {
        super.onCreate()
        myApp = this
        // Sole Global Register, like footer , Cutting line
        MoreType.soleRegister(FoorViewType())
    }
}

通过 adapter.userSoleRegister() 调用使用全局 ViewType

Thanks

MultiType

recyclerview-animators

LICENSE

Apache License

MoreType - new method to build data in RecyclerView with Kotlin!