My Avatar

GuilinDev

If you don't read your codes for more than 6 months, it will be like someone else writing it when you read it again.

ExRecyclerView的使用介绍

04-07-2018 Saturday, 发表于 Boston, USA

如果你对本文有任何的建议或者疑问, 可以在 这里给我提 Issues, 谢谢! :)

ExRecyclerView ExRecyclerView 使用 Kotlin 编写

demo

很多时候我们在使用 RecyclerView 时, 总是会碰到需要设置一个 header 或者 footer 的情况, 比如我们要加一个显示加载更多的footer，跟随 RecyclerView 一起滑动的 header, 等等, 这种情况如果是 ListView 我们可以简单的使用 

1

addHeaderView()
或者 
1

addFooterView()
就可以解决, 但是 RecyclerView 就需要我们自己来进行处理. 虽然说不困难, 但是每次都要重新实现一遍就很麻烦了.

ExRecyclerView一共实现了3个功能:

  1. 能添加和删除 header 和 footer
  2. 滑到底部时回调加载更多
  3. 支持 Drag 和 Swipe 拖动 item 或者 swipe 删除 item (可以自定义拖动,滑动的样式)

ExRecyclerAdapter 是一个内置了 List 集合的 RecyclerAdapter, 每次改变数据都会主动进行相应的notify(也可以主动不进行 notify)

ExRecyclerView

Usage

1
2
3
4
5
6
7

<cn.kejin.android.views.ExRecyclerView
    android:id="@+id/exRecycler"
    android:layout_margin="50dp"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:header="@layout/layout_header"
    app:footer="@layout/layout_footer"/>

1
2
3
4
5
6
7
8
9
10
11
12

exRecycler.layoutManager = LinearLayoutManager(this)
exRecycler.adapter = Adapter(this)
exRecycler.addHeader(header)
exRecycler.addFooter(footer)

exRecycler.setOnLoadMoreListener {
    // do load more, 结束之后调用 exRecycler.endLoadMore() 结束loading more的状态
}

exRecycler.itemActionListener = listener
// 如果使用自定义 ItemTouchHelper
exRecycler.itemTouchHelper = customItemTouchHelper

Header & footer

方法/属性 说明 
1

app:header
在 xml 布局中定义 header view 
1

app:footer
在 xml 布局中定义 footer view 
1

getHeader()
获取定义在 xml 中的 header view 
1

getFooter()
获取定义在 xml 中的 footer view 
1

removeHeader()
移除定义在 xml 中的 header 
1

removeFooter()
移除定义在 xml 中的 footer
    
1

getHeaderSize()
header size 
1

hasHeader(view)
判断是否有此header 
1

addHeader(view)
加入一个 header, 并返回它的 hashcode, 可以根据这个 hashcode 找到或者删除这个header 
1

getHeader(hashcode)
根据 view 的 hashcode 找到这个header 
1

removeHeader(view)

1

removeHeader(hashcode)
根据 view 或者他的 hashcode 移除掉这个 header
    
1

getFooterSize()
footer size 
1

hasFooter(view)
判断是否有此footer 
1

addFooter(view)
加入一个 footer, 并返回它的 hashcode, 这个根据这个 hashcode 获取或者删除这个footer 
1

getFooter(hashcode)
根据 view 的 hashcode 找到这个footer 
1

removeFooter(view)

1

removeFooter(hashcode)
根据 view 或者他的 hashcode 移除掉这个 footer
    
1

getItemCount()
获取所有的 Item 个数

这些 header 和 footer 都是不会被 RecyclerView 进行回收的, 所以注意避免加入过多的 header 或者 footer.

OnLoadMoreListener

当 ExRecyclerView 滑动到底部(倒数第二个可见) 时，就会回调表示可以进行 load more 操作. 但是要注意的是当 回调了 load more 之后, ExRecyclerView 会把状态置为 loadingMore 状态, 即不允许在正在执行 load more 操作时再回调 load more 事件, 当 load more 结束之后, 就必须要调用 

1

exRecycler.endLoadMore()
来结束 loadingMore 状态.

1
2
3
4
5
6
7
8
9

interface OnLoadMoreListener {
    /**
     * @return Boolean 是否处理了loadmore操作,
     * 如果返回true, 表示进行了 loadmore 操作,
     *      则在没有调用 endLoadMore() 之前不会再回调 loadmore
     * 如果返回false, 表示没有进行 loadmore 操作, 则继续监听滑动
     */
    fun onLoadMore(): Boolean
}
属性/方法 说明 
1

