打造一個通用的 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 封裝的思路，減小重複代碼。

遷移自個人簡書 2018.01.19