打造一个通用的 RecyclerView Adapter

前言

在平时的开发中,我们经常会需要开发一个列表页,这时我们第一时间就能想到 RecyclerView,添加一个 Adapter,复写其中的方法,再添加一个 ViewHolder,等等。
当我们的列表越来越多的时候,就会让人很抓狂,不仅每次都要写很多重复代码,而且 Adapter 类的数量也会越来越多。
有没有什么办法能够优雅的避免每次添加重复代码吗?今天给大家分享一个简单的 Adapter 封装,可以让我们少写 90% 的重复代码。

通常的做法

一般情况下,我们要实现一个列表的步骤是这样的
添加一个 Adapter

public class SampleAdapter extends RecyclerView.Adapter<RecyclerView.ViewHolder> {
    private List<String> dataList;
    public SampleAdapter(List<String> dataList) {
        this.dataList = dataList;
    }
    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        if (viewType == 0) {
            // 加载View
            View view = new View(parent.getContext());
            return new SampleViewHolder1(view);
        } else {
            // 加载View
            View view = new View(parent.getContext());
            return new SampleViewHolder2(view);
        }
    }
    @Override
    public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {
        if (holder instanceof SampleViewHolder1) {
            ((SampleViewHolder1) holder).bind(dataList.get(position));
        } else {
            ((SampleViewHolder2) holder).bind(dataList.get(position));
        }
    }
    @Override
    public int getItemCount() {
        return dataList.size();
    }
    @Override
    public int getItemViewType(int position) {
        return position % 2;
    }
    private class SampleViewHolder1 extends RecyclerView.ViewHolder {
        public SampleViewHolder1(View itemView) {
            super(itemView);
        }
        public void bind(String data) {
            // ...
        }
    }
    private class SampleViewHolder2 extends RecyclerView.ViewHolder {
        public SampleViewHolder2(View itemView) {
            super(itemView);
        }
        public void bind(String data) {
            // ...
        }
    }
}

这里省略了部分代码。
可以看出,其实 Adapter 里面的都是重复代码,既然是重复代码,那么一定有办法抽象出来。

封装 Adapter

我们的目标是创造一个通用的 Adapter,那么就要在 Adapter 上做文章。
由于 Adapter 只有一个,而 ViewHolder 可能有多个,为了使 Adapter 和 ViewHolder 能够形成一对多的关系,而且 Adapter 可以随时根据 position 获取对应的 ViewHolder,我们需要一个桥梁

public interface RAdapterDelegate<T> {
    Class<? extends RViewHolder<T>> getViewHolderClass(int position);
}

桥梁已经有了,需要我们在 Activity 中实现,我们让它作为构造 Adapter 的参数传入

public RAdapter(List<T> dataList, RAdapterDelegate<T> delegate) {
    this.dataList = dataList;
    this.delegate = delegate;
}

然后考虑多种布局方式,其实不过是每一个 ViewHolder 对应一个唯一的整数,我们很容易就能想到将 ViewHolder 放在一个 List 中,每一个 ViewHolder 对应一个下标,下标即可作为 viewType。

private List<Class<? extends RViewHolder<T>>> viewHolderClassList = new ArrayList<>();
@Override
public int getItemViewType(int position) {
    Class<? extends RViewHolder<T>> clazz = delegate.getViewHolderClass(position);
    if (!viewHolderClassList.contains(clazz)) {
        viewHolderClassList.add(clazz);
    }
    return viewHolderClassList.indexOf(clazz);
}

接下来到了构造 ViewHolder 的时候了,构造 ViewHolder 需要一个 View,作为构造函数的参数传入,这样我们就不能把 layout 作为 ViewHolder 的属性了,因为必须在初始化 ViewHolder 之前得到它。
总不能让 layout 也从 Delegate 中获取吧,这样太蠢了,那么有什么方法能够把 ViewHolder 和 layout 绑定,并且在 ViewHolder 初始化之前得到 layout 呢?
我们可以用注解,是的,将 ViewHolder 的 class 和 layout 绑定起来,就能实现我们想要的效果。
新建一个注解类

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface RLayout {
    @LayoutRes int value();
}

