Paging简析

彬_小彬

于 2024-07-27 21:57:47 发布

阅读量537

点赞数 6

分类专栏： Jetpack Android 文章标签： android Jetpack Paging

本文链接：https://blog.csdn.net/github_35942716/article/details/140677230

版权

Android 同时被 2 个专栏收录

70 篇文章 0 订阅

订阅专栏

Jetpack

11 篇文章 0 订阅

订阅专栏

Android Paging 是 Jetpack 组件的一部分，用于高效地加载和显示大量数据。它通过分页技术来分块加载数据，减少内存使用和提高加载速度。以下是 Paging 的工作原理及其基本使用方法。

Paging 原理

数据源（DataSource）：DataSource 是 Paging 的核心组件，负责提供数据。数据源可以是数据库、网络或其他数据来源。常见的数据源类型包括 PageKeyedDataSource、ItemKeyedDataSource 和 PositionalDataSource。
PagedList：PagedList 是一个分页列表，负责管理从 DataSource 加载的数据。它会根据需要加载数据，确保只加载和保持必要的页面。
PagedListAdapter：PagedListAdapter 是 RecyclerView.Adapter 的子类，用于显示 PagedList 中的数据。它能智能地处理数据变化，并进行高效的差异计算。
PagingConfig：PagingConfig 用于配置分页的行为，如页面大小、预取距离和初始加载大小等。
PagingSource 和 RemoteMediator：在 Paging 3 库中，引入了新的 PagingSource 和 RemoteMediator 接口，以替代旧版中的 DataSource。PagingSource 用于定义如何加载页面数据，而 RemoteMediator 用于在本地缓存和远程数据源之间进行协调。

基本使用方法（Paging 3）

添加依赖项：在项目的 build.gradle 文件中添加 Paging 组件的依赖项。

dependencies {
    def paging_version = "3.0.0"
    implementation "androidx.paging:paging-runtime:$paging_version"
}

定义 PagingSource：创建一个继承自 PagingSource 的类，重写 load 方法，定义如何加载页面数据。

class MyPagingSource : PagingSource<Int, MyData>() {
    override suspend fun load(params: LoadParams<Int>): LoadResult<Int, MyData> {
        return try {
            val nextPageNumber = params.key ?: 1
            val response = myApiService.getData(nextPageNumber, params.loadSize)
            LoadResult.Page(
                data = response.items,
                prevKey = if (nextPageNumber == 1) null else nextPageNumber - 1,
                nextKey = if (response.items.isEmpty()) null else nextPageNumber + 1
            )
        } catch (e: Exception) {
            LoadResult.Error(e)
        }
    }
}

配置 PagingDataAdapter：创建一个继承自 PagingDataAdapter 的类，设置 DiffUtil.ItemCallback 来处理数据变化。

class MyPagingDataAdapter : PagingDataAdapter<MyData, MyViewHolder>(DIFF_CALLBACK) {
    companion object {
        private val DIFF_CALLBACK = object : DiffUtil.ItemCallback<MyData>() {
            override fun areItemsTheSame(oldItem: MyData, newItem: MyData): Boolean {
                return oldItem.id == newItem.id
            }

            override fun areContentsTheSame(oldItem: MyData, newItem: MyData): Boolean {
                return oldItem == newItem
            }
        }
    }

    override fun onBindViewHolder(holder: MyViewHolder, position: Int) {
        val item = getItem(position)
        if (item != null) {
            holder.bind(item)
        }
    }

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

创建 ViewModel：在 ViewModel 中创建 PagingData 实例，并将其暴露给 UI 层。

class MyViewModel : ViewModel() {
    val myPagingData: Flow<PagingData<MyData>> = Pager(PagingConfig(pageSize = 20)) {
        MyPagingSource()
    }.flow.cachedIn(viewModelScope)
}

在 Activity 或 Fragment 中观察数据：在 Activity 或 Fragment 中观察 PagingData，并将其提交给 PagingDataAdapter。

class MyFragment : Fragment() {

    private val viewModel: MyViewModel by viewModels()
    private lateinit var adapter: MyPagingDataAdapter

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)

        adapter = MyPagingDataAdapter()
        recyclerView.adapter = adapter

        lifecycleScope.launchWhenStarted {
            viewModel.myPagingData.collectLatest { pagingData ->
                adapter.submitData(pagingData)
            }
        }
    }
}

Paging 工作流程

初始化数据源：创建一个继承自 PagingSource 的类，定义如何加载数据页面。
配置 PagedList：使用 Pager 和 PagingConfig 来配置 PagedList 的行为。
创建 Adapter：创建一个继承自 PagingDataAdapter 的类，设置差异计算逻辑。
在 ViewModel 中暴露 PagingData：在 ViewModel 中创建 Pager 实例，并将 PagingData 以 Flow 的形式暴露给 UI 层。
观察数据并提交给 Adapter：在 Activity 或 Fragment 中观察 PagingData 的变化，并将其提交给 PagingDataAdapter 进行显示。