Android Paging分页库的学习(二)—— 结合Room数据库进行分页加载

3,748 阅读3分钟

Paging分页库的介绍

Paging分页面是google推出的一个结合RecyclerView进行分页加载数据的一个全新架构库,主要是为了解决一次性加载大量数据而造成的资源浪费问题。通过分页的方式,每次加载一页数据,既可以加快界面的渲染,又可以减少对象等资源的创建消耗。具体可以看官网

分页库主要由以下三个部分组成

  • DataSource: 数据源,定义获取数据的方式,有三种方式,分别是

      1. PageKeyedDataSource
      2. ItemKeyedDataSource 
      3. PositionalDataSource.  基于位置信息进行数据的加载,和Room数据库或者本地数据源一起搭配。
    
  • PagedListAdapter: 分页库适配器,继承于RecyclerView的适配器,内部需要实现一个DiffUtil.ItemCallback差分器分析数据是否发生了改变。

  • PagedList: 定义分页库的配置,分别有默认加载数据大小,分页数据大小等。并且通过PagedListAdapter将数据的变化进行更新。

一、通过Room数据库进行分页加载

(一)DataSource的生成

Room是google官方数据库框架:Room,它是一个ORM框架。详情可以查看这里。相对于本地数据源Android Paging分页库的学习(一)—— 结合本地数据进行分页加载,使用Room生成DataSource.Factory 很简单,只需在查询的时候返回DataSource.Factory类型就可以,如下图

这里写图片描述
而Room在编译期为我们生成具体的实现类的实现方法,如下
这里写图片描述
而具体的逻辑实现在LimitOffsetDataSource里面,我们接着往下走,
这里写图片描述
可以看到LimitOffsetDataSource继承于PositionalDataSource,并且可以看到其中有两个查询语句是关键,分别是

  1. "SELECT COUNT(*) FROM ( " + mSourceQuery.getSql() + " )"; 获取数据源的大小,这个很容易理解,就是得到了全部要加载数据的总量。
  2. "SELECT * FROM ( " + mSourceQuery.getSql() + " ) LIMIT ? OFFSET ?"; 这是查询数据表的方式,Limit是每次查询的数量,对应着分页的大小,Offset是查询的偏移位置,对应着每一页的起始位置。 由于我们是通过Room生成PositionalDataSource的,部分的原理就先讲到这里,具体的PositionalDataSource的使用留着在加载本地数据的时候再说明。详情戳

(二)PagedListAdapter的实现

由于PagedListAdapter继承自RecyclerView的适配器,所以实现起来并不难,只是需要提供一个差分的实现用来进行数据的分析,代码如下:

class ArticlePageAdapter : PagedListAdapter<ArticleEntity, ArticleViewHolder>(diffCallback) {
    override fun onBindViewHolder(holder: ArticleViewHolder, position: Int) {
        holder.bindTo(getItem(position))
    }

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ArticleViewHolder =
            ArticleViewHolder(parent)

    companion object {
        private val diffCallback = object : DiffUtil.ItemCallback<ArticleEntity>() {
            override fun areItemsTheSame(oldItem: ArticleEntity, newItem: ArticleEntity): Boolean =
                    oldItem.id == newItem.id

            override fun areContentsTheSame(oldItem: ArticleEntity, newItem: ArticleEntity): Boolean =
                    oldItem == newItem
        }
    }
}

(三)PagedList的配置

PagedList主要是设置分页的大小,初始化加载的数据大小等配置。

 val pagedListConfig =PagedList.Config.Builder().setEnablePlaceholders(true).setPageSize(10).setInitialLoadSizeHint(20).build()
 val pagedList = LivePagedListBuilder(articleDao.getAllByDataSource(), pagedListConfig).build()

通过以上代码生成是一个带LiveData的PagedList

(四)总结

配置好Room数据库,生成DataSource负责数据来源, 接着实现PagedListAdapter负责UI的渲染,最后进行PagedList分页的一些配置。生成一个带LiveData的PagedList,一旦数据进行变化,便会通知pageAdapter调用submitList进行UI的更新

   recycle_article.layoutManager = LinearLayoutManager(this)
   val pageAdapter = ArticlePageAdapter()
   recycle_article.adapter = pageAdapter 
   val articleDao = dataBase.articleDao()
   val pagedListConfig = PagedList.Config.Builder().setEnablePlaceholders(true).setPageSize(10).setInitialLoadSizeHint(20).build()
   val postList = LivePagedListBuilder(articleDao.getAllByDataSource(), pagedListConfig).build()
   postList.observe(this, Observer { pageAdapter.submitList(it)})

demo已经上传,点击传送门,如有疑惑或者错误,欢迎指出。