如何在 PagingSource LoadResult Page Paging 3 中使用 itemAfter 或 itemBefore

Posted 2023-04-18

【中文标题】如何在 PagingSource LoadResult Page Paging 3 中使用 itemAfter 或 itemBefore

【英文标题】：How to use itemAfter or itemBefore in PagingSource LoadResult Page Paging 3

【发布时间】：2021-11-20 09:33:15

【问题描述】：

嘿，我正在使用 Viewpager 2 和 Paging 3 库 处理无限数据。我在分页源的帮助下成功创建了创建无限页面的逻辑。我正在通过按钮在两个方向上滑动单个页面。

观看视频链接：- Youtube Video

Github 来源：-ViewPager Repository

我得到的问题

当我在上一个按钮上缓慢单击时，它会滑动单个页面，但是如果我在上一个按钮上快速单击多次，它开始滚动的次数超过我们单击的次数，并且在我们单击 viewpager 之前它不会停止。这是一种竞争条件。

我在问题跟踪器中询问，他们建议我使用 itemBefore 和 itemAfter IssueTracker。我实现了这个，但我没有取得好的结果。

MainActivity.kt

package com.example.viewpagerexample

import android.os.Bundle
import androidx.activity.viewModels
import androidx.appcompat.app.AppCompatActivity
import androidx.lifecycle.lifecycleScope
import com.example.viewpagerexample.databinding.ActivityMainBinding
import kotlinx.coroutines.flow.collectLatest
import kotlinx.coroutines.launch

class MainActivity : AppCompatActivity() 

    private val viewModel by viewModels<ViewPagerViewModel>()
    private lateinit var binding : ActivityMainBinding

    override fun onCreate(savedInstanceState: Bundle?) 
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater)
        setContentView(binding.root)

        val adapter = ViewPagerAdapter()
        lifecycleScope.launch 
            viewModel.dataList.collectLatest 
                adapter.submitData(it)
            
        
        binding.viewpager.adapter = adapter

        binding.next.setOnClickListener 
            binding.viewpager.setCurrentItem(binding.viewpager.currentItem.plus(1), true)
        

        binding.previous.setOnClickListener 
            binding.viewpager.setCurrentItem(binding.viewpager.currentItem.minus(1), true)
        
    

ViewPagerDataSource.kt

package com.example.viewpagerexample

import android.util.Log
import java.util.*

class ViewPagerDataSource(
    private val pageSize: Int,
    private val currentDate: Date
) 
    fun loadDataSource(pageNumber: Int): List<Date> 
        val dates = mutableListOf<Date>()
        val startingDate = startingDate(pageNumber)
        val tempCalendar = Calendar.getInstance()
        tempCalendar.time = startingDate

        Log.e("loadData startingDate", "" + startingDate)

        var index = 0;
        while (index++ < pageSize) 
            dates.add(tempCalendar.time)
            tempCalendar.add(Calendar.DATE, 1)
        
        return dates
    

    private fun startingDate(pageNumber: Int): Date 
        Calendar.getInstance().let 
            it.time = currentDate
            it.add(Calendar.DATE, (pageNumber * pageSize) + pageSize)
            return it.time
        
    

ViewPagerPagingSource.kt

这是我的寻呼源，我不知道如何在我的情况下使用 itembefore 和 itemAfter。另外我没有得到 getRefreshKey 这有什么用？如果我通过 null 就可以了，或者我还需要通过什么。

package com.example.viewpagerexample

import androidx.paging.PagingSource
import androidx.paging.PagingState
import java.io.IOException
import java.util.*

class ViewPagerPagingSource(
    private val dataSource: ViewPagerDataSource
) : PagingSource<Int, Date>() 

    override suspend fun load(params: LoadParams<Int>): LoadResult<Int, Date> 
        val position = params.key ?: 0

        return try 
            val data = dataSource.loadDataSource(position)
            LoadResult.Page(
                data = data,
                prevKey = if (data.isEmpty()) null else position - 1,
                nextKey = if (data.isEmpty()) null else position + 1,
                itemsBefore = LoadResult.Page.COUNT_UNDEFINED,
                itemsAfter = LoadResult.Page.COUNT_UNDEFINED
            )
         catch (exception: IOException) 
            LoadResult.Error(exception)
        
    

    override fun getRefreshKey(state: PagingState<Int, Date>): Int? 
        return null
    

ViewPagerViewModel.kt

package com.example.viewpagerexample

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.paging.Pager
import androidx.paging.PagingConfig
import java.util.*

class ViewPagerViewModel(app: Application) : AndroidViewModel(app) 

    private val dataSource = ViewPagerDataSource(10, currentDate())

    val dataList =
        Pager(config = PagingConfig(
            pageSize = 10,
            enablePlaceholders = true
        ), pagingSourceFactory = 
            ViewPagerPagingSource(dataSource)
        ).flow

    private fun currentDate(): Date 
        val calendar = Calendar.getInstance()
        return calendar.time
    

Adapter 和 Holder 附在 Github Link 中，如果需要，请自行查找。

build.Gradle

plugins 
    id 'com.android.application'
    id 'kotlin-android'
    id 'kotlin-kapt'


android 
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig 
        applicationId "com.example.viewpagerexample"
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    

    buildTypes 
        release 
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        
    
    compileOptions 
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    
    kotlinOptions 
        jvmTarget = '1.8'
    
    buildFeatures 
        viewBinding true
    


dependencies 

    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation 'androidx.core:core-ktx:1.6.0'
    implementation 'androidx.appcompat:appcompat:1.3.1'
    implementation 'com.google.android.material:material:1.4.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.0'

    implementation "androidx.viewpager2:viewpager2:1.0.0"

    implementation "androidx.paging:paging-runtime-ktx:3.0.1"

    implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.1"
    implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.3.1"
    implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.3.1"
    implementation "android.arch.lifecycle:extensions:1.1.1"
    implementation 'androidx.fragment:fragment-ktx:1.3.6'

    //noinspection GradleDynamicVersion
    testImplementation 'junit:junit:4.+'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'

【问题讨论】：

我很想看到这个问题的答案

【参考方案1】：

我没有深入挖掘，我不知道为什么只有当您以编程方式滚动到上一页时才会出现此问题。据我所知，使用 itemBefore 和 itemAfter 的唯一原因是当您想在数据仍在加载时显示占位符并且您知道确切的数据长度。关于 getRefreshKey() 方法 - 这是我在官方文档中找到的 -

如果项目是基于整数位置键加载的，你可以返回 state.anchorPosition

所以我无法解释为什么会出现这个问题，但我可以给你一段可能会解决它的代码：

 binding.previous.setOnClickListener 
            if (binding.viewpager.scrollState == SCROLL_STATE_IDLE) 
                binding.viewpager.setCurrentItem(binding.viewpager.currentItem.minus(1), true)
            
        

我查看了ViewPager2的源代码，注意到关于滚动，分别有view.post()这样的调用，这是由于多线程造成的。正如我所说，我没有深入研究问题，而是找到了一个常量，与 ViewPager2 的当前滚动状态进行比较（SCROLL_STATE_IDLE - 表示 ViewPager2 处于空闲、稳定状态）。

编辑： 例如，要使其前进 10 天并无限后退，您应该这样做：

class ViewPagerViewModel(app: Application) : AndroidViewModel(app) 

    private val dataSource = ViewPagerDataSource(5, currentDate(), endDate())

    val dataList =
        Pager(config = PagingConfig(
            pageSize = 5,
            enablePlaceholders = false,
            jumpThreshold =5
        ), pagingSourceFactory = 
            ViewPagerPagingSource(dataSource)
        ).flow

    private fun currentDate(): Date 
        val calendar = Calendar.getInstance()
        return calendar.time
    

    private fun endDate(): Date 
        val calendar = Calendar.getInstance()
        calendar.time = Date()
        calendar.add(Calendar.DATE, 10)
        return calendar.time
    

然后-

class ViewPagerDataSource(
    private val pageSize: Int,
    private val currentDate: Date,
    private val endDate: Date
) 
    fun loadDataSource(pageNumber: Int): List<Date> 
        val dates = mutableListOf<Date>()
        val startingDate = startingDate(pageNumber)
        if (startingDate.after(endDate))
            return dates
        
        val tempCalendar = Calendar.getInstance()
        tempCalendar.time = startingDate

        Log.e("loadData startingDate", "" + startingDate)

        var index = 0;
        while (index++ < pageSize) 
            dates.add(tempCalendar.time)
            tempCalendar.add(Calendar.DATE, 1)
        
        return dates
    

    private fun startingDate(pageNumber: Int): Date 
        Calendar.getInstance().let 
            it.time = currentDate
            it.add(Calendar.DATE, (pageNumber * pageSize) + pageSize)
            return it.time
        
    

【讨论】：

嘿@AlexRmcf 它解决了我的问题。太感谢了。所以`getRefreshKey()`我需要传递一些东西还是只传递null。

在你的情况下只返回 state.anchorPosition

再次感谢一百万。你是救生员@AlexRmcf。我再次需要一点帮助 ViewPagerDataSource 你能看到那个文件吗？在里面，我在双方都创建了无限的日期。我怎样才能停止在特定日期创建列表。如果我通过任何 endLimitDate 我的列表将不会在 endLimitDate 之后创建，而是在该日期之前创建无限日期。我也坚持这一点，你能告诉我我怎么能做到这一点。谢谢

是的，你可以这样做。只需做这样的事情 - 将 private val endLimitDate : Date 添加到 ViewPagerDataSource() 构造函数。然后在你的 loadDataSource(pageNumber: Int) 做这样的事情 - if (startingDate.after(endLimitDate )) return dates 其中 dates 只是 Date 的空列表，这可能就是全部

如果我将 endLimit 日期传递给当前日期 07/10/2021，那么列表将返回所有以前的日期，例如 07/10/2021 ，2021 年 6 月 10 日，2021 年 5 月 10 日... 直到无限的前一个日期。对吗？

【参考方案2】：

发生这种情况是因为您正在使用平滑滚动的数据绑定： 平滑滚动需要时间来执行，当您尝试快速单击时，绑定会在滚动时进入下一页并开始无限滚动：

有两种解决方案：

1 - 使平滑滚动为假：

binding.viewpager.setCurrentItem(binding.viewpager.currentItem.plus(1), false)

2- 将绑定与滚动代码分开：

val nextPage = binding.viewpager.currentItem+1
binding.viewpager.setCurrentItem(nextPage, true)

【讨论】：

感谢您的帮助。这不是数据绑定问题。如果您使用合成，问题将是相同的。最重要的是我无法从那里删除平滑滚动。