Recyclerview适配器2.0（一）

第一篇主要内容为基本功能的搭建（item点击、长按和子View的点击、长按）

public abstract class BaseQuickAdapter<T, VH extends BaseViewHolder> extends RecyclerView.Adapter<VH> {

    protected abstract void convert(@NonNull VH holder, T item, int position);

    private Context context;
    //点击位置
    private int clickLocation = 0;

    public List<T> data;
    //单布局id
    private int layoutResId;
    //是否是多布局
    protected boolean isMultiItem;
    //多布局所有的id集合
    protected SparseIntArray layouts;

    /**
     * 单布局构造函数
     */
    public BaseQuickAdapter(@LayoutRes int layoutResId, List<T> data) {
        isMultiItem = false;
        this.data = data;
        this.layoutResId = layoutResId;
    }

    /**
     * 多布局
     */
    public BaseQuickAdapter(List<BaseMultiItemEntity> data) {
        isMultiItem = true;
        this.data = (List<T>) data;
        layouts = new SparseIntArray();
        for (BaseMultiItemEntity t : data) {
            layouts.put(t.getItemType(), t.getItemType());
        }
    }

    @NonNull
    @Override
    public VH onCreateViewHolder(@NonNull ViewGroup viewGroup, int viewType) {
        context = viewGroup.getContext();
        
        return onCreateDefViewHolder(viewGroup, viewType);
    }

    /**
     * Override this method and return your ViewHolder.
     * 重写此方法，返回你的ViewHolder。
     */
    protected VH onCreateDefViewHolder(ViewGroup parent, int viewType) {
        //获取布局View
        View view;
        LayoutInflater mLayoutInflater = LayoutInflater.from(context);
        if (isMultiItem) {
            view = mLayoutInflater.inflate(getLayoutId(viewType), parent, false);
        } else {
            view = mLayoutInflater.inflate(layoutResId, parent, false);
        }
        return createBaseViewHolder(view);
    }

    @Override
    public void onBindViewHolder(@NonNull VH holder, int position) {
        T item = null;
        if (position >= 0 && position < data.size()) {
            item = data.get(position);
        }
        
        convert(holder, item, position);
        //设置item的点击事件/长按事件
        bindViewClickListener(holder, position);
    }

    @Override
    public int getItemCount() {
        return data.size();
    }

    /**
     * 获取多布局中指定多布局
     */
    protected int getLayoutId(@LayoutRes int viewType) {
        return layouts.get(viewType);
    }

    /**
     * 如果要在适配器中使用BaseViewHolder的子类，
     * 必须覆盖该方法以创建新的ViewHolder。
     */
    protected VH createBaseViewHolder(View view) {
        Class<?> temp = getClass();
        Class<?> z = null;
        while (z == null && null != temp) {
            z = getInstancedGenericKClass(temp);
            temp = temp.getSuperclass();
        }
        VH vh;
        // 泛型擦除会导致z为null
        if (z == null) {
            vh = (VH) new BaseViewHolder(view);
        } else {
            vh = createGenericKInstance(z, view);
        }
        return vh != null ? vh : (VH) new BaseViewHolder(view);
    }

    /**
     * 得到通用参数.
     */
    private Class<?> getInstancedGenericKClass(Class<?> z) {
        Type type = z.getGenericSuperclass();
        if (type instanceof ParameterizedType) {
            Type[] types = ((ParameterizedType) type).getActualTypeArguments();
            for (Type temp : types) {
                if (temp instanceof Class) {
                    Class<?> tempClass = (Class<?>) temp;
                    if (BaseViewHolder.class.isAssignableFrom(tempClass)) {
                        return tempClass;
                    }
                } else if (temp instanceof ParameterizedType) {
                    Type rawType = ((ParameterizedType) temp).getRawType();
                    if (rawType instanceof Class && BaseViewHolder.class.isAssignableFrom((Class<?>) rawType)) {
                        return (Class<?>) rawType;
                    }
                }
            }
        }
        return null;
    }

