Android JetPack系列之—

在android开发过程中，分页是最常见的功能，基于手机屏幕较小而页面数据较多的情况下分页显得尤为重要，在之前我们使用的是ListView来自己实现分页的功能，后来官方出了RecyclerView渐渐的取代了ListView来实现分页的功能，虽然RecyclerView足够强大，但是始终没有一个很好的分页框架，更多的时候是八仙过海各显神通，借助RecyclerView自己封装一个分页框架，比较有名的就是XRecyclerView。但是在2018年的IO大会上，官方正式推出了Paging来实现分页的功能，下面我们就一起来看看吧。

一、Paging是什么？

Paging库可以帮助您一次加载和显示多个小的数据块，按需载入部分数据可以减少网络宽带和系统资源的使用量。

二、Paging库的重要组成组件

1.DataSource：用于生成应用数据块
DataSource是Paging使用过程中数据源的源头，当然从字面意思也可以推测出，其中key代表的是加载数据的条件信息，Value对应加载数据的实体类。DataSource是一个抽象类，但是我们不能直接继承它，需要继承系统为我们提供的继承它的子类，具体来讲有下面三个子类供我们选择。

PageKeyedDataSource：适用于根据页数来加载数据的场景，即key是我们的页数，Value是我们页数对应的数据。
ItemKeyedDataSource：适用于特定依赖的item的信息，即目标条目的关键信息。比如需要根据第N项的信息加载第N+1项的数据，传参中需要传入第N项的ID时，该场景多出现于论坛类应用评论信息的请求。
PositionalDataSource：适用于目标数据总数固定，通过特定的位置加载数据，这里的key是Integer类型的位置信息，T即Value。

2.PagedList：用于加载应用数据块
在页面中随着所需数据的增多，系统会将其分页到现有的PagedList对象中。如果任何已加载的数据发生更改，会从基于LiveData或RxJava2的对象向可观察数据存储器发出一个新的PagedList实例。随着PagedList对象的生成，应用界面会呈现其内容，同时还会考虑界面控件的生命周期。

class ConcertViewModel(concertDao: ConcertDao) : ViewModel() {
    val concertList: LiveData> =
            concertDao.concertsByDate().toLiveData(pageSize = 50)
}

PageList是一个List的子类，支持所有List的操作，除此之外它主要有五个成员：
(1) mMainThreadExecutor：一个主线程的Excutor, 用于将结果post到主线程。
(2) mBackgroundThreadExecutor：后台线程的Excutor。
(3) BoundaryCallback：响应Datasource中的数据加载到边界时的回调。
(4) Config: 配置PagedList从Datasource加载数据的方式，其中包含以下属性：

pageSize：设置每页加载的数量
prefetchDistance：预加载的数量，默认为pagesize
initialLoadSizeHint：初始化数据时加载的数量，默认为pageSize*3
enablePlaceholders：当item为null是否使用PlaceHolder展示

(5) PagedStorage: 用于存储加载到的数据，它是真正的蓄水池所在，它包含一个ArrayList 对象mPages，按页存储数据。

PagedList会从DataSource中加载数据，更准确的说是通过Datasource加载数据，通过Config的配置，可以设置一次加载的数量以及预加载的数量。除此之外，PagedList还可以向RecyclerView.Adapter发送更新的信号，驱动UI的刷新。

3.PagedListAdapter：RecyclerView.Adapter的实现
PagedListAdapte是RecyclerView.Adapter的实现，用于展示PagedList的数据。它本身实现的更多是Adapter的功能，但是它有一个小伙伴PagedListAdapterHelper， PagedListAdapterHelper会负责监听PagedList的更新， Item数量的统计等功能。这样当PagedList中新一页的数据加载完成时， PagedAdapte就会发出加载完成的信号，通知RecyclerView刷新，这样就省略了每次loading后手动调一次notifyDataChanged()。

