Android Paging分頁庫的學習（一）—— 結合本地資料進行分頁載入

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

Paging分頁庫的介紹

Paging分頁面是google推出的一個結合RecyclerView進行分頁載入資料的一個全新架構庫，主要是為了解決一次性載入大量資料而造成的資源浪費問題。通過分頁的方式，每次載入一頁資料，既可以加快介面的渲染，又可以減少物件等資源的建立消耗。具體可以看官網

分頁庫主要由以下三個部分組成

  • DataSource： 資料來源，定義獲取資料的方式，有三種方式，分別是

      1. PageKeyedDataSource
  2. ItemKeyedDataSource 
  3. PositionalDataSource.  基於位置資訊進行資料的載入，和Room資料庫或者本地資料來源一起搭配。
複製程式碼

  • PagedListAdapter: 分頁庫介面卡，繼承於RecyclerView的介面卡，內部需要實現一個DiffUtil.ItemCallback差分器分析資料是否發生了改變。

  • PagedList： 定義分頁庫的配置，分別有預設載入資料大小，分頁資料大小等。並且通過PagedListAdapter將資料的變化進行更新。

一、通過本地資料進行分頁載入

（一）DataSource的生成

由於此次使用的是本地資料，所以需要的列表的位置資訊，在這裡，我們需要實現基於PositionalDataSource的資料來源

class LocalDataSourceFactory:DataSource.Factory<Int, ArticleEntity>() {
    override fun create(): DataSource<Int, ArticleEntity> {
        return localDataSource
    }

    companion object {
        val localDataSource = object : PositionalDataSource<ArticleEntity>() {
            private fun computeCount(): Int {
                return 10000
            }
            private fun loadRangeInternal(startPosition: Int, loadCount: Int): List<ArticleEntity> {
                val articleList = mutableListOf<ArticleEntity>()
                val authorPrefix = "作者"
                val titlePrefix = "我是一個標題"
                val typePrefix = "類別"
                val timeStampBase = 1531548138000L
                for (i in 0 until loadCount) {
                    var articleEntity = ArticleEntity()
                    articleEntity.id = (startPosition + i).toString()
                    articleEntity.author = "$authorPrefix ${articleEntity.id}"
                    articleEntity.title = "$titlePrefix ${articleEntity.id}"
                    articleEntity.type = "$typePrefix ${articleEntity.id}"
                    articleEntity.timeStamp = timeStampBase + i * 1000L
                    articleList.add(articleEntity)
                }
                return articleList
            }

            override fun loadRange(params: LoadRangeParams, callback: LoadRangeCallback<ArticleEntity>) {
                Log.e("LoadRange", "range" + params.startPosition)
                callback.onResult(loadRangeInternal(params.startPosition, params.loadSize))
            }

            override fun loadInitial(params: LoadInitialParams, callback: LoadInitialCallback<ArticleEntity>) {
                val totalCount = computeCount()
                val position = PositionalDataSource.computeInitialLoadPosition(params, totalCount)
                val loadSize = PositionalDataSource.computeInitialLoadSize(params, position, totalCount)
                callback.onResult(loadRangeInternal(position, loadSize), position, totalCount)
            }
        }
    }

}
複製程式碼

需要實現PositionalDataSource的兩個方法，分別是loadInitial和loadRange，loadInitial負責拉取配置的載入條數，即下文的PagedList配置， loadRange負責載入每次分頁所需的資料。所以實現資料來源很簡單，只需定義好首次載入資料和分頁載入資料的邏輯既可。

（二）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()
 var postList = LivePagedListBuilder(LocalDataSourceFactory(), pagedListConfig).build()
複製程式碼

通過以上程式碼生成是一個帶LiveData的PagedList

（四）總結

生成DataSource負責資料來源, 接著實現PagedListAdapter負責UI的渲染，最後進行PagedList分頁的一些配置。生成一個帶LiveData的PagedList，一旦資料進行變化，便會通知pageAdapter呼叫submitList進行UI的更新

class LocalDataPagingActivity:AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.act_local_data_paging)

        val pageAdapter = ArticlePageAdapter()
        recycle_article.adapter = pageAdapter
        recycle_article.layoutManager = LinearLayoutManager(this)

        val pagedListConfig = PagedList.Config.Builder().setEnablePlaceholders(true).setPageSize(10).setInitialLoadSizeHint(20).build()
        var postList = LivePagedListBuilder(LocalDataSourceFactory(), pagedListConfig).build()
        postList.observe(this, Observer {
            pageAdapter.submitList(it)
        })
    }
}
複製程式碼

demo已經上傳，點選傳送門，如有疑惑或者錯誤，歡迎指出。
另外一個傳送門Android Paging分頁庫的學習（二）—— 結合Room資料庫進行分頁載入

相關文章