    /**
     * 创建新的ViewHolder
     */
    private VH createGenericKInstance(Class<?> z, View view) {
        try {
            Constructor<?> constructor;
            if (z.isMemberClass() && !Modifier.isStatic(z.getModifiers())) {
                constructor = z.getDeclaredConstructor(getClass(), View.class);
                constructor.setAccessible(true);
                return (VH) constructor.newInstance(this, view);
            } else {
                constructor = z.getDeclaredConstructor(View.class);
                constructor.setAccessible(true);
                return (VH) constructor.newInstance(view);
            }
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * item的点击事件/长按事件
     */
    protected void bindViewClickListener(final VH baseViewHolder, final int position) {
        if (baseViewHolder == null) {
            return;
        }
        final View view = baseViewHolder.itemView;
        //事件
        if (onItemClickListener != null) {
            view.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    onItemClickListener.onItemClick(view, position);
                }
            });
        }
        if (onItemLongClickListener != null) {
            view.setOnLongClickListener(new View.OnLongClickListener() {
                @Override
                public boolean onLongClick(View v) {
                    return onItemLongClickListener.onItemLongClick(view, position);
                }
            });
        }
        if (mOnItemChildClickListener != null) {
            for (int id : childClickViewIds) {
                View childView = view.findViewById(id);
                if (!childView.isClickable()) {
                    childView.setClickable(true);
                }
                childView.setOnClickListener(new View.OnClickListener() {
                    @Override
                    public void onClick(View v) {
                        mOnItemChildClickListener.onItemChildClick(BaseQuickAdapter.this, v, position);
                    }
                });
            }
        }
        if (onItemChildLongClickListener != null) {
            for (int id : childLongClickViewIds) {
                View childView = view.findViewById(id);
                if (!childView.isLongClickable()) {
                    childView.setLongClickable(true);
                }
                childView.setOnLongClickListener(new View.OnLongClickListener() {
                    @Override
                    public boolean onLongClick(View v) {
                        return onItemChildLongClickListener.onItemChildLongClick(BaseQuickAdapter.this, v, position);
                    }
                });
            }
        }
    }

    /**
     * item 点击事件
     */
    private OnItemClickListener onItemClickListener;

    public interface OnItemClickListener {
        void onItemClick(View view, int position);
    }

    public void setOnItemClickListener(OnItemClickListener onItemClickListener) {
        this.onItemClickListener = onItemClickListener;
    }

    public OnItemClickListener getOnItemClickListener(){
        return onItemClickListener;
    }

    /**
     * item 长按事件
     */
    private OnItemLongClickListener onItemLongClickListener;

    public interface OnItemLongClickListener {
        boolean onItemLongClick(View view, int position);
    }

    public void setOnItemLongClickListener(OnItemLongClickListener onItemLongClickListener) {
        this.onItemLongClickListener = onItemLongClickListener;
    }

    public OnItemLongClickListener getOnItemLongClickListener(){
        return onItemLongClickListener;
    }

    /**
     * 用于保存需要设置点击事件的 item
     */
    private final LinkedHashSet<Integer> childClickViewIds = new LinkedHashSet<>();

    public LinkedHashSet<Integer> getChildClickViewIds() {
        return childClickViewIds;
    }

    /**
     * 设置需要点击事件的子view
     */
    public void addChildClickViewIds(@IdRes int... viewIds) {
        for (int viewId : viewIds) {
            childClickViewIds.add(viewId);
        }
    }

    private OnItemChildClickListener mOnItemChildClickListener;

    public interface OnItemChildClickListener {
        void onItemChildClick(@NonNull BaseQuickAdapter<?, ?> adapter, @NonNull View view, int position);
    }

    public void setOnItemChildClickListener(OnItemChildClickListener listener) {
        mOnItemChildClickListener = listener;
    }

    public OnItemChildClickListener getOnItemChildClickListener(){
        return mOnItemChildClickListener;
    }

    /**
     * 用于保存需要设置长按点击事件的 item
     */
    private final LinkedHashSet<Integer> childLongClickViewIds = new LinkedHashSet<>();

    public LinkedHashSet<Integer> getChildLongClickViewIds() {
        return childLongClickViewIds;
    }

    /**
     * 设置需要长按点击事件的子view
     */
    public void addChildLongClickViewIds(@IdRes int... viewIds) {
        for (int viewId : viewIds) {
            childLongClickViewIds.add(viewId);
        }
    }

    private OnItemChildLongClickListener onItemChildLongClickListener;

    public interface OnItemChildLongClickListener {
        boolean onItemChildLongClick(@NonNull BaseQuickAdapter<?, ?> adapter, @NonNull View view, int position);
    }

    public void setOnItemChildLongClickListener(OnItemChildLongClickListener listener) {
        onItemChildLongClickListener = listener;
    }

    public OnItemChildLongClickListener getOnItemChildLongClickListener(){
        return onItemChildLongClickListener;
    }

    public Context getContext() {
        return context;
    }

    /**
     * 设置点击位置
     */
    public void setClickLocation(int clickLocation) {
        if (this.clickLocation != clickLocation) {
            //获取前一次点击的position
            int beforePosition = this.clickLocation;
            //获取当前点击position
            this.clickLocation = clickLocation;
            //刷新点击项
            notifyItemChanged(clickLocation);
            if (beforePosition >= 0) {
                //刷新前一次点击位置
                notifyItemChanged(beforePosition);
            }
        }
    }

    /**
     * 获取点击位置
     */
    public int getClickLocation() {
        return clickLocation;
    }

    /**
     * 获取默认位置
     */
    public void setDefaultPosition(int position) {
        clickLocation = position;
    }

    /**
     * 获取指定位置数据
     */
    public T getItem(@IntRange(from = 0) int position) {
        return data.get(position);
    }

    /**
     * 获取指定元素的位置
     * 如果返回 -1，表示不存在
     */
    public int getItemPosition(T item) {
        if (item != null && !data.isEmpty()) {
            return data.indexOf(item);
        }
        return -1;
    }

    /**
     * 在列表最后添加一个item
     *
     * @param element item的数据
     */
    public void addNewItem(@NonNull T element) {
        data.add(element);
        notifyItemInserted(data.size());
        compatibilityDataSizeChanged(1);
    }

    /**
     * 在指定位置添加一个item，如果position越界则添加到列表最后
     *
     * @param position item添加的位置
     * @param element  item的数据
     */
    public void addNewItem(@IntRange(from = 0) int position, @NonNull T element) {
        if (position < data.size()) {
            data.add(position, element);
            //更新数据集用notifyItemInserted(position)与notifyItemRemoved(position) 否则没有动画效果。
            //首个Item位置做增加操作
            notifyItemInserted(position);
            compatibilityDataSizeChanged(1);
        } else {
            addNewItem(element);
        }
    }

    /**
     * 在指定位置添加多个item，如果position越界则添加到列表最后
     * 示例：mAdapter.addData(1, listOf(Person("xin","1"),Person("xin","2")))
     *
     * @param position 插入位置
     * @param newData  多个item的集合
     */
    public void addNewData(@IntRange(from = 0) int position, @NonNull Collection<? extends T> newData) {
        if (position < data.size()) {
            data.addAll(position, newData);
            notifyItemRangeInserted(position, newData.size());
            compatibilityDataSizeChanged(newData.size());
        } else {
            addNewData(newData);
        }
    }

    /**
     * 在列表最后添加多个item
     * 示例：mAdapter.addData(listOf(Person("xin","1"),Person("xin","2")))
     *
     * @param newData 多个item的集合
     */
    public void addNewData(@NonNull Collection<? extends T> newData) {
        data.addAll(newData);
        notifyItemRangeInserted(data.size() - newData.size(), newData.size());
        compatibilityDataSizeChanged(newData.size());
    }

    /**
     * 删除一个指定位置的item，如果position越界则无效
     *
     * @param position 指定item的位置
     */
    public void removeItem(@IntRange(from = 0) int position) {
        if (position < data.size()) {
            data.remove(position);
            notifyItemRemoved(position);
            compatibilityDataSizeChanged(0);
            notifyItemRangeChanged(position, data.size() - position);
        }
    }

    /**
     * 删除一个指定位置的元素，如果position越界则无效
     */
    public void removeItem(T element) {
        int index = data.indexOf(element);
        if (index == -1) {
            return;
        }
        removeItem(index);
    }

    /**
     * 修改某个item的数据，如果position越界则无效
     *
     * @param position item位置
     * @param element  要修改的item数据
     */
    public void replaceItem(@IntRange(from = 0) int position, @NonNull T element) {
        if (position < data.size()) {
            data.set(position, element);
            notifyItemChanged(position);
        }
    }

    /**
     * 修改所有item的数据
     *
     * @param newData 更新item数据的集合
     */
    public void replaceData(Collection<? extends T> newData) {
        if (newData == null || newData.size() == 0) {
            data.clear();
            notifyDataSetChanged();
            return;
        }
        // 不是同一个引用才清空列表
        if (newData != data) {
            data.clear();
            data.addAll(newData);
        }
        notifyDataSetChanged();
    }

    private void compatibilityDataSizeChanged(int size) {
        int dataSize = data == null ? 0 : data.size();
        if (dataSize == size) {
            notifyDataSetChanged();
        }
    }
}

