# 前言在现代移动应用中，大数据列表的展示是一种常见的需求。然而，处理大量数据的网络加载过程可能会带来一些挑战，比如长时间的等待、空数据或错误信息的展示。为了提供更好的用户体验，我们需要在数据加载过程中显示合适的加载状态，使用户能够清楚地知道当前数据的加载状态，并在必要时提供相应的反馈和交互。 Paging 3 是 Google 推出的用于处理大数据列表的分页库，它为我们提供了一种优雅的方式来处理数据加载和分页。而在 Paging 3 中，处理网络数据加载状态是非常重要的一部分。用户可能会在滚动列表时不断加载新的数据，或者在加载失败时需要进行错误重试。在这些情况下，合理的加载状态展示对于提供良好的用户体验至关重要。在本文中，我们将深入探讨在使用 Paging 3 进行网络数据加载时，如何处理加载状态，以及如何使用 Paging 3 提供的工具和方法来实现更好的用户体验。我们将学习如何使用 `LoadState` 和 `CombinedLoadStates` 类来获取加载状态信息，并在 `RecyclerView` 中添加加载状态项。同时，还会介绍如何自定义加载状态视图，以满足应用的样式和需求，并实现点击加载失败视图时进行重试的功能。 # Paging 3 加载状态在使用 Paging 3 进行网络数据加载时，了解和理解加载状态是非常重要的。Paging 3 提供了一些类和接口来表示数据加载状态，帮助我们在界面上展示合适的加载提示和交互。主要涉及的概念有两个： - 加载状态类型`LoadState` - 加载类型`LoadType` 1. ## **加载状态的类型LoadState**： Paging3中用`LoadState`来表示加载状态， `LoadState`是一个枚举类，表示加载状态的不同阶段。它包含以下几个状态： | 加载**状态类型** | **含义** | | ---------------------- | ----------------------------------------------------------------------------------------------- | | `LoadState.Loading` | 表示数据正在加载中，通常在加载初始化数据以及用户滚动列表时加载更多数据时会出现这个状态 | | `LoadState.NotLoading` | 表示数据加载成功，该状态包含一个`endOfPaginationReached`字段，为`false`表示已经没有更多数据了，为`true`表示还有更多数据，用户还可以继续下拉或上拉加载更多 | | `LoadState.Error` | 表示加载数据时发生了错误，可能是网络请求失败或其他异常情况 | 2. ## **加载类型** **`LoadType`** | **加载类型** | **含义** | | --------- | ---------------------------------------------------------------- | | `refresh` | 表示整个数据列表的刷新状态，包括初始化列表数据，整个列表数据的刷新 | | `prepend` | 表示加载上一页数据，对应用户下拉更多，常见的状态和含义与 `refresh` 类似，只是在这里表示的是加载上一页数据的状态。 | | `append` | 表示加载下一页数据，对应用户上拉加载更多，常见的状态和含义与 `refresh` 类似，只是在这里表示的是加载下一页数据的状态。 | 3. ## **`CombinedLoadStates`** **类** `CombinedLoadStates` 是一个包含了所有加载类型的类，即它包含三个属性：分别对应三种加载类型`refresh`、`prepend`、`append` ，它将数据加载的各个类型进行了组合。通过 `CombinedLoadStates`，我们可以同时获得每个加载类型对应的详细信息，包括加载状态以及相关的异常信息。在 RecyclerView 中，我们通常需要根据 `CombinedLoadStates` 的内容来决定是否展示加载状态项或错误视图。例如，当列表正在加载中时，我们可以显示加载中的动画或提示信息；当数据加载成功时，我们可以隐藏加载状态项；当加载失败时，我们可以展示加载失败的提示并提供重试功能，比如： ``` private val loadStateListener = object : Function1 { override fun invoke(combinedLoadStates: CombinedLoadStates) { when (val state = combinedLoadStates.refresh) { is LoadState.Loading -> { println("refresh Loading") // Show loading animation or loading indicator } is LoadState.Error -> { // Show error message or handle error state val errorMessage = state.error.message ?: "Unknown error" // Display the error message to the user } is LoadState.NotLoading -> { println("refresh NotLoading") // Hide loading animation or loading indicator } } when (val state = combinedLoadStates.append) { is LoadState.Loading -> { println("append Loading") // Show loading animation or loading indicator } is LoadState.Error -> { // Show error message or handle error state val errorMessage = state.error.message ?: "Unknown error" // Display the error message to the user } is LoadState.NotLoading -> { println("append NotLoading") // Hide loading animation or loading indicator } } } } ``` # 在PagingSoure中发送数据加载状态首先我们根据上文，可以知道，数据加载状态分为：`LoadState.Loading`/`LoadState.NotLoading`/`LoadState.Error` 而对于`PagingSource`来讲，它的返回值为`LoadResult`，`LoadResult` 有三种可选值： | **`LoadResult`** **类型** | **含义** | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `LoadResult.Page` | 表示成功加载了一页数据。当 `PagingSource` 成功加载了一页数据时，会使用 `LoadResult.Page` 来封装这些数据，并提供与加载结果相关的额外信息，如是否有前一页数据 (`prevKey`) 和是否有后一页数据 (`nextKey`)，用于支持分页加载 | | `LoadResult.Error` | 表示加载数据过程中出现了错误。当 `PagingSource` 加载数据过程中发生了异常或错误，会使用 `LoadResult.Error` 来封装错误信息，例如网络请求失败或数据解析错误。这样，外部代码可以根据 `LoadResult.Error` 中的错误信息进行错误处理和展示逻辑。 | | `LoadResult.Invalid` | 表示当前的`PagingSource`加载的数据无效或不可用。返回`Invalid`将触发`Paging`框架调用`invalidate` 重新构建`PagingSource`实例，从而抛弃当前无效的`PagingSource`实例 | 一般情况下，我们不需要考虑`LoadResult.Invalid` 的状态，本文也暂且不做此种状态的讨论。通常，当数据请求正常时，`PagingSource`返回`LoadResult.Page` ，对应数据加载状态`LoadState.NotLoading`，当请求出错时，返回`LoadResult.Error` ，而当框架判断加载状态为`LoadState.Loading` 才会调用`PagingSource.load`方法，因此三种数据加载状态和`PagingSource` 对应了起来： ``` class MyPagingSource(private val apiService: ApiService) : PagingSource() { override fun getRefreshKey(state: PagingState): Int? { return null } override suspend fun load(params: LoadParams): LoadResult { try { // 获取请求的页数 val pageNumber = params.key ?: 1 var listItems = mutableListOf() // 加载数据 apiService.getItems(pageNumber, params.loadSize) .onSuccess { listItems.addAll(it) }.onFailure { // 加载出错：返回加载错误的 LoadResult.Error 对象 return LoadResult.Error(it) } val prevKey = if (pageNumber > 1) pageNumber - 1 else null val nextKey = if (listItems.isNotEmpty()) pageNumber + 1 else null // 本次加载结束：构建 LoadResult.Page 对象并返回 return LoadResult.Page( data = listItems, prevKey = prevKey, nextKey = nextKey ) } catch (e: Exception) { // 加载出错：返回加载错误的 LoadResult.Error 对象 return LoadResult.Error(e) } } } ``` # 网络加载状态处理示例在以下的示例中，我们将解决两个问题： - 初始化数据加载成功或失败的处理 - 加载下一页时成功或失败的处理 ## 初始化数据加载状态处理 1. ### 定义不同加载状态下的UI 加载状态可以分为： 1. 正在加载数据 1. 加载失败 1. 加载成功 1. 加载的内容为空 - **正在加载数据的UI：** loading圈 + 正在加载中的文案 ``` ``` - **加载失败的UI：** 加载异常的提示 + 重新加载的按钮 ```