除此之外，当数据源变动产生新的PagedList,PagedAdapter会在后台线程中比较前后两个PagedList的差异，然后调用notifyItem…()方法更新RecyclerView.这一过程依赖它的另一个小伙伴ListAdapterConfig， ListAdapterConfig负责主线程和后台线程的调度以及DiffCallback的管理，DiffCallback的接口实现中定义比较的规则，比较的工作则是由PagedStorageDiffHelper来完成。

三、Paging库的使用

1.添加依赖

implementation "androidx.paging:paging-runtime-ktx:3.0.1"
testImplementation "androidx.paging:paging-common-ktx:3.0.1"
implementation "androidx.paging:paging-rxjava2-ktx:3.0.1"

2.创建实体类

class Concert {
     var name: String? = null
     var userId = 0
}

3.创建数据集
方式一：PagedKeyUserDataSource 的加载方式

/**
 * @author: zhoufan
 * @date:   2021/9/7 11:19
 * PagedKeyUserDataSource 的加载方式
 */
class ConcertPageKeyedDataSource : PageKeyedDataSource() {


    var FIRST_PAGE = 1
    val PAGE_SIZE = 20

    /**
     * 加载分页数据
     */
    override fun loadAfter(params: LoadParams, callback: LoadCallback) {
        val concertList = mutableListOf()
        val startPosition = FIRST_PAGE * PAGE_SIZE
        for (i in startPosition..(startPosition + 19)) {
            val concert = Concert()
            concert.name = "jack$i"
            concertList.add(concert)
        }
        callback.onResult(concertList, FIRST_PAGE++)
    }

    /**
     * 加载前执行方法
     * 只会执行一次
     */
    override fun loadBefore(params: LoadParams, callback: LoadCallback) {

    }

    /**
     * 加载第一页数据
     */
    override fun loadInitial(
        params: LoadInitialParams,
        callback: LoadInitialCallback
    ) {
        val concertList = mutableListOf()
        for (i in 0..19) {
            val concert = Concert()
            concert.name = "jack$i"
            concertList.add(concert)
        }
        callback.onResult(concertList, null, FIRST_PAGE)
    }
}

方式二：ItemKeyedDataSource 的加载方式

/**
 * @author: zhoufan
 * @date:   2021/9/7 11:35
 * ItemKeyedDataSource 的加载方式
 */
class ConcertItemKeyedDataSource : ItemKeyedDataSource() {

    var FIRST_PAGE = 1
    val PAGE_SIZE = 20

    /**
     * 获取下一页的起始位置
     */
    override fun getKey(item: Concert): Int {
        return item.userId
    }

    /**
     * 加载分页数据
     */
    override fun loadAfter(params: LoadParams, callback: LoadCallback) {
        Log.i("aaaaaaaaaaaa", "正在请求第${FIRST_PAGE}数据")
        val concertList = mutableListOf()
        val startPosition = FIRST_PAGE++ * PAGE_SIZE
        for (i in startPosition..(startPosition + 19)) {
            val concert = Concert()
            concert.name = "jack$i"
            concert.userId = i
            concertList.add(concert)
        }
        callback.onResult(concertList)
    }

    /**
     * 加载前执行方法
     * 只会执行一次
     */
    override fun loadBefore(params: LoadParams, callback: LoadCallback) {
        Log.i("aaaaaaaaaaaa", "请求第${FIRST_PAGE}数据")
    }

    /**
     * 加载第一页数据
     */
    override fun loadInitial(
        params: LoadInitialParams,
        callback: LoadInitialCallback
    ) {
        val concertList = mutableListOf()
        for (i in 0..19) {
            val concert = Concert()
            concert.name = "jack$i"
            concert.userId = i
            concertList.add(concert)
        }
        callback.onResult(concertList)
    }
}

方式三：PositionalUserDataSource的加载方式

/**
 * @author: zhoufan
 * @date:   2021/9/6 13:59
 * PositionalUserDataSource的加载方式
 */
