RecyclerView通用包装类-增加底部footer和上拉加载更多

在这里我讲一下如何写一个通用的工具类来增加RecyclerView的底部footer和上拉加载更多的方式

该包装类的实现思路是对自定义的adapter进行外部拦截,重写Adapter的必要方法来实现上述功能。

功能实现简洁易懂,主要是我觉得思想不错,可以借鉴。

首先看传入参数,了解类的大致构造:

    context: Context, //该上下文是为了获取inflater实例
    val mAdapter: RecyclerView.Adapter<RecyclerView.ViewHolder>, //传入自定义adapter的引用是为了方便调用内部属性与方法
    val initialPageCount: Int, //初始化每一页要加载的数据量
    val recycler: RecyclerView) //传入recyclerview的id是为了为其添加监听,回调加载更多接口,更改footer状态

接下来重写四个必要方法(注释都写在代码里面,很详细):
1.getItemCount

    /**
     * 加1是因为包装类为自定义的adapter增加了一个footer
     */
    override fun getItemCount(): Int  = mAdapter.itemCount + 1

2.getItemViewType

    override fun getItemViewType(position: Int): Int {
        //如果首次加载的数据少于 initialPageCount 行,则表明没有更多数据了,直接返回TYPE_FOOTER_NOMORE类型footer
        if (position == mAdapter.itemCount && mAdapter.itemCount < initialPageCount) return TYPE_FOOTER_NOMORE
        return when (position < mAdapter.itemCount) {
            // 0-mAdapter.itemCount-1,调用自定义adapter内的getItemViewType 
            true -> mAdapter.getItemViewType(position)
            // 第mAdapter.getItemViewType个,是包装类内部定义的,返回footer的ViewType类型值
            false -> footerType!!
        }
    }

3.onCreateViewHolder

    override fun onCreateViewHolder(parent: ViewGroup?, viewType: Int): RecyclerView.ViewHolder {
        var view:View? = null
        return when (viewType) {
            //TYPE_FOOTER_LOADING是加载更多footer的ViewType类型值
            TYPE_FOOTER_LOADING -> {
                FooterHolder(mInflater!!.inflate(R.layout.footer, parent, false), TYPE_FOOTER_LOADING)
            }
            //TYPE_FOOTER_NOMORE是到达底部footer的ViewType类型值
            TYPE_FOOTER_NOMORE -> {
                FooterHolder(mInflater!!.inflate(R.layout.footer, parent, false), TYPE_FOOTER_NOMORE)
            }
            //其余情况均返回自定义adapter内部的onCreateViewHolder
            else -> {
                mAdapter.onCreateViewHolder(parent, viewType)
            }
        }
    }

4.onBindViewHolder

    override fun onBindViewHolder(holder: RecyclerView.ViewHolder?, position: Int) {
        when (holder) {
            //如果是footer,那么自己处理,不然就调用自定义adapter内部的onBindViewHolder
            is FooterHolder -> { }
            else -> {
                mAdapter.onBindViewHolder(holder, position)
            }
        }
    }

5.接下来就是增加监听了,这时候就是传入recyclerview id的用处了
为列表增加滑动监听,重写onScrolled和onScrollStateChanged
在onScrolled内部获取到显示的最后一个item的position
在onScrollStateChanged内部进行三个判断,1.判断是否滑动已经停止,2判断footer是否是loading状态,3.判断最后一个item是否是footer,全部满足才进行回调加载更多接口

    fun setOnScrollerListener() {
        recycler.addOnScrollListener(object: RecyclerView.OnScrollListener() {
            override fun onScrolled(recyclerView: RecyclerView?, dx: Int, dy: Int) {
                val layoutManager = recyclerView?.layoutManager

                when (layoutManager) {
                    is LinearLayoutManager -> {
                        lastVisibleItem = layoutManager.findLastVisibleItemPosition()
                    }
                //这里现在只写了LinearLayoutManager的代码,后续补充
                }
            }
            override fun onScrollStateChanged(recyclerView: RecyclerView?, newState: Int) {
                if (newState == RecyclerView.SCROLL_STATE_IDLE //停止滚动
                        && footerType == TYPE_FOOTER_LOADING  //footer状态为加载更多
                        && lastVisibleItem >= mAdapter.itemCount)  //最后一个显示的item序号大于适配器item数量,即显示了footer
                    onLoadMoreListener?.onLoadMore()
            }
        })
    }

使用的时候可以像下面这样使用:

//初始化自定义adapter
courseSearchAdapter = CourseSearchAdapter(this, CourseSearchActicity@this,courseList!!)
activity_course_search_recycler.layoutManager = LinearLayoutManager(this)
 courseSearchAdapterWrapper = CourseSearchAdapterWrapper(
                    this,
                    courseSearchAdapter!!,
                    20,
                    activity_course_search_recycler)
                    .setOnLoadMoreListener(object : CourseSearchAdapterWrapper.OnLoadMoreListener {
                        override fun onLoadMore() {
                            //在这里监听到加载更多回调
                        }
                    })
activity_course_search_recycler.adapter = courseSearchAdapterWrapper

下面是类的源码

/**
 * @author <a href="https://www.jianshu.com/u/c1e5310dd724">xujian</a>
 * @描述: 课程搜索页面列表适配器包装类,包装了底部item(加载中和到达底部item的变化,还有上拉到底部的监听)
 * @Copyright Copyright (c) 2019
 * @Company ***
 * @date 2019/01/07
 */
