Compose 调用 - 分页加载 Paging

原创已于 2026-01-31 16:42:28 修改 · 1.4k 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#android

于 2023-11-07 17:29:56 首次发布

Compose 专栏收录该内容

69 篇文章

订阅专栏

本文介绍了如何在Android应用中使用JetpackCompose和Paging库实现数据加载与分页，包括添加依赖、定义自定义PagingSource、在ViewModel中管理数据流以及在UI中展示数据的过程。

一、添加依赖

查看官方最新版本

val paging_version = "3.2.1"
implementation("androidx.paging:paging-runtime:$paging_version")
implementation("androidx.paging:paging-compose:$paging_version")

二、定义数据源

class DemoDataSource {
    fun dataFlow() = Pager(PagingConfig(10)) { PagingResource() }.flow
}

private class PagingResource : PagingSource<Int, Article>() {
    private val startPage = 0
    override suspend fun load(params: LoadParams<Int>): LoadResult<Int, Article> {
        return try {
            val currentPage = params.key ?: startPage
            val data = getData(currentPage)
            val prevKey = if (currentPage > startPage) currentPage - 1 else null
            val nextKey = if (data.isNotEmpty()) currentPage + 1 else null
            LoadResult.Page(data, prevKey, nextKey)
        } catch (e: Exception) {
            LoadResult.Error(e)
        }
    }

    override fun getRefreshKey(state: PagingState<Int, Article>): Int? {
        return null
    }

    //具体获取数据的方法。这里能更细分的对异常处理，否则在load()中合并返回后在UI中难区分。
    //但处理后还是要抛出异常，不然load()不会返回异常，影响UI中对Paging状态判断
    private suspend fun getData(currentPage: Int): List<Article> {
        var data: List<Article> = emptyList()
        runCatching {
            ApiService.newestArticle(currentPage.toString())
        }.onSuccess {
            data = it
        }.onFailure {
            throw it
        }
        return data
    }
}

三、ViewModel 中调用

class DemoViewModel(
    private val repository = DemoRepository()
) : ViewModel() {
    var dataFlow = repository.dataFlow().cachedIn(viewModelScope)    //缓存在ViewModel中
}

四、UI

collectAsLazyPagingItems()方法将Flow<PagingData<T>>转换为一个LazyPagingItems<T>对象。这个对象可以被LazyColumn或者LazyRow等Jetpack Compose中的列表组件使用，来动态地加载和显示数据。

@Composable
fun DemoScreen(
    viewModel: DemoViewModel = viewModel()
) {
    //将Paging的数据从Flow转为可供LazyColumn使用的
    val lazyPagingItems = viewModel.pagingDataFlow.collectAsLazyPagingItems()
    //监听Paging状态
    when (lazyPagingItems.loadState.refresh) {
        //正在加载
        is LoadState.Loading -> {}
        //加载错误（这里的错误是PagingSource里捕获的）
        is LoadState.Error -> {}
        //当没有加载动作并且没有错误的时候
        is LoadState.NotLoading -> {}
    }
    LazyColumn(
        modifier = Modifier.fillMaxSize(),
        state = lazyListState
    ){
        items(
            count = lazyPagingItems.itemCount,
            key = lazyPagingItems.itemKey { it.id }
        ) { index ->
            val bean = lazyPagingItems[index]
            if (bean != null) {
                val author = bean.author
                val shareUser = bean.shareUser
                val superChapterName = bean.superChapterName
                Item(
                    title = bean.title,
                    author = if (author.isEmpty()) String.format("%s · %s", superChapterName, shareUser) else String.format("%s · %s", superChapterName, author),
                    time = bean.niceDate,
                )
            } else {
                Text("")
            }
        }
    }
}