Android Paging 3库PagingSource失效，导致列表由于刷新键错误（未使用空间）而跳转

Question

由于我目前正在开发一个带有自定义数据库（不是 Room）的项目，因此我正在测试是否可以在该项目中使用 Paging 3 库。但是，我遇到了一个问题，如果您对数据进行更改并因此使分页源无效，则列表的重新创建会出现错误并跳转到不同的位置。发生这种情况是因为刷新键计算似乎是错误的，这很可能是由于初始加载加载了三页数据，但将其放入一页而引起的。

默认的分页源如下所示：

    override fun getRefreshKey(state: PagingState<Int, CustomData>): Int? {
        // Try to find the page key of the closest page to anchorPosition, from
        // either the prevKey or the nextKey, but you need to handle nullability
        // here:
        //  * prevKey == null -> anchorPage is the first page.
        //  * nextKey == null -> anchorPage is the last page.
        //  * both prevKey and nextKey null -> anchorPage is the initial page, so
        //    just return null.
        return state.anchorPosition?.let { anchorPosition ->
            val anchorPage = state.closestPageToPosition(anchorPosition)
            anchorPage?.prevKey?.plus(1) ?: anchorPage?.nextKey?.minus(1)
        }
    }

override suspend fun load(params: LoadParams<Int>): LoadResult<Int, CustomData> {
    var pagePosition = params.key ?: STARTING_PAGE_INDEX
    var loadSize = params.loadSize
    return try {
        val dataResult = dataRepository.getPagedData(
            pagePosition = pagePosition,
            loadSize = loadSize,
            pageSize = pageSize
        )
        val nextKey = if (dataResult.isEmpty() || dataResult.size < pageSize) {
            null
        } else {
            pagePosition + (loadSize / pageSize)
        }
        Log.i(
            "RoomFreePagingSource",
            "page $pagePosition with size $loadSize publish ${dataResult.size} routes"
        )
        return LoadResult.Page(
            data = dataResult,
            prevKey = if (pagePosition == STARTING_PAGE_INDEX) null else pagePosition - 1,
            nextKey = nextKey
        )

    } catch (exception: Exception) {
        LoadResult.Error(exception)
    }
}

该dataRepository.getPagedData()函数只是访问内存列表并返回列表的一部分，模拟分页数据。为了完整起见，这里是该函数的实现：

fun getPagedData(pageSize:Int, loadSize:Int, pagePosition: Int): List<CustomData>{
    val startIndex = pagePosition * pageSize
    val endIndexExl =startIndex + loadSize
    return data.safeSubList(startIndex,endIndexExl).map { it.copy() }
}

private fun <T> List<T>.safeSubList(fromIndex: Int, toIndex: Int) : List<T>{
    // only returns list with valid range, to not throw exception
    if(fromIndex>= this.size)
        return emptyList()
    val endIndex = if(toIndex> this.size) this.size else toIndex
    return subList(fromIndex,endIndex)
}

我目前面临的主要问题是，该getRefreshKey函数没有返回正确的刷新页面键，这导致刷新错误的页面并且列表跳转到加​​载的页面。

• 例如，如果每页有 10 个项目。
• 第一页 0 包含 30 条
• 下一页为 3，包含 10 项。
• 如果您不滚动（仅看到前 7 项）并且无效，则将anchorPosition为 7，刷新键将为 2。（anchorPage.prevKey = null =>anchorPage.nextKey = 3 => 3-1 为 2）然而，此时我们想要加载页面 0 而不是页面 2。

了解问题的原因后，我尝试调整默认实现来解决它，并提出了许多不同的版本。下面的目前效果最好，但仍然会时不时地导致跳跃。有时列表的一部分也会闪烁，这可能是由于未获取足够的项目来填充视口而引起的。

override fun getRefreshKey(state: PagingState<Int, CustomData>): Int? {
    return state.anchorPosition?.let { anchorPosition ->
        val closestPage = state.closestPageToPosition(anchorPosition)?.prevKey
            ?: STARTING_PAGE_INDEX
        val refKey = if(anchorPosition>(closestPage)*pageSize + pageSize)
            closestPage+1
        else
            closestPage

        Log.i(
            "RoomFreePagingSource",
            "getRefreshKey $refKey from anchorPosition $anchorPosition closestPage $closestPage"
        )
        refKey
    }
}