class CourseSearchAdapterWrapper(
        context: Context, //该上下文是为了获取inflater实例
        val mAdapter: RecyclerView.Adapter<RecyclerView.ViewHolder>, //传入自定义adapter的引用是为了方便调用内部属性与方法
        val initialPageCount: Int, //初始化每一页要加载的数据量
        val recycler: RecyclerView) //传入recyclerview的id是为了为其添加监听,回调加载更多接口,更改footer状态
    : RecyclerView.Adapter<RecyclerView.ViewHolder>() {

    private var mInflater: LayoutInflater? = null
    private var footerType = TYPE_FOOTER_LOADING //默认为正在加载
    private var lastVisibleItem:Int = 0
    private var onLoadMoreListener: OnLoadMoreListener? = null

    init {
        mInflater = LayoutInflater.from(context)
    }

    companion object {
        const val TYPE_FOOTER_LOADING = 100000001 //底部正在加载view
        const val TYPE_FOOTER_NOMORE = 100000002 //底部无更多数据view
    }

    /**
     * 加1是因为包装类为自定义的adapter增加了一个footer
     */
    override fun getItemCount(): Int  = mAdapter.itemCount + 1

    override fun getItemViewType(position: Int): Int {
        //如果首次加载的数据少于 initialPageCount 行,则表明没有更多数据了,直接返回TYPE_FOOTER_NOMORE类型footer
        if (position == mAdapter.itemCount && mAdapter.itemCount < initialPageCount) return TYPE_FOOTER_NOMORE
        return when (position < mAdapter.itemCount) {
            // 0-mAdapter.itemCount-1,调用自定义adapter内的getItemViewType 
            true -> mAdapter.getItemViewType(position)
            // 第mAdapter.getItemViewType个,是包装类内部定义的,返回footer的ViewType类型值
            false -> footerType!!
        }
    }

    override fun onCreateViewHolder(parent: ViewGroup?, viewType: Int): RecyclerView.ViewHolder {
        var view:View? = null
        return when (viewType) {
            //TYPE_FOOTER_LOADING是加载更多footer的ViewType类型值
            TYPE_FOOTER_LOADING -> {
                FooterHolder(mInflater!!.inflate(R.layout.footer, parent, false), TYPE_FOOTER_LOADING)
            }
            //TYPE_FOOTER_NOMORE是到达底部footer的ViewType类型值
            TYPE_FOOTER_NOMORE -> {
                FooterHolder(mInflater!!.inflate(R.layout.footer, parent, false), TYPE_FOOTER_NOMORE)
            }
            //其余情况均返回自定义adapter内部的onCreateViewHolder
            else -> {
                mAdapter.onCreateViewHolder(parent, viewType)
            }
        }
    }

    override fun onBindViewHolder(holder: RecyclerView.ViewHolder?, position: Int) {
        when (holder) {
            //如果是footer,那么自己处理,不然就调用自定义adapter内部的onBindViewHolder
            is FooterHolder -> { }
            else -> {
                mAdapter.onBindViewHolder(holder, position)
            }
        }
    }

    //需要加载更多数据时调用
    fun insertData() {
        footerType = TYPE_FOOTER_LOADING
        notifyDataSetChanged()
    }

    //没有更多数据时候调用
    fun noMoreData() {
        footerType = TYPE_FOOTER_NOMORE
        notifyItemChanged(mAdapter.itemCount)
    }

    fun setOnScrollerListener() {
        recycler.addOnScrollListener(object: RecyclerView.OnScrollListener() {
            override fun onScrolled(recyclerView: RecyclerView?, dx: Int, dy: Int) {
                val layoutManager = recyclerView?.layoutManager

                when (layoutManager) {
                    is LinearLayoutManager -> {
                        lastVisibleItem = layoutManager.findLastVisibleItemPosition()
                    }
                //这里现在只写了LinearLayoutManager的代码,后续补充
                }
            }
            override fun onScrollStateChanged(recyclerView: RecyclerView?, newState: Int) {
                if (newState == RecyclerView.SCROLL_STATE_IDLE //停止滚动
                        && footerType == TYPE_FOOTER_LOADING  //footer状态为加载更多
                        && lastVisibleItem >= mAdapter.itemCount)  //最后一个显示的item序号大于适配器item数量,即显示了footer
                    onLoadMoreListener?.onLoadMore()
            }
        })
    }

    fun setOnLoadMoreListener (listener: OnLoadMoreListener): CourseSearchAdapterWrapper {
        this.onLoadMoreListener = listener
        //设置滑动监听
        setOnScrollerListener()
        return this
    }

    interface OnLoadMoreListener {
        fun onLoadMore() //加载更多
    }

    /**
     * 自定义的底部item,后续会继续暴露方法给外部动态设置加载更多时候的gif图
     */
    class FooterHolder(view: View, type:Int): RecyclerView.ViewHolder(view) {
        var txt: TextView? = null

        init {
            txt = view.findViewById(R.id.footer_txt)
            when (type) {
                TYPE_FOOTER_LOADING -> {
                    txt!!.text = "正在加载..."
                }
                TYPE_FOOTER_NOMORE -> {
                    txt!!.text = "已经到达底部"
                }
            }
        }
    }

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

推荐阅读更多精彩内容