创建Adapter

public class MainAdapter extends BaseQuickAdapter<MainBean, BaseViewHolder> {

    public MainAdapter(int layoutResId, List<MainBean> data) {
        super(layoutResId, data);
    }

    @Override
    protected void convert(@NonNull BaseViewHolder holder, MainBean item, int position) {
        holder.setText(R.id.tv_name, item.getName());
    }
}

基础使用

List<MainBean> mainBeanList = new ArrayList<>();
mainBeanList.add(new MainBean(0, "100"));
mainBeanList.add(new MainBean(1, "200"));
mainBeanList.add(new MainBean(2, "300"));
RecyclerView recyclerView = findViewById(R.id.recyclerView);
MainAdapter mainAdapter = new MainAdapter(R.layout.item_main, mainBeanList);
recyclerView.setLayoutManager(new LinearLayoutManager(this));
recyclerView.setAdapter(mainAdapter);

//item点击
mainAdapter.setOnItemClickListener(new BaseQuickAdapter.OnItemClickListener() {
    @Override
    public void onItemClick(View view, int position) {
        Toast.makeText(getApplicationContext(), "点击" + position, Toast.LENGTH_SHORT).show();
    }
});
//item长按
mainAdapter.setOnItemLongClickListener(new BaseQuickAdapter.OnItemLongClickListener() {
    @Override
    public boolean onItemLongClick(View view, int position) {
        Toast.makeText(getApplicationContext(), "长按" + position, Toast.LENGTH_SHORT).show();
        return true;
    }
});
// 先注册需要点击的子控件id（注意，请不要写在convert方法里）
mainAdapter.addChildClickViewIds(R.id.tv_name);
// 设置子控件点击监听
mainAdapter.setOnItemChildClickListener(new BaseQuickAdapter.OnItemChildClickListener() {
    @Override
    public void onItemChildClick(@NonNull BaseQuickAdapter<?, ?> adapter, @NonNull View view, int position) {
        if (view.getId() == R.id.tv_name) {
            Toast.makeText(getApplicationContext(), "子view点击" + position, Toast.LENGTH_SHORT).show();
        }
    }
});
// 先注册需要长按的子控件id（注意，请不要写在convert方法里）
mainAdapter.addChildLongClickViewIds(R.id.tv_name);
// 设置子控件长按监听
mainAdapter.setOnItemChildLongClickListener(new BaseQuickAdapter.OnItemChildLongClickListener() {
    @Override
    public boolean onItemChildLongClick(@NonNull BaseQuickAdapter<?, ?> adapter, @NonNull View view, int position) {
        if (view.getId() == R.id.tv_name) {
            Toast.makeText(getApplicationContext(), "子view长按" + position, Toast.LENGTH_SHORT).show();
        }
        return false;
    }
});

