README_ZH.md

MoreType

new method to build data in RecyclerView with Kotlin!

Click icon download lastest sample

English | 中文版

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

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

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

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

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

与 MultiType 的异同

Preview

Dependency

compile 'com.werb.moretype:moretype:$last_version'

or

implementation 'com.werb.moretype:moretype:$last_version'

Usage

Keyword: 【数据驱动视图】

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

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

or

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

Step 2. 创建一个类 xxxViewHolder 继承抽象类 MoreViewHolder<T : Any>() 例如:

// Register layoutID here or Register with adapter in Activity
@LayoutID(R.layout.item_view_single_type_one)
class SingleTypeOneViewHolder(values: MutableMap<String, Any>, containerView: View) : MoreViewHolder<SingleText>(containerView) {

    override fun bindData(data: SingleText, payloads: List<Any>) {
        title.text = data.title
        desc.text = data.desc
        icon.setImageURI(data.url)
    }

}

Step 3. 在使用 RecyclerView 的地方，声明 MoreAdapter()对象，register 需要的 ViewHolder，同时和 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 ViewHolder and attach to recyclerView */
        adapter.apply {
            // two method register Layout
            register(RegisterItem(R.layout.item_view_single_type_one, SingleTypeOneViewHolder::class.java))
            // or
            register(SingleTypeOneViewHolder::class.java)
            attachTo(single_register_list)
        }

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

    }

}

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

Feature

Multi Register: Register one2more ViewHolder

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

adapter.apply {
    multiRegister(object : MultiLink<Message>() {
        override fun link(data: Message): RegisterItem {
            return if (data.me){
                RegisterItem(R.layout.item_view_multi_message_out, MessageOutViewHolder::class.java)
            }else {
                RegisterItem(R.layout.item_view_multi_message_in, MessageInViewHolder::class.java)
            }
        }
    })
    attachTo(multi_register_list)
}

Animation: Provides five types of Animation

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

    adapter.register(TitleViewHolder())
            .register(AnimViewHolder())
            /* 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<Animator>{
        return arrayOf(ObjectAnimator.ofFloat(view, "translationX", -view.rootView.width.toFloat(), 0f))
    }

}

ItemClick: Support onItemClick and onItemLongClick

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

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

In Activity 中处理点击事件 :

1. 在 ViewHolder 中使用 addOnClickListener(view: View) or addOnClickListener(viewId: Int) 绑定点击事件
2. 在 Activity 中通过 MoreClickListener() 创建点击事件对象，在注册的时候传入即可

sample

Refresh and loadMore

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

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

sample

全局 ViewHolder

在自定义 Application中注册全局 ViewHolder

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(RegisterItem(R.layout.item_view_footer, FootViewHolder::class.java))
    }
}

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

向 ViewHolder 中传递数据

    adapter.apply {
        injectValueInAllHolder(mapOf("qqqqqq" to "1233333333")) // inject in All Holder
        register(MainCardViewHolder::class.java, playLoadClick, mapOf("someValue" to "123")) // inject in single holder
        attachTo(more_list)
    }

Thanks

MultiType

recyclerview-animators

LICENSE

Apache License