class ConcertPositionalDataSource : PositionalDataSource() {

    /**
     * 加载第一页数据
     */
    override fun loadInitial(params: LoadInitialParams, callback: LoadInitialCallback) {
        val concertList = mutableListOf()
        for (i in 0..19) {
            val concert = Concert()
            concert.name = "jack$i"
            concertList.add(concert)
        }
        callback.onResult(concertList, 0, 2000)
    }

    /**
     * 加载分页数据
     */
    override fun loadRange(params: LoadRangeParams, callback: LoadRangeCallback) {
        val concertList = mutableListOf()
        for (i in params.startPosition..(params.startPosition + params.loadSize)) {
            val concert = Concert()
            concert.name = "jack$i"
            concertList.add(concert)
        }
        callback.onResult(concertList)
    }
}

4.生成数据

/**
 * @author: zhoufan
 * @date:   2021/9/6 14:08
 */
class ConcertFactory : DataSource.Factory() {

    private var sourceLiveData: MutableLiveData = MutableLiveData()

    override fun create(): DataSource {
        val concertDataSource =
            ConcertItemKeyedDataSource()
        sourceLiveData.postValue(concertDataSource)
        return concertDataSource
    }
}

5.使用ViewModel来处理数据

class ConcertViewModel : ViewModel() {

    var convertList: LiveData>? = null
    private var concertDataSource: DataSource? = null

    init {
        val concertFactory = ConcertFactory()
        concertDataSource = concertFactory.create()
        val config = PagedList.Config.Builder()
            .setEnablePlaceholders(true).setPageSize(20).setPrefetchDistance(3).build()
        convertList = LivePagedListBuilder(concertFactory, config).build()
    }

    fun invalidateDataSource() {
        concertDataSource!!.invalidate()
    }
}

6.使用Adapter来显示数据

/**
 * @author: zhoufan
 * @date:   2021/9/6 14:17
 */
open class RecyclerViewAdapter:
    PagedListAdapter(
        DIFF_CALLBACK
    ) {

    inner class RecyclerViewHolder(view: View) : RecyclerView.ViewHolder(view) {
        val tv: TextView = view.findViewById(R.id.tv_content)
    }

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RecyclerViewHolder {
        val view =
            LayoutInflater.from(parent.context).inflate(R.layout.adapter_paging, parent, false)
        return RecyclerViewHolder(view)
    }

    override fun onBindViewHolder(holder: RecyclerViewHolder, position: Int) {
        val concert = getItem(position)
        if (concert != null) {
            holder.tv.text = concert.name
        }
    }

    companion object {
        private val DIFF_CALLBACK: DiffUtil.ItemCallback =
            object : DiffUtil.ItemCallback() {
                override fun areItemsTheSame(
                    oldConcert: Concert,
                    newConcert: Concert
                ): Boolean {
                    return oldConcert.name == newConcert.name
                }

                override fun areContentsTheSame(
                    oldConcert: Concert,
                    newConcert: Concert
                ): Boolean {
                    return oldConcert.equals(newConcert)
                }
            }
    }
}

7.在Activity里面实现功能

class PagingActivity : AppCompatActivity() {

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

        val adapter = RecyclerViewAdapter()
        val viewModel: ConcertViewModel = ViewModelProvider(this).get(
            ConcertViewModel::class.java
        )
        concert_list.adapter = adapter
        concert_list.layoutManager = LinearLayoutManager(this)
        viewModel.convertList?.observe(this, Observer {
            adapter.submitList(it)
        })
    }
}

最后呈现的效果如下：

Paging.gif

到这里，关于Paging的基本使用就结束了，当然在实际的开发过程中我们还会碰到各种各样的问题，这就需要我们灵活应变去解决了。

Android JetPack系列之——Paging

一、Paging是什么？

二、Paging库的重要组成组件

三、Paging库的使用

你可能感兴趣的:(Android JetPack系列之——Paging)