BRV: A Kotlin repository from suifengpiaobo

介绍

代码量最少, 使用便捷, 非侵入式, 满足常见需求, 同时方便扩展和自定义

配合异步网络任务库Net预计可为项目减少70%代码

任何框架问题加群回复: 752854893

特性

全网最少的代码, 最多最强的功能
完美支持Kotlin特性
通用适配器, 无需继承
快速实现常见需求
刷新还是添加数据都无闪屏
Demo示例代码不过百行
可配合DataBinding快速实现MVVM架构(也可以不使用DataBinding)

需求

用最少的代码实现开发过程中的常见需求:

多类型
- 单一数据模型一对多
- 多数据模型
添加头布局和脚布局
点击/长按事件
- 过滤重复点击
分组
- 展开折叠
- 顶部附着
支持所有的LayoutManager的分割线/均布间隔
切换模式
选择模式
- 全选/取消全选/反选
- 单选
- 监听选择事件
拖拽移动
侧滑删除
下拉刷新 | 上拉加载 (PageRefreshLayout)
- 指定预拉取索引(UpFetch)
- 指定预加载索引(Preload)
多状态缺省页 (PageRefreshLayout)
自动分页加载 (PageRefreshLayout)
扩展
- 伸缩布局 (FlexboxLayoutManager)
- 自动化网络请求 (Net), 该网络请求基于Kalle|协程实现自动化的并发网络请求

未来将支持:

划动多选
无限划动

安装

project 的 build.gradle

allprojects {
    repositories {
        // ...
        maven { url 'https://jitpack.io' }
    }
}

module 的 build.gradle

implementation 'com.github.liangjingkanji:BRV:1.3.6'

预览

首页

功能界面

初始化

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()
      
        BRV.modelId = BR.m // 推荐在Application中进行初始化或使用之前即可
    }
}

多类型

不同数据模型

rv.linear().setup {

  addType<Model>(R.layout.item_1)
  addType<Store>(R.layout.item_2)

}.models = data

一对多数据模型

开发中常常遇到一个列表, 列表每个数据对应的一个字段来判断itemType

addType<Model>{
  // 使用年龄来作为判断返回不同的布局
  when (age) {
    23 -> {
      R.layout.item_1
    }
    else -> {
      R.layout.item_2
    }
  }
}

分割线

快速实现分割线

fun RecyclerView.divider(
    @DrawableRes drawable: Int,
    @RecyclerView.Orientation orientation: Int = RecyclerView.VERTICAL,
    block: ((Rect, View, RecyclerView, RecyclerView.State) -> Boolean)? = null
)

监听事件

监听事件需要先添加想要监听的view

fun addClickable(@IdRes vararg id: Int)
// 过滤500毫秒内重复点击

fun addFastClickable(@IdRes vararg id: Int)
// 区别于上面函数不过滤重复点击事件

fun addLongClickable(@IdRes vararg id: Int)
// 长按事件

事件回调

onClick{

}
// 点击事件

onLongClick{

}
// 长按点击事件

onBind {
  
  false
}

onBind属于onBindViewHolder事件监听.

如果你需要自己去设置数据或绑定事件就使用该函数. 返回值决定是否用框架内部默认的Databinding绑定布局. false表示不绑定.

更简单的写法示例

rv.linear().setup {

    addType<Model>{
        R.layout.item_1
    }

    onClick(R.id.item, R.id.user_portrait){

    }


    onLongClick(R.id.item){

    }

}.models = data

头布局/脚布局

头布局和脚布局在rv中算作一个item, 所以计算position的时候应当考虑其中.

操作头布局

fun addHeader(view: View)

fun removeHeader(view: View)

fun clearHeader()

fun isHeader(@IntRange(from = 0) position: Int): Boolean

操作脚布局

fun addFooter(view: View)

fun removeFooter(view: View)

fun clearFooter()

fun isFooter(@IntRange(from = 0) position: Int): Boolean

获取数据

val headerCount: Int

val footerCount: Int

切换模式

切换模式相当于会提供一个回调函数遍历所有的item, 你可以在这个回调函数里面依次刷新他们.

常用于切换选择模式.

fun toggle()
// 切换模式

fun getToggleMode(): Boolean
// 范围当前出何种切换模式

fun setToggleMode(toggleMode: Boolean)
// 设置切换模式, 如果设置的是当前正处于的模式不会触发回调

回调函数

onToggle { type, position, toggleMode ->  // 类型 位置 切换布尔值
	// 在这里可以给item刷新成选择模式
}