BaseViewHolder 

package com.example.recyclerview.recycler;

import android.graphics.Bitmap;
import android.graphics.Paint;
import android.graphics.Typeface;
import android.text.util.Linkify;
import android.util.SparseArray;
import android.view.View;
import android.widget.EditText;
import android.widget.ImageView;
import android.widget.TextView;

import androidx.annotation.ColorInt;
import androidx.annotation.ColorRes;
import androidx.annotation.DrawableRes;
import androidx.annotation.IdRes;
import androidx.annotation.NonNull;
import androidx.recyclerview.widget.RecyclerView;

public class BaseViewHolder extends RecyclerView.ViewHolder {

    private final SparseArray<View> views = new SparseArray<>();

    public BaseViewHolder(@NonNull View itemView) {
        super(itemView);
    }

    /**
     * 获取item的view
     *
     * @param viewId view的id
     */
    public <T extends View> T getView(@IdRes int viewId) {
        View view = views.get(viewId);
        if (view == null) {
            view = itemView.findViewById(viewId);
            views.put(viewId, view);
        }
        return (T) view;
    }

    /**
     * 设置EditText的文字
     *
     * @param viewId TextView的id
     * @param value  文本内容
     */
    public BaseViewHolder setEditText(@IdRes int viewId, CharSequence value) {
        EditText view = getView(viewId);
        view.setText(value);
        return this;
    }

    /**
     * 设置TextView的文字
     *
     * @param viewId TextView的id
     * @param value  文本内容
     */
    public BaseViewHolder setText(@IdRes int viewId, CharSequence value) {
        TextView view = getView(viewId);
        view.setText(value);
        return this;
    }

    /**
     * 设置TextView的文字颜色
     *
     * @param viewId    TextView的id
     * @param textColor 文字颜色
     */
    public BaseViewHolder setTextColor(@IdRes int viewId, @ColorInt int textColor) {
        TextView view = getView(viewId);
        view.setTextColor(textColor);
        return this;
    }

    /**
     * 设置TextView的文字颜色
     *
     * @param viewId   TextView的id
     * @param colorRes 文字颜色
     */
    public BaseViewHolder setTextColorRes(@IdRes int viewId, @ColorRes int colorRes) {
        TextView view = getView(viewId);
        view.setTextColor(itemView.getResources().getColor(colorRes));
        return this;
    }

    /**
     * 为TextView创建超链接
     *
     * @param viewId TextView的id
     */
    public BaseViewHolder addLinks(@IdRes int viewId) {
        TextView view = getView(viewId);
        Linkify.addLinks(view, Linkify.ALL);
        return this;
    }

    /**
     * 设置TextView的字体，并启用子像素渲染。
     *
     * @param viewId   TextView的id
     * @param typeface 字体
     */
    public BaseViewHolder setTypeface(@IdRes int viewId, Typeface typeface) {
        TextView view = getView(viewId);
        view.setTypeface(typeface);
        view.setPaintFlags(view.getPaintFlags() | Paint.SUBPIXEL_TEXT_FLAG);
        return this;
    }

    /**
     * 批量设置TextView的字体，并启用子像素渲染。
     *
     * @param typeface 字体
     * @param viewIds  TextView的id
     */
    public BaseViewHolder setTypeface(Typeface typeface, int... viewIds) {
        for (int viewId : viewIds) {
            TextView view = getView(viewId);
            view.setTypeface(typeface);
            view.setPaintFlags(view.getPaintFlags() | Paint.SUBPIXEL_TEXT_FLAG);
        }
        return this;
    }

    /**
     * 设置ImageView的图片
     *
     * @param viewId     ImageView的id
     * @param imageResId 资源文件id
     */
    public BaseViewHolder setImageResource(@IdRes int viewId, @DrawableRes int imageResId) {
        ImageView view = getView(viewId);
        view.setImageResource(imageResId);
        return this;
    }

    /**
     * 设置ImageView的图片
     *
     * @param viewId ImageView的id
     * @param bitmap bitmap
     */
    public BaseViewHolder setImageBitmap(@IdRes int viewId, Bitmap bitmap) {
        ImageView view = getView(viewId);
        view.setImageBitmap(bitmap);
        return this;
    }

    public BaseViewHolder setBackgroundColor(@IdRes int viewId, @ColorInt int color) {
        View view = getView(viewId);
        view.setBackgroundColor(color);
        return this;
    }

    public BaseViewHolder setBackgroundResource(@IdRes int viewId, @DrawableRes int backgroundRes) {
        View view = getView(viewId);
        view.setBackgroundResource(backgroundRes);
        return this;
    }

    public BaseViewHolder setVisible(@IdRes int... viewIds) {
        for (int viewId : viewIds) {
            View view = getView(viewId);
            view.setVisibility(View.VISIBLE);
        }
        return this;
    }

    public BaseViewHolder setGone(@IdRes int... viewIds) {
        for (int viewId : viewIds) {
            View view = getView(viewId);
            view.setVisibility(View.GONE);
        }
        return this;
    }

    public BaseViewHolder setInVisible(@IdRes int... viewIds) {
        for (int viewId : viewIds) {
            View view = getView(viewId);
            view.setVisibility(View.INVISIBLE);
        }
        return this;
    }

    public BaseViewHolder setEnabled(@IdRes int viewId, boolean enable) {
        View view = getView(viewId);
        view.setEnabled(enable);
        return this;
    }

    /**
     * 设置view的标签
     *
     * @param viewId view的id
     * @param tag    标签
     */
    public BaseViewHolder setTag(@IdRes int viewId, Object tag) {
        View view = getView(viewId);
        view.setTag(tag);
        return this;
    }

    /**
     * 设置view的标签
     *
     * @param viewId view的id
     * @param key    key
     * @param tag    标签
     */
    public BaseViewHolder setTag(@IdRes int viewId, int key, Object tag) {
        View view = getView(viewId);
        view.setTag(key, tag);
        return this;
    }
}