isLoadingMore
判断是否正在loading more 的状态, 如果为true, 则表示正在加载更多, ExRecyclerView 不会再回调loadmore 操作 
1

loadMoreListener

1

setOnLoadMoreListener
设置监听 
1

endLoadMore()
将isLoadingMore 的状态置为 false, 让 ExRecyclerView 继续监听到底回调 loadmore 操作

Drag & Swipe

Drag Move 和 Swipe Dismiss 的实现, 我参考了 Drag and Swipe with RecyclerView 但是我觉得他写的有点复杂了, 可能是他写的类和接口太多了吧 -_-!!

Drag & Swipe 的实现是用了 ItemTouchHelper 这个帮助类, ExRecyclerView 内部已经实例化了一个 ItemTouchHelper, 并已经进行了 Attach, 如果你想完全用自己的 ItemTouchHelper, 只要将你的 ItemTouchHelper attach ExRecyclerView 就可以, 不过要注意不能移动 header 或者 footer, 还有将ExRecyclerView 的内部变量 itemTouchCallback = null, itemActionListener = null;

属性/方法 说明 
1

itemTouchHelper
ExRecyclerView 的内置 ItemTouchHelper 
1

itemTouchCallback
自定义的ItemTouchHelper.Callback 
1

itemActionListener
ItemActionListener的实现

ItemActionListener

ItemActionListener 其实只是把 ItemTouchHelper.Callback 的主要的方法抽离了出来, 方便实现, ExRecyclerAdapter 实现了一个简单的 ItemActionListener, 并可以控制 Drag 或者 Swipe 是否可用

ExRecyclerAdapter

ExRecyclerAdapter 实现了一个简单的ItemActionListener

属性/方法 说明 
1

set(pos, model)
改变某一个位置的数据 
1

set(Collectoin<Model>)
重新设置所有的数据 
1

move(from, to)
移动一个数据 
1

add(index, model)
在index位置加入一个数据 
1

add(model)
追加一个数据 
1

addAll(Collectoin<Model>)
追加一个集合数据 
1

removeAt(index)
移除一个指定的数据 
1

remove(model)
移除这个 model数据, 如果有多个, 只会移除第一个 
1

removeAll(model)
移除所有的指定数据 
1

clear()
清除所有的数据
    
1

longPressDragEnable
是否可用长按拖动 
1

itemViewSwipeEnable
是否滑动可用 
1

enableDragAndSwipe()
使两个都可用 
1

disableDragAndSwipe()
禁用 drag 和 swipe

所有的数据操作方法都有一个 notify 参数, 默认为 true, 且如果成功操作数据, 返回 true

PS 
1

ItemTouchHelper
的使用

ItemTouchHelper 的是使用也比较简单, 基本步骤就是:

  1. 实现 ItemTouchHelper.Callback 这个类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

class itemTouchCallback : ItemTouchHelper.Callback() {
    /**
     * 这里返回移动的标志位, 用来指示Drag 和 Swipe 可移动的方向
     * 比如 dragFlags = TOP | BOTTOM 则表示只能左右拖动 item
     * swipeFlags = START | END 表示只能水平滑动 item
     * 最后返回使用 makeMovementFlags(dragFlags, swipeFlags) 返回
     */
    override fun getMovementFlags(
                        recyclerView: RecyclerView?,
                        viewHolder: ViewHolder?): Int { }

    /**
     * 当一个 item 被拖动到另一个 item(target) 上时,
     * 如果这个target可以移动, 会请求一次 onMove
     * 如果返回 true, 则表示两个 item 交换位置成功,
     * 所以会在这里进行 Adapter 的数据交换, 保证移动正确
     */
    override fun onMove(
                    recyclerView: RecyclerView?,
                    viewHolder: ViewHolder?,
                    target: ViewHolder?): Boolean { }

    /**
     * 当一个 item 完成了一次有效的滑动,
     * 会回调 onSwiped, direction 表示滑动的方向(START 或者 END)
     */
    override fun onSwiped(viewHolder: ViewHolder?, direction: Int) { }
}
  1. 使用这个 Callback 实例化 ItemTouchHelper
1

val itemTouchHelper = ItemTouchHelper(itemTouchCallback())
  1. 将 ItemTouchHelper Attach 到 RecyclerView
1

itemTouchHelper.attachToRecyclerView(recyclerView)
Copyright © 2025 Guilin Zhang - All rights reserved.