Android Jetpack- Paging的使用详解_Android

google 推出 jetpack 组件化已经有相当一段时间了。各种组件也层出不穷。

jetpack 的东西也不少，

今天就搞一下这个 paging

paging 的出现，就是用作列表的分页加载。其实现在已经有非常多成熟高效的开源列表加载控件了,比如：smartrefreshlayout等。但google推出的，必然有它的有点，当然也有它的局限性。

先说优点吧，paging 的使用，需要配合viewmodle，livedata等控件，数据的请求感知并绑定页面的生命周期，避免了内存泄漏。还需要绑定datasource和datasource的factory，能无痕加载更多数据，一定程度上提高用户体验。

主要流程是：

1：自定义 positionaldatasource，里面的功能是进行数据分页请求。

2：自定义 datasource.factory，把 positionaldatasource 绑定 livedata

3：activity 自定义 viewmodel，把 positionaldatasource 和 factory 绑定，让 viewmodel 感知数据的变化

4：viewmodel感知数据的变更，并更新 pagedlistadapter 的 submitlist。

最先看看导入那些依赖：

 implementation "androidx.paging:paging-runtime:3.0.0-alpha04"
  implementation 'androidx.recyclerview:recyclerview:1.1.0'
  implementation 'com.squareup.retrofit2:retrofit:2.9.0'
  implementation "android.arch.lifecycle:extensions:1.1.1"

【1】先看 activity 代码：

class mainactivity : appcompatactivity() {
 
 
 override fun oncreate(savedinstancestate: bundle?) {
  super.oncreate(savedinstancestate)
  setcontentview(r.layout.activity_main)
 
  val mypagedlistadapter = mypagedlistadapter()
  recyclerview.layoutmanager = linearlayoutmanager(this)
  recyclerview.adapter = mypagedlistadapter
 
  /**
   *  viewmodel 绑定 activity 生命周期
   * */
  val myviewmodel = viewmodelproviders.of(this).get(myviewmodel::class.java)
 
  /**
   *  viewmodel 感知数据变化，更新 adapter 列表
   * */
  myviewmodel.getconvertlist().observe(this, observer {
   mypagedlistadapter.submitlist(it)
  })
 }
 
}

【2】看 adapter代码：

这里要用的是 pagedlistadapter，其实它是继承了 recyclerview.adapter 的，所以用起来没和 recyclerview.adapter 多大区别，就是多了一个内部需要实现 diffutil.itemcallback 来。具体 diffutil.itemcallback 的原理就不在这说了，博主也没有细究，它是用来比较数据的。其内部实现方法也基本上可以写死。

class mypagedlistadapter extends pagedlistadapter<mydatabean, myviewholder> {
 
 
 private static diffutil.itemcallback<mydatabean> diff_callback =
   new diffutil.itemcallback<mydatabean>() {
    @override
    public boolean areitemsthesame(mydatabean oldconcert, mydatabean newconcert) {
     // 比较两个item数据是否一样的，可以简单用 bean 的 hashcode来对比
     return oldconcert.hashcode() == newconcert.hashcode();
    }
 
    @override
    public boolean arecontentsthesame(mydatabean oldconcert,
             mydatabean newconcert) {
     // 写法基本上都这样写死即可
     return oldconcert.equals(newconcert);
    }
   };
 
 
 public mypagedlistadapter() {
  // 通过 构造方法 设置 diffutil.itemcallback 
  super(diff_callback);
 }
 
 @nonnull
 @override
 public myviewholder oncreateviewholder(@nonnull viewgroup parent, int viewtype) {
  view inflate = layoutinflater.from(parent.getcontext()).inflate(r.layout.item_my, parent, false);
  return new myviewholder(inflate);
 }
 
 @override
 public void onbindviewholder(@nonnull myviewholder holder, int position) {
  // getitem() 是 pagedlistadapter 内部方法，通过此方法可以获取到对应位置item 的数据
  holder.binddata(getitem(position));
 }
 
}

顺便也把 viewholder 和 mydatabean 贴一下

viewholder :

class myviewholder(val itemv: view) : recyclerview.viewholder(itemv) {
 
 fun binddata(data: mydatabean) {
  itemv.findviewbyid<textview>(r.id.tvnum).text = data.position.tostring()
 
  if (data.position % 2 == 0){
   itemv.findviewbyid<textview>(r.id.tvnum).setbackgroundcolor(itemv.context.resources.getcolor(r.color.coloraccent))
  }else{
   itemv.findviewbyid<textview>(r.id.tvnum).setbackgroundcolor(itemv.context.resources.getcolor(r.color.colorprimarydark))
  }
 }
}

mydatabean ：

data class mydatabean(val position: int)

【3】看 datasource 代码：

positionaldatasource，里面的功能是进行数据分页请求。

需要实现两个方法：

loadinitial()：第一次打开页面，需要回调此方法来获取数据

loadrange(): 当有了初始化数据之后，滑动的时候如果需要加载数据的话，会调用此方法。

class mydatasource : positionaldatasource<mydatabean>() {
 
 /**
  * 第一次打开页面，需要回调此方法来获取数据
  * */
 override fun loadinitial(params: loadinitialparams, callback: loadinitialcallback<mydatabean>) {
  // 获取网络数据
  val list = getdata(params.requestedstartposition, params.pagesize)
  /**
   *  这个方法是返回数据，让 绑定viewmodel 感知。 这里要用对方法
   *  @param1 数据列表
   *  @param2 数据为起始位置
   *  @param3 数据列表总长度，这个一定要设置好哦，如果设置了50，
   *    当列表的长度为50时，列表再也无法出发 loadrange（） 去加载更多了
   *    如果不知道列表总长度，可以设置 int 的最大值 999999999
   *    这里设置 10000
   * */
  callback.onresult(list, 0, 10000)
 }
 
 /**
  * 当有了初始化数据之后，滑动的时候如果需要加载数据的话，会调用此方法。
  * */
 override fun loadrange(params: loadrangeparams, callback: loadrangecallback<mydatabean>) {
  /**
   *  params.startposition 列表需要从 startposition 加载更多
   *  params.loadsize  列表需要从 startposition 加载长度 为 loadsize的数据
   * */
  val list = getdata(params.startposition, params.loadsize)
  callback.onresult(list)
 }
 
 /**
  * 模拟网络获取数据
  * */
 private fun getdata(startposition: int, pagesize: int): mutablelist<mydatabean> {
 
  
  handler(looper.getmainlooper()).post {
   toast.maketext(
    myapplication.instant,
    "加载数据 从 $startposition 加载到 ${startposition + pagesize}",
    toast.length_short
   ).show()
  }
 
  val list = mutablelistof<mydatabean>()
  for (i in startposition until startposition + pagesize) {
   list.add(mydatabean(i))
  }
  return list
 }
}

【4】看 datasource.factory代码：

把 positionaldatasource 绑定 livedata

class datafactory: datasource.factory<int, mydatabean>() {
 
 private val msourcelivedata: mutablelivedata<mydatasource> =
  mutablelivedata<mydatasource>()
 
 override fun create(): datasource<int, mydatabean> {
  val mydatasource = mydatasource()
  msourcelivedata.postvalue(mydatasource)
  return mydatasource
 }
 
}

【5】最后看 viewmodel代码：

class myviewmodel : viewmodel() {
 
 private var mdatasource : datasource<int, mydatabean>
 private var mdatalist: livedata<pagedlist<mydatabean>>
 
 init {
  // 把 positionaldatasource 和 factory 绑定，让 viewmodel 感知数据的变化
  var datafactory = datafactory()
  mdatasource = datafactory.create()
  /**
   *  @param1 datafactory 设定 datafactory
   *  @param2 设定每一次加载的长度 
   *    这个和 positionaldatasource 回调方法 loadsize 一致的
   * */ 
  mdatalist = livepagedlistbuilder(datafactory, 20).build()
 }
 
 // 暴露方法，让activity 感知数据变化，去驱动 adapter更新列表
 fun getconvertlist(): livedata<pagedlist<mydatabean>> {
  return mdatalist
 }
}

【5】最后再看一下 activity 代码：

class mainactivity : appcompatactivity() {
 
 
 override fun oncreate(savedinstancestate: bundle?) {
  super.oncreate(savedinstancestate)
  setcontentview(r.layout.activity_main)
 
  val mypagedlistadapter = mypagedlistadapter()
  recyclerview.layoutmanager = linearlayoutmanager(this)
  recyclerview.adapter = mypagedlistadapter
 
  /**
   *  viewmodel 绑定 activity 生命周期
   * */
  val myviewmodel = viewmodelproviders.of(this).get(myviewmodel::class.java)
 
  /**
   *  viewmodel 感知数据变化，更新 adapter 列表
   * */
  myviewmodel.getconvertlist().observe(this, observer {
   mypagedlistadapter.submitlist(it)
  })
 }
 
}

贴一下 activity_main.xml 的代码

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.constraintlayout xmlns:android="http://schemas.android.com/apk/res/android"
 xmlns:app="http://schemas.android.com/apk/res-auto"
 xmlns:tools="http://schemas.android.com/tools"
 android:layout_width="match_parent"
 android:layout_height="match_parent"
 tools:context=".mainactivity">
 
 <androidx.recyclerview.widget.recyclerview
  android:id="@+id/recyclerview"
  android:layout_width="0dp"
  android:layout_height="0dp"
  app:layout_constraintleft_toleftof="parent"
  app:layout_constraintright_torightof="parent"
  app:layout_constrainttop_totopof="parent"
  app:layout_constraintbottom_tobottomof="parent">
 </androidx.recyclerview.widget.recyclerview>
 
</androidx.constraintlayout.widget.constraintlayout>

运行一下看一下效果：