Android Paging分頁庫的學習(二)—— 結合Room資料庫進行分頁載入

少年阿濤發表於2018-10-22

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已經上傳,點選傳送門,如有疑惑或者錯誤,歡迎指出。

相關文章