RecyclerView自定义添加Header和Footer

前言: 自从上次忘记了某事之后,我就决定了在网上记录下自己学习的一些笔记(有错误请评论告诉我,谢谢

今天突然想起来之前写过的一个项目,首页用的是ScrollView的嵌套,其中里面还嵌套了RecyclerView,在滑动到RecyclerView那一部分的时候有明显的卡顿,觉得应该把整体当作一个RecyclerView不应该用嵌套

原项目效果图:

image

开始自定义一个可以添加Header和Footer的RecyclerView,由于RecyclerView没有自己的addHeaderView方法,所以参考了ListView的代码,整体的代码如下:

CustomRecyclerView 继承自RecyclerView

public class CustomRecyclerView extends RecyclerView {
    private ArrayList<ViewConfig> mHeadCouListInfo; //保存头部的view
    private ArrayList<ViewConfig> mFootCouListInfo; //保存尾部的view
    private int headCount;  //记录head的个数
    private int footCount;  //记录foot的个数
    private Adapter mAdapter; //adapter,可能是customadapter, 可能是自定义adapter
    private Context mContext;

    public CustomRecyclerView(@NonNull Context context) {
        this(context, null);
    }

    public CustomRecyclerView(@NonNull Context context, @Nullable AttributeSet attrs) {
        this(context, attrs, 0);
    }

    public CustomRecyclerView(@NonNull Context context, @Nullable AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
        init(context);
    }

    private void init(Context context) {
        mHeadCouListInfo = new ArrayList<>();
        mFootCouListInfo = new ArrayList<>();
        mContext = context;
    }

    /**
     * 添加HeadView的方法
     *
     * @param view
     */
    public void addHeadView(View view) {
        this.addHeadView(view, 0);
    }

    public void addHeadView(View view, int index) {
        headCount++;
        setHeadViewConfig(view, ViewConfig.HEADVIEW, headCount, 100000);
        if (mAdapter != null) {
            if (!(mAdapter instanceof CustomAdapter)) {
                wrapHeadAdapter();
            }
        }
    }

    public void addFootView(View view) {
        this.addFootView(view, 0);
    }

    public void addFootView(View view, int index) {
        footCount++;
        setFootViewConfig(view, ViewConfig.FOOTVIEW, footCount, 100000);
        if (mAdapter != null) {
            if (!(mAdapter instanceof CustomAdapter)) {
                wrapHeadAdapter();
            }
        }
    }

    /**
     * 将adapter构建为customadapter用来填充头部尾部布局
     */
    private void wrapHeadAdapter() {
        mAdapter = new CustomAdapter(mHeadCouListInfo, mFootCouListInfo, mAdapter, mContext);
    }

    @Override
    public void setAdapter(@Nullable Adapter adapter) {
        if (mHeadCouListInfo.size() > 0 || mFootCouListInfo.size() > 0) {
            mAdapter = new CustomAdapter(mHeadCouListInfo, mFootCouListInfo, adapter, mContext);
        } else {
            mAdapter = adapter;
        }
        super.setAdapter(mAdapter);
    }

    /**
     * 配置头部view的信息
     *
     * @param view
     * @param type
     * @param count
     * @param headCount
     */
    private void setHeadViewConfig(View view, String type, int count, int headCount) {
        ViewConfig viewConfig = new ViewConfig();
        viewConfig.setTag(view.getClass() + type + count);
        viewConfig.setType(headCount);
        viewConfig.setView(R.layout.item_tv);
        ViewGroup parent = (ViewGroup) view.getParent();
        if (parent != null) {
            parent.removeView(view);
        }
        viewConfig.setContentView(view);
        mHeadCouListInfo.add(viewConfig);
    }

    /**
     * 配置尾部view的信息
     *
     * @param view
     * @param type
     * @param count
     * @param headCount
     */
    private void setFootViewConfig(View view, String type, int count, int headCount) {
        ViewConfig viewConfig = new ViewConfig();
        viewConfig.setTag(view.getClass() + type + count);
        viewConfig.setType(headCount);
        viewConfig.setView(R.layout.item_tv);
        ViewGroup parent = (ViewGroup) view.getParent();
        if (parent != null) {
            parent.removeView(view);
        }
        viewConfig.setContentView(view);
        mFootCouListInfo.add(viewConfig);
    }

    public CustomAdapter getHeadAndFootAdapter() {
        return (CustomAdapter) mAdapter;
    }

    public void setCustomClickListener(ICustomClickListener customClickListener) {
        getHeadAndFootAdapter().setCustomClickListener(customClickListener);
    }
}

setHeadViewConfig和setFootdViewConfig两个方法作用一致,只是两个添加的元素不一样
wrapHeadAdapter方法的作用是用于构造CustomAdapter用来处理头部尾部的view,如果处理不了, 将会自动转交给自定义的Adapter处理
类里部分参数没用到,但是我感觉后面我会用到的


干嘛鸭.jpg

下面是CustomAdapter的代码

CustomAdapter 继承自 RecyclerView.Adapter<? extends ViewHolder>

public class CustomAdapter extends RecyclerView.Adapter<RecyclerView.ViewHolder> implements View.OnClickListener {
    private List<ViewConfig> headConfig;
    private List<ViewConfig> footConfig;
    private ArrayList<ViewConfig> EMPTY_LIST = new ArrayList<>();
    private LayoutInflater inflater;
    private RecyclerView.Adapter mAdapter;
    private int headcount = 0;
    private int footcount = 0;
    private Context mContext;
    private ICustomClickListener customClickListener;

    public CustomAdapter(List<ViewConfig> headConfig, List<ViewConfig> footConfig, RecyclerView.Adapter mAdapter, Context mContext) {
        this.mAdapter = mAdapter;
        this.inflater = LayoutInflater.from(mContext);
        this.mContext = mContext;
        if (headConfig == null) {
            this.headConfig = EMPTY_LIST;
        } else {
            this.headConfig = headConfig;
        }
        if (footConfig == null) {
            this.footConfig = EMPTY_LIST;
        } else {
            this.footConfig = footConfig;
        }
    }

    /**
     * 设置监听事件
     *
     * @param customClickListener
     */
    public void setCustomClickListener(ICustomClickListener customClickListener) {
        this.customClickListener = customClickListener;
    }

    @RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
    @NonNull
    @Override
    public RecyclerView.ViewHolder onCreateViewHolder(@NonNull ViewGroup viewGroup, int index) {
        LogUtils.e("CustomAdapter", "index:" + index);
        if (index == ViewConfig.HEADVIEW_TYPE) {
            FrameLayout contentView = (FrameLayout) inflater.inflate(R.layout.item_head_foot_parent, viewGroup, false);
            View cView = headConfig.get(headcount++).getContentView();
            ViewGroup vg = (ViewGroup) cView.getParent();
            if (vg != null) {
                vg.removeView(cView);
            }
            contentView.addView(cView);
            return new CustomViewHolder(contentView);
        } else if (index == ViewConfig.FOOTVIEW_TYPE) {
            FrameLayout contentView = (FrameLayout) inflater.inflate(R.layout.item_head_foot_parent, viewGroup, false);
            View cView = footConfig.get(footcount++).getContentView();
            ViewGroup vg = (ViewGroup) cView.getParent();
            if (vg != null) {
                vg.removeView(cView);
            }
            contentView.addView(cView);
            return new CustomViewHolder(contentView);
        } else {
            return mAdapter.onCreateViewHolder(viewGroup, index);
        }
    }

    @Override
    public void onBindViewHolder(@NonNull RecyclerView.ViewHolder viewHolder, final int position) {
        CustomViewHolder customViewHolder;
        if (viewHolder instanceof CustomViewHolder) {
            customViewHolder = (CustomViewHolder) viewHolder;
            View mParent = customViewHolder.mParent;
            //设置view的点击事件
            if (mParent instanceof ViewGroup) {
                ViewGroup parentGroup = (ViewGroup) mParent;
                int childCount = parentGroup.getChildCount();
                for (int i = 0; i < childCount; i++) {
                    parentGroup.getChildAt(i).setOnClickListener(new View.OnClickListener() {
                        @Override
                        public void onClick(View v) {
                            if (customClickListener != null) {
                                if (position < getHeadSize()) {
                                    customClickListener.onClick(v, position, 0);
                                } else {
                                    customClickListener.onClick(v, position - getHeadSize() - mAdapter.getItemCount(), 1);
                                }
                            }
                        }
                    });
                }
            }
            mParent.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    if (position < getHeadSize()) {
                        customClickListener.onClick(v, position, 0);
                    } else {
                        customClickListener.onClick(v, position - getHeadSize() - mAdapter.getItemCount(), 1);
                    }
                }
            });
        } else {
            mAdapter.onBindViewHolder(viewHolder, position - getHeadSize());
        }
    }

    @Override
    public int getItemCount() {
        return mAdapter != null
                ? headConfig.size() + mAdapter.getItemCount() + footConfig.size()
                : headConfig.size() + footConfig.size();
    }

    @Override
    public void onClick(View v) {
        LogUtils.e("CustomAdapter", "点击");
    }

    public class CustomViewHolder extends RecyclerView.ViewHolder {
        View mParent;

        public CustomViewHolder(@NonNull View itemView) {
            super(itemView);
            mParent = itemView;
        }
    }

    @Override
    public int getItemViewType(int position) {
        int headSize = getHeadSize();
        int adapterCount = getItemCount();//获取实际的个数
        if (position < headSize) {
            return ViewConfig.HEADVIEW_TYPE;
        } else if (position >= headSize + mAdapter.getItemCount() && position < adapterCount) {
            return ViewConfig.FOOTVIEW_TYPE;
        }
        return -1;
    }

    public int getHeadSize() {
        return headConfig.size();
    }

    public int getFootSize() {
        return footConfig.size();
    }
}