ViewHolder 需要添加注解,将 layout 绑定起来。
有了 ViewHolder 类和 View,我们就可以构造 ViewHolder 了

@Override
public RViewHolder<T> onCreateViewHolder(ViewGroup parent, int viewType) {
    try {
        Class<? extends RViewHolder<T>> clazz = viewHolderClassList.get(viewType);
        int resId = getLayoutResId(clazz);
        View view = LayoutInflater.from(parent.getContext()).inflate(resId, parent, false);
        Constructor constructor = clazz.getConstructor(View.class);
        RViewHolder<T> viewHolder = (RViewHolder<T>) constructor.newInstance(view);
        viewHolder.setAdapter(this);
        return viewHolder;
    } catch (Exception e) {
        throw new IllegalStateException("create view holder error", e);
    }
}

// 考虑到 ViewHolder 的继承,这里会去遍历 ViewHolder 的父类
private int getLayoutResId(Class<?> clazz) {
    if (clazz == RViewHolder.class) {
        return 0;
    }
    RLayout bind = clazz.getAnnotation(RLayout.class);
    if (bind == null) {
        // 找不到去父类找
        return getLayoutResId(clazz.getSuperclass());
    }
    return bind.value();
}

采用了反射的方式构造出 ViewHolder。
接下来就比较简单了,就剩下给 ViewHolder 填充内容了

@Override
public void onBindViewHolder(RViewHolder<T> holder, int position) {
    try {
        holder.setPosition(position);
        holder.setData(dataList.get(position));
        holder.refresh();
    } catch (Exception e) {
        Log.e(TAG, "bind view holder error", e);
    }
}

接下来看一下 ViewHolder 基类的代码

public abstract class RViewHolder<T> extends RecyclerView.ViewHolder {
    protected Context context;
    protected View itemView;
    protected RAdapter<T> adapter;
    protected T data;
    protected int position;
    public RViewHolder(View itemView) {
        super(itemView);
        this.itemView = itemView;
        context = itemView.getContext();
        ViewBinder.bind(this, itemView);
    }
    public void setAdapter(RAdapter<T> adapter) {
        this.adapter = adapter;
    }
    public void setData(T t) {
        this.data = t;
    }
    public void setPosition(int position) {
        this.position = position;
    }
    public abstract void refresh();
}

添加了一些属性,方便我们使用。

下面我们使用封装好的 Adapter,实现一开始的那个列表

// Activity 中
List<String> dataList = new ArrayList<>();
RAdapterDelegate<String> delegate = (RAdapterDelegate<String>) position -> {
    if (position % 2 == 0) {
        return SampleViewHolder1.class;
    } else {
        return SampleViewHolder2.class;
    }
};
RAdapter<String> adapter = new RAdapter<>(dataList, delegate);
recyclerView.setAdapter(adapter);

// SampleViewHolder
// 通过注解指定 layoutResId
@RLayout(R.layout.sample_view_holder)
public class SampleViewHolder extends RViewHolder<String> {
    public SampleViewHolder(View itemView) {
        super(itemView);
    }
    @Override
    public void refresh() {
        // 这里实现渲染逻辑
    }
}

有没有感觉代码量骤降?而且是一劳永逸。
当然大家也可以基于该 Adapter 继续扩展更多功能。

混淆配置

由于我们是通过反射来构造 ViewHolder,因此要避免构造方法被混淆工具移除,添加以下配置即可

-keepclassmembers class * extends 包名.RViewHolder {
    public <init>(android.view.View);
}

源码

源码

总结

今天的内容比较简单,提供了一种对 RecyclerView Adapter 封装的思路,减少重复代码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342