// 切换完成
onToggleEnd {
	// 例如切换工具栏为选择模式
}

选择模式

fun allChecked()
// 全选

fun allChecked(isAllChecked: Boolean)
// 全选或者全部取消全选

fun clearChecked()
// 取消全选

fun reverseChecked() 
// 反选

fun setChecked(@IntRange(from = 0) position: Int, checked: Boolean)
// 设置某个item的选择状态

fun toggleChecked(@IntRange(from = 0) position: Int)
// 切换某个item的选择状态

fun <M> getCheckedModels(): List<M>

fun setCheckableType(@LayoutRes vararg checkableItemType: Int)
// 设置哪些type允许进入选择状态

val checkedCount: Int

拖拽/侧滑

只支持拖拽移动和侧滑删除

步骤:

开启ItemTouchHelper支持
数据模型继承ItemModel
自定义扩展

BindingAdapter提供一个字段来开启ItemTouchHelper支持

var touchEnable = false // 默认关闭

然后数据模型要求继承ItemModel, 根据需求重写函数.

示例:

data class Model(val name: String) : ItemModel() {

    override fun getDrag(): Int {
        return UP or DOWN
    }

    override fun getSwipe(): Int {
        return RIGHT or LEFT
    }
    
}

RIGHT or LEFT是控制拖拽和侧滑的方向(侧滑不支持UP/DOWN)的常量.

拖拽移动item会自动改变数据模型在数据集合中的位置.

扩展功能

如果想要扩展ItemTouchHelper可以给BindingAdapter的变量itemTouchHelper赋值

rv.linear().setup {

  addType<Model>(R.layout.item)
  touchEnable = true
  
  itemTouchHelper = ItemTouchHelper(object : DefaultItemTouchCallback(this) {
			// 这里可以重写函数
  })

}.models = data

通过给view打上tag标签 swipe 可以控制侧滑将会移动的视图.

<RelativeLayout
        android:layout_width="wrap_content"
        android:layout_height="80dp"
        android:orientation="horizontal"
        android:tag="swipe"/>

缺省页

内部依赖 StateLayout, 该库支持任意 Activity | Fragment | View 实现缺省页功能.

主要特点

全局配置
单例配置
生命周期(可以加载动画或者处理事件)
支持activity/fragment/view替换
支持代码或者XML实现
无网络情况下showLoading显示错误布局, 有网则显示加载中布局

本库已经依赖, 无需再次依赖. 使用方法见GitHub.

PageRefreshLayout

该布局扩展自 SmartRefreshLayout(该库强烈推荐使用), 支持其所有特性. 本框架拥有最完美的缺省页功能

本库已引入SmartRefreshLayout 'com.scwang.smart:refresh-layout-kernel:2.0.0-alpha-1', 无需再次引入.

针对需要的请求头可以去其开源地址分包引入.

可选配置刷新头布局和脚布局

implementation  'com.scwang.smart:refresh-footer-classics:2.0.0-alpha-1'    //经典加载
implementation  'com.scwang.smart:refresh-header-material:2.0.0-alpha-1'    //谷歌刷新头
// 以上两种已内置


implementation  'com.scwang.smart:refresh-header-classics:2.0.0-alpha-1'    //经典刷新头
implementation  'com.scwang.smart:refresh-header-radar:2.0.0-alpha-1'       //雷达刷新头
implementation  'com.scwang.smart:refresh-header-falsify:2.0.0-alpha-1'     //虚拟刷新头
implementation  'com.scwang.smart:refresh-header-two-level:2.0.0-alpha-1'   //二级刷新头
implementation  'com.scwang.smart:refresh-footer-ball:2.0.0-alpha-1'        //球脉冲加载
implementation 'com.scwang.smartrefresh:SmartRefreshHorizontal:1.0.0-andx-1' // 水平

刷新布局要求必须先初始化, 推荐在Application中

SmartRefreshLayout.setDefaultRefreshHeaderCreator { context, layout -> ClassicsHeader(this) }
SmartRefreshLayout.setDefaultRefreshFooterCreator { context, layout -> ClassicsFooter(this) }

在此基础上增加特性

缺省页
自动分页加载
支持KT特性
代码替换

创建方式

// 1. 代码创建, 通过扩展函数
val page = rv.page()

// 2. 布局包裹
<com.drake.brv.PageRefreshLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/page"
    app:stateEnabled="true"
    android:layout_height="match_parent"
    tools:context="com.drake.brv.sample.fragment.RefreshFragment">

    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/rv"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

