尝试编写一个不需要记忆的工具（以RecyclerView的Adapter为例）-优快云博客

本文链接：https://blog.youkuaiyun.com/zssrxt/article/details/139068281

过去开发Android的时候，RecyclerView是一个非常常用的类，但是RecyclerView.Adapter却用起来有些麻烦，于是就根据需要写了很多XXXAdapter之类的工具，也有很多开源可用的Adapter工具。如果只用一个，养成习惯后不成问题，但是如果比较多，就容易忘记或记错混淆。于是就有了一个想法：我能不能写一个不需要去记忆的工具，即便很长时间没用忘记了，也可以直接上手用。本文以NeoListAdapter为例，来分享我的思考和实现方式。

注意：本文目标旨在分享一种通过建造者链达到类似“引导”的api组织方式，恰好是以NeoListAdapter为例，如果你对使用/实现感到反感，那你是对的，因为NeoListAdapter是根据我个人习惯随便写的

目标场景

我想要写一个工具类NeoListAdapter用于取代ListAdapter在一些简单的数据展示场景的使用，并且代码更加简洁，最重要的：不需要特别去记。

实现效果（使用过程）

先展示下最终的效果，以便说明为什么“不需要特别去记”。（大家可以把文章末尾NeoListAdapter类复制到Android项目中，跟着下面的步骤操作，体会更深刻）

首先设想一个列表，里面要显示各种多媒体文件，包括音乐和视频。那么必然会有两个数据类：Music和Video，可能还都继承自Media。与之对应的ViewHolder自然是MusicHolder和VideoHolder。

为了让这些数据显示到RecyclerView中，我们需要一个Adapter，比如NeoListAdapter。那么问题来了，假设我不知道如何构建NeoListAdapter对象，也不知道它有哪些方法，正常情况这个时候就要去查文档和使用说明。但是，NeoListAdapter这个工具的设计并需要看文档，而是让编辑器的提示来告诉我们怎么用。

步骤1

输入NeoListAdapter，按下.，我们能看到两个静态方法dataFrom（接受数据list）和dataFor（接受数据类型class）。没错，这就是一种提问：你想要为哪些数据构建Adapter/你想要为什么类型的数据构建Adapter？于是我们可以写下下面这样的代码：

NeoListAdapter.dataFrom(mediaList) // mediaList 为外部定义的 List<Media> 类型的对象
// 或
NeoListAdapter.dataFor(Media.class)

步骤2

再次按下.，我们就看到了下面这些方法：

contentDiffBy(BiPredicate<T, T> contentSamePredicate)：对应DiffUtil.ItemCallback的areContentsTheSame
itemDiffBy(BiPredicate<T, T> itemSamePredicate)：对应DiffUtil.ItemCallback的areItemsTheSame
diffByDefault()
diffBy(DiffUtil.ItemCallback<T> itemCallback)和diffBy(BiPredicate<T, T> itemSamePredicate, BiPredicate<T, T> contentSamePredicate)

也就是说，这一步提出的问题是：如何区别（diff）item？contentDiffBy和itemDiffBy对应ListAdapter需要的DiffUtil.ItemCallback的两个方法实现，其中diffByDefault则表示使用equals方法来实现。

于是我们可以写下下面这些代码：

NeoListAdapter
        .dataFor(mediaList)
        .diffByDefault()
//或
NeoListAdapter
        .dataFor(mediaList)
        .diffBy(Objects::equals, (m1,m2) -> Objects.equals(m1.path, m2.path))

步骤3

再次按下.，我们就看到了下面这些方法：

withHolder(Function<Descriptor.DescriptorBuilder<T>, Descriptor<? extends T, H>> descriptorCreator)

参数的类型很长，有些复杂，从方法名来看，可以视为提问：需要显示哪些ViewHolder？而参数是一个名为descriptorCreator的Function，这是一个将一个构造器转换为Descriptor的过程，这个Descriptor自然描述的是对应ViewHolder的信息。

于是我们写下：

NeoListAdapter
        .dataFor(mediaList)
        .diffBy(Objects::equals, (m1,m2) -> Objects.equals(m1.path, m2.path))
        .withHolder((builder) -> {
   
            // 返回什么呢        
        })

那么我们如何得到Descriptor呢？

步骤3.1

输入builder后再次按下.，编辑器提示holderOf(Class<H> holderClass)方法，意思是：你要为哪类ViewHolder创建Descriptor？这里需要提供一个ViewHolder的class，比如：

NeoListAdapter
        .dataFor(mediaList)
        .diffBy(Objects::equals, (m1,m2) -> Objects.equals(m1.path, m2.path))
        .withHolder((builder) -> builder
                .holderOf(VideoHolder.class))

步骤3.2

holderOf的返回值不符合要求，我们再次输入.，看到了下面两个方法：

createBy(Function<ViewGroup, H> function)
createByDefault()

意思就是：要如何创建该类型的ViewHolder对象？createBy需要提供一个从ViewGroup创建ViewHolder对象的过程；而createByDefault根据默认方式创建（这需要对应ViewHolder提供单个ViewGroup参数的构造方法，且该ViewHolder类不为非静态内部类）。因此，我们可以这样写

NeoListAdapter
        .dataFor(mediaList)
        .diffBy(Objects::equals, (m1,m2) -> Objects.equals(m1.path, m2.path))
        .withHolder((builder) -> builder
                .holderOf(VideoHolder.class)
                .createByDefault())
//或
NeoListAdapter
        .dataFor(mediaList)
        .diffBy(Objects::equals, (m1,m2) -> Objects.equals(m1.path, m2.path))
        .withHolder((builder) -> builder
                .holderOf(VideoHolder.class)
                .createBy(VideoHolder::new))
//或
NeoListAdapter
        .dataFor(mediaList)
        .diffBy(Objects::equals, (m1,m2) -> Objects.equals(m1.path, m2.path))
        .withHolder((builder) -> builder
                .holderOf(VideoHolder.class)
                .createBy(viewGroup -> new VideoHolder(viewGroup)))

步骤3.3

返回值仍然不满足要求，继续.，我们看到下面5个方法：

inWherePositionOf(int position)和inWherePositionOf(Function<NeoListAdapter<T>, Integer> positionMapper)，在指定position的位置才可以显示
inWhereTypeOf(Class<D> clazz)：list中数据类型为clazz的位置才可以显示
inWhereSatisfy(Predicate<T> predicate)：满足predicate才可以显示
inAllPlace()：在所有位置都可以显示

这就是在问：在什么位置显示这个ViewHolder？我可以这样写：

NeoListAdapter
        .dataFor(mediaList)
        .diffBy(Objects::equals, (m1,m2) -> Objects.equals(m1.path, m2.path))
        .withHolder((builder) -> builder
                .holderOf(VideoHolder.class)
                .createBy(viewGroup -> new VideoHolder(viewGroup))
                .inWhereTypeOf(Video.class))
//或
NeoListAdapter
        .dataFor(mediaList)
        .diffBy(Objects::equals, (m1,m2) -> Objects.equals(m1.path, m2.path))
        .withHolder((builder) -> builder
                .holderOf(VideoHolder.class)
                .createBy(viewGroup -> new VideoHolder(viewGroup))
                .inWhereSatisfy(media -> media instanceof Video)