getItemViewType中根据position当前的值返回类型

position < headsize (那么证明现在就是头部
position >= headsize && position < headSize + mAdapter.getItemCount (证明这个时候是实际的itemview
position >= headSize + mAdapter.getItemCount() && position < getItemCount (这个时候就是尾部了
在代码中 我们只要判断头部和尾部就行了, 其他一律返回-1 (其他数也可以)

onCreateViewHolder()
在这个方法中根据index判断view的类型,当然这个index只是在我的电脑上显示, 在你的上面显示可能是i也可能type,等等。

起先我用了

View contentView =  inflater.inflate(headConfig.get(0).getView(), viewGroup, false);
contentView.addView(contentView);

这样的代码, 但是抛出了一个异常,大体意思就是复用的错误 后来改用了这样的写法

FrameLayout contentView = (FrameLayout) inflater.inflate(R.layout.item_head_foot_parent, viewGroup, false);
            View cView = headConfig.get(headcount++).getContentView();
            ViewGroup vg = (ViewGroup) cView.getParent();
            if (vg != null) {
                vg.removeView(cView);
            }
            contentView.addView(cView);

先得到一个FrameLayout,再将View添加进去, 但是在添加进去之前需要先判断view有没有parent,有的话要先用parent移除掉view, 不然会抛出

You must call removeView() on the child's parent first

这个异常

onBindViewHolder
这个方法中会先判断ViewHolder, 如果ViewHolder是CustomViewHolder的话会得到里面唯一的view, 再去判断该view是普通View还是ViewGroup。(正常情况来说都是ViewGroup,因为Viewholder里面的View实际就是FrameLayout
在得出FrameLayout中的子view, 为子view添加了点击事件和长按事件

这次的代码大概就这么多,还没来得及好好测一测,后面会在添加头部尾部的基础上添加上拉加载下拉刷新的逻辑。
部分demo调用代码和效果图如下

 @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        this.mData = new ArrayList<>();
        this.mCustomRv = findViewById(R.id.m_customrv);
        mCustomRv.setLayoutManager(new LinearLayoutManager(this));
        RvAdapter rvAdapter = new RvAdapter(mData, this);
        mCustomRv.addHeadView(getTextView("头部9527", Color.parseColor("#CA66F0")));
        mCustomRv.addHeadView(getTextView("头部17131", Color.parseColor("#A6A5F1")));
        mCustomRv.addFootView(getTextView("尾部9527", Color.parseColor("#05F066")));
        mCustomRv.addFootView(getTextView("尾部17131", Color.parseColor("#90C56F")));
        mCustomRv.setAdapter(rvAdapter);
        mCustomRv.setCustomClickListener(new ICustomClickListener() {
            @Override
            public void onClick(View view, int position,int type,  Object... data) {
                LogUtils.e("MainActivity", "position:" + position);
            }

            @Override
            public void onLongClick(View view, int position,int type, Object... data) {

            }
        });
        /**
         * 添加数据源
         */
        for (int i = 0; i < 5; i++) {
            mData.add("mData --- " + i);
        }
    }
2个头部2个尾部.png

多个头部和多个尾部.png

嘻嘻嘻.jpg

项目已经发布到ghithub 并有gradle依赖
CustomRecyclerView

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

推荐阅读更多精彩内容