给 Adapter 做 “加法” —— 实战 MergeAdapter

什么是 MergeAdapter ?

在最新的 recyclerview:1.2.0-alpha02 中发布了一个关于 Adapter 的新特性 MergeAdapter 。我们可以 “合并”Adapter,或者说给 Adapter “做加法”。

听起来可能不是那么容易理解。我们先来看下面的 RecyclerView 应该如何实现?

Merge Adapter

源码地址见文末。

实现起来其实很简单,利用现有的知识,大部分人都能想到用多类型的 itemView 。这里要区分三种类型,Teacher ,Student 和 Foot 。不同的类型要对应不同的布局文件,同样也对应不同的业务逻辑。

长久以来我们一直都是这么做的。那么,你有没有想过这么做有什么不合理的地方吗?耦合度过高 。上面的示例中一个 Adapter 需要负责三套视图布局的呈现,如果是四套,五套,甚至更多呢?从 扩展性 上来说,这个方案也不尽合理。

既然如此,那就让每个 Adapter 只负责一套视图布局。既降低了代码耦合度,又便于扩展。如果出现了新的布局类型,再来一个 Adapter 就行了。上面的示例中一共需要三个 Adapter,TeahcherAdapterStudentAdapterFootAdapter

TeahcherAdapter 负责展示列表最上面 Teacher 部分的视图。
StudentAdapter 负责展示列表主体 Student 部分的视图。
FootAdapter 负责展示列表底部加载状态的视图,包含加载中和无更多数据。

看起来很美好,各司其职,互不干扰。然而问题时,你的 RecyclerView 可以接受几个 Adapter ?

    public void setAdapter(@Nullable Adapter adapter) {
        // bail out if layout is frozen
        setLayoutFrozen(false);
        setAdapterInternal(adapter, false, true);
        processDataSetCompletelyChanged(false);
        requestLayout();
    }

RecyclerView 显然是 “一夫一妻制” 。通过 setAdapter() 方法,我们只能给 RecyclerView 设置一个 Adapter 。

recyclerview:1.2.0-alpha02 中,其实我们仍然只能设置一个 Adapter ,但是这个 Adapter 可以是 MergeAdapter ,一个可以做加法的 Adapter 。

直接上代码。

private val teacherAdapter by lazy { TeacherAdapter() }
private val studentAdapter by lazy { StudentAdapter() }
private val stateAdapter by lazy { StateAdapter() }

val mergeAdater  = MergeAdapter(teacherAdapter, studentAdapter, footAdapter)

recyclerView.adapter = mergeAdapter

使用方法就是如此的朴实无华,甚至有那么一点枯燥。MergeAdapter 构造函数中的参数顺序,就标识了列表中数据的显示顺序。

第一块布局是 Teacher 。在实际开发中,常常可以用作 Header View 。

class TeacherAdapter : ListAdapter<Teacher, TeacherViewHolder>(TeacherDiffCallback()) {
    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): TeacherViewHolder {
        return TeacherViewHolder(
            ItemTeacherBinding.inflate(
                LayoutInflater.from(parent.context),
                parent,
                false
            )
        )
    }

    override fun onBindViewHolder(holder: TeacherViewHolder, position: Int) {
        holder.bind(getItem(position))
    }

}

第二块布局是 Student 。也就是实际开发中的真正的列表数据。

class StudentAdapter : ListAdapter<Student, StudentViewHolder>(StudentDiffCallBack()) {
    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): StudentViewHolder {
        return StudentViewHolder(
            ItemStudentBinding.inflate(
                LayoutInflater.from(parent.context),
                parent,
                false
            )
        )
    }

    override fun onBindViewHolder(holder: StudentViewHolder, position: Int) {
       holder.bind(getItem(position))
    }
}

最后一块布局是状态布局,也就是通常的 Footer 。包含正在加载,加载失败和无更多数据,三种状态。

class FootAdapter : ListAdapter<LoadState, StateViewHolder>(StateDiffCallBack()) {
    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): StateViewHolder {
        return StateViewHolder(
            ItemStateBinding.inflate(
                LayoutInflater.from(parent.context),
                parent,
                false
            )
        )
    }

    override fun onBindViewHolder(holder: StateViewHolder, position: Int) {
        holder.bind(getItem(position))
    }
}

和平常的 Adapter 写法并无二致。

有什么好处 ?

众所周知,RecyclerView 是一个设计极其精妙的类库,从源码里可以发现很多设计模式的身影。MergeAdapter 也不例外。

将一个 Adapter 负责多套布局,拆分为每个 Adapter 只处理一个布局,大大降低代码耦合,这是 单一职责原则

面对新的需求,需要给 RecyclerView 增加一个新类型的 View。我们需要做的仅仅只是添加新的 Adapter ,而无需修改之前的适配器代码。对扩展开放,对修改封闭,这是 开闭原则

有什么限制 ?

如上面的例子所示,MergeAdapter 的数据展示顺序,是按照构造函数中的参数顺序依次排列的,而且同类型的数据总是集中展示的。所以,对于不确定性的,动态类型的复杂视图,MergeAdapter 是无法处理的。

另外说一点,称不上限制,应该说对 MergeAdapter 能力的期望。如果能支持多 LayoutManager 那就更好了。在多类型 RecyclerView 中,部分数据需要横向滑动展示,部分数据需要纵向滑动展示,这种情况已经比较常见了。

最后

MergeAdapter 的一些学习资源。

Android 开发团队的相关介绍:

https://medium.com/androiddevelopers/merge-adapters-sequentially-with-mergeadapter-294d2942127a

掘金译文:

https://juejin.im/post/5e86ffea51882573ba207a19

文中示例源码地址:

https://github.com/lulululbj/Sample


这里是秉心说,欢迎关注我的公众号,第一时间为你带来 Android 最新动态。

Copyright: 采用 知识共享署名4.0 国际许可协议进行许可

Links: https://luyao.tech/archives/mergeadapter