</com.drake.brv.PageRefreshLayout>

监听状态

// 下拉刷新
page.onRefresh {
	// 这里可以进行网络请求等异步操作
}

// 上拉加载
page.onLoadMore {
	// 这里可以进行网络请求等异步操作
}

如果onLoadMore 不调用则上拉加载同样也会回调onRefresh函数, 因为下拉刷新和上拉加载可能都是走的同一个网络请求.

缺省页

触发刷新状态(两者都会回调函数onRefresh)

autoRefesh 这是触发的下拉刷新
showLoading 这是触发的加载缺省页, 当然得先设置loadingLayout(或者读取全局缺省页配置)
refresh 静默刷新, 不会触发任何动画

第2种方式一般用于初次进入页面时候加载数据(产品经理可能有这个要求), 这三种方式都会导致索引index=startIndex重置.

缺省页状态控制

showEmpty()
showError()
showContent
showLoading()

配置全局缺省页

这块代码和StateLayout公用

/**
         *  推荐在Application中进行全局配置缺省页, 当然同样每个页面可以单独指定缺省页.
         *  具体查看 https://github.com/liangjingkanji/StateLayout
         */
StateConfig.apply {
  emptyLayout = R.layout.layout_empty
  errorLayout = R.layout.layout_error
  loadingLayout = R.layout.layout_loading

  onLoading {
    // 此生命周期可以拿到LoadingLayout创建的视图对象, 可以进行动画设置或点击事件.
  }
}

单例缺省页配置支持两种方式

<com.drake.brv.PageRefreshLayout 
    .....
    app:error_layout="@layout/layout_error"
    app:empty_layout="@layout/layout_empty"
    app:loading_layout="@layout/layout_loading">

代码

page.apply {
    loadingLayout = R.layout.layout_loading
    emptyLayout = R.layout.layout_empty
    errorLayout = R.layout.layout_error
}

默认会使用缺省页, 如果你已经设置了全局缺省页但是此刻不想使用. 可以使用属性|函数: stateEnabled

想要使用缺省页又要求缺省页不遮盖头布局, 头布局请使用CoordinatorLayout实现. 注意使用NestedScrollView会导致rv一次性加载完item内存消耗大.

刷新数据

前面提到 PageRefreshLayout 支持自动分页加载

// 设置分页加载第一页的索引, 默认=1, 触发刷新会重置索引. 如果需要修改在Application设置一次即可
// PageRefreshLayout.startIndex = 1

pageLayout.onRefresh { 
  // 下拉刷新和上拉加载都会执行这个网络请求, 除非另外设置onLoadMore
  get("/path") {
      param("key", "value")
      param("page", pageLayout.index) // 这里使用框架提供的属性
  }.page(this) {
    // 该回调函数参数返回一个布尔类型用于判断是否存在下一页, 决定上拉加载的状态. 以及当前属于刷新还是加载更多条目
    addData(data){ adapter.itemCount < data.count // 这里是判断是否由更多页, 具体逻辑根据接口定义 } 
  }
}

这里的网络请求使用的是我开源的另一个项目Net, 支持扩展BRV. GitHub: Net.

扩展

LayoutManager

框架还提供快速创建布局管理器的扩展函数, 上面使用示例

rv.linear().setup {
	
}

函数

fun RecyclerView.linear(
    @RecyclerView.Orientation orientation: Int = VERTICAL,
    reverseLayout: Boolean = false
)


fun RecyclerView.grid(
    spanCount: Int,
    @RecyclerView.Orientation orientation: Int = VERTICAL,
    reverseLayout: Boolean = false
)

fun RecyclerView.staggered(
    spanCount: Int,
    @RecyclerView.Orientation orientation: Int = VERTICAL
)

分隔物

框架提供快速设置分隔物扩展函数

fun RecyclerView.divider( 
    @DrawableRes drawable: Int,  // 分隔物Drawable
    @RecyclerView.Orientation orientation: Int = RecyclerView.VERTICAL, // LayoutManager的方向
    block: ((Rect, View, RecyclerView, RecyclerView.State) -> Boolean)? = null // getItemOffset回调用于设置间隔
)

示例

rv.linear().divider(R.drawable.divider_horizontal_padding_15dp).setup {
	
}

对话框

通过扩展函数快速给对话框创建列表

Dialog(context).setAdapter(bindingAdapter)

suifengpiaobo/BRV

介绍

特性

需求

安装

预览

初始化

多类型