override suspend fun load(params: LoadParams<Int>): LoadResult<Int, CustomData> {
    var pagePosition = params.key ?: STARTING_PAGE_INDEX
    var loadSize = pageSize
    return try {
        when (params) {
            is LoadParams.Refresh -> {
                if (pagePosition > STARTING_PAGE_INDEX) {
                    loadSize *= 3
                } else if (pagePosition == STARTING_PAGE_INDEX) {
                    loadSize *= 2
                }
            }
            else -> {}
        }
        val dataResult = dataRepository.getPagedData(
            pagePosition = pagePosition,
            loadSize = loadSize,
            pageSize = pageSize
        )
        val nextKey = if (dataResult.isEmpty() || dataResult.size < pageSize) {
            null
        } else {
            pagePosition + (loadSize / pageSize)
        }
        Log.i(
            "RouteRepository",
            "page $pagePosition with size $loadSize publish ${dataResult.size} routes"
        )
        return LoadResult.Page(
            data = dataResult,
            prevKey = if (pagePosition == STARTING_PAGE_INDEX) null else pagePosition - 1,
            nextKey = nextKey
        )

    } catch (exception: Exception) {
        LoadResult.Error(exception)
    }
}

理论上，我发现最好的解决方案是像这样计算刷新 PageKey anchorPosition/pageSize，然后加载此页面（之前和之后的页面）。然而，像这样计算刷新键不起作用，因为anchorPosition 不是列表中项目的实际位置。经过一些失效后，即使您当前正在查看列表中的第 140 项，锚点也可能为 5。

总结一下：

当我不使用 Room，而是使用另一个数据源时，如何在失效后计算正确的刷新页面，例如本示例中我通过访问的内存列表getPagedData？

Answer 1

同时我自己找到了解决方案，但忘记在此处添加答案。

1. in是错误的，因为没有为分页源返回的每个 Page 设置参数anchorPosition。这种行为似乎没有记录。getRefreshKey()itemsBefore

   LoadResult.Page(
       itemsBefore = pagePosition * pageSize,
       data = dataResult,
       prevKey = if (pagePosition == STARTING_PAGE_INDEX) null else pagePosition - 1,
       nextKey = nextKey
   )
   

2. 现在我们实际上可以根据 和anchorPositionthe pageSize（在本例中定义为PagingSource构造函数参数，但也可以是常量等）来确定刷新键

   override fun getRefreshKey(state: PagingState<Int, CustomData>): Int? {
       return state.anchorPosition?.let { anchorPosition ->
           anchorPosition / pageSize
       }
   }
   

3. 不，刷新/使其无效时，列表不再跳转。但是，有时列表可能会闪烁，或者在失效时列表的整个部分将不可见。这是因为刷新页面太小，没有覆盖整个视口。因此，人们可以看到刷新页面之外的项目的分页操作。可以通过将刷新页面 ( loadSize) 增大 3 倍并将 减小pagePosition1 来修复此行为。3 次是必要的，因为实际刷新页面之前和之后的页面可以在视图端口中看到。

   if (params is LoadParams.Refresh) {
       loadSize *= 3
       pagePosition = max(0, pagePosition - 1)
   }
   

这个解决方案现在工作得很好，但是，感觉这不能/不应该是这个问题的官方解决方案。因为在使用寻呼和空间时，所有这些调整都是不必要的。因此，我愿意接受其他/更好的解决方案。

这里是 PagingSource 工作的完整代码以及所有提到的更改：

override fun getRefreshKey(state: PagingState<Int, CustomData>): Int? {
    return state.anchorPosition?.let { anchorPosition ->
        anchorPosition / pageSize
    }
}

override suspend fun load(params: LoadParams<Int>): LoadResult<Int, CustomData> {
    var pagePosition = params.key ?: STARTING_PAGE_INDEX
    var loadSize = pageSize
    return try {
        if (params is LoadParams.Refresh) {
            // make sure everything visible in the view port is updated / loaded
            loadSize *= 3
            pagePosition = max(0, pagePosition - 1)
        }
        val dataResult = dataRepository.getPagedData(
            pagePosition = pagePosition,
            loadSize = loadSize,
            pageSize = pageSize
        )
        val nextKey = if (dataResult.isEmpty() || dataResult.size < pageSize) {
            null
        } else {
            pagePosition + (loadSize / pageSize)
        }
        LoadResult.Page(
            itemsBefore = pagePosition * pageSize,
            data = dataResult,
            prevKey = if (pagePosition == STARTING_PAGE_INDEX) null else pagePosition - 1,
            nextKey = nextKey
        )
    } catch (exception: Exception) {
        LoadResult.Error(exception)
    }
}