Paginación con Paging 3

class ListaAMano(private val libros: List<String>) {
    private var desde = 0                          // el contador de desplazamiento
    val enPantalla = mutableListOf<String>()       // lo que ya se ve
 
    suspend fun pedirMas() {
        val inicio = desde                         // desde dónde se pide esta vez
        println("piden 10 desde el $inicio")
        delay(100)                                 // la «red» tarda un poco
        val pagina = libros.drop(inicio).take(10)  // los 10 libros que tocan
        enPantalla += pagina
        desde = inicio + pagina.size               // el contador sube cuando llega la respuesta
    }
}
 
fun main() = runBlocking {
    val lista = ListaAMano((1..45).map { "Libro $it" })
    launch { lista.pedirMas() }                    // la pantalla avisa dos veces seguidas:
    launch { lista.pedirMas() }                    // «ya casi llegas al final»
    delay(300)
    println("en pantalla: ${lista.enPantalla.size} libros; distintos: ${lista.enPantalla.distinct().size}")
}

piden 10 desde el 0
piden 10 desde el 0
en pantalla: 20 libros; distintos: 10

// Una biblioteca con 45 libros: «Libro 1», «Libro 2»… La clave de cada página
// es cuántos libros hay antes de ella (el desplazamiento).
class LibrosPagingSource : PagingSource<Int, String>() {   // clave: Int, contenido: String
    private val todos = (1..45).map { "Libro $it" }        // los 45 libros
 
    // Paging llama aquí cada vez que quiere una página.
    override suspend fun load(params: LoadParams<Int>): LoadResult<Int, String> {
        val desde = params.key ?: 0                            // la primera vez no hay clave: desde el 0
        val hasta = minOf(desde + params.loadSize, todos.size) // sin pasar del último libro
        println("piden ${params.loadSize} desde el $desde")
        val pagina = todos.subList(desde, hasta)               // los libros de esta página
        return LoadResult.Page(
            data = pagina,
            prevKey = null,                                     // esta biblioteca solo avanza
            nextKey = if (hasta == todos.size) null else hasta, // null: no hay más páginas
        )
    }
 
    // Dónde empezar si hay que recargar. Aquí, siempre desde el principio.
    override fun getRefreshKey(state: PagingState<Int, String>): Int? = null
}
 
// Cómo se recorre. Va dentro de un test (`runTest`, el que ya conoces de las
// corrutinas): así `asSnapshot`, que espera, puede ejecutarse.
@Test
fun recorreLosLibros() = runTest {
    // El `Pager` une la fuente con una configuración: páginas de 10, y avisar
    // cuando queden 2 libros por delante del final de lo cargado.
    val pager = Pager(PagingConfig(pageSize = 10, prefetchDistance = 2, initialLoadSize = 10)) { LibrosPagingSource() }
    // `asSnapshot` hace de pantalla: baja hasta el libro 45 (índice 44) y devuelve lo que ha visto.
    val enPantalla = pager.flow.asSnapshot { scrollTo(index = 44) }
    println("en pantalla: ${enPantalla.size} libros, del «${enPantalla.first()}» al «${enPantalla.last()}»")
}

piden 10 desde el 0
piden 10 desde el 10
piden 10 desde el 20
piden 10 desde el 30
piden 10 desde el 40
en pantalla: 45 libros, del «Libro 1» al «Libro 45»

paging = "3.5.1"

# La lógica de paginación: PagingSource, Pager, PagingData. Vale en todas las plataformas.
androidx-paging-common = { module = "androidx.paging:paging-common", version.ref = "paging" }
# asSnapshot: recorre un flujo de páginas en un test, como haría la pantalla.
androidx-paging-testing = { module = "androidx.paging:paging-testing", version.ref = "paging" }

            // api: PagingData asoma en la cara pública del ViewModel.
            api(libs.androidx.paging.common)

            // Solo para tests, y en commonTest: corre en las tres plataformas.
            implementation(libs.androidx.paging.testing)

./gradlew :shared:dependencies --configuration iosSimulatorArm64CompileKlibraries | grep paging

+--- androidx.paging:paging-common:3.5.1
|    \--- androidx.paging:paging-common-iossimulatorarm64:3.5.1

src/commonMain/kotlin/com/sebastiannarvaez/pokedex/feature/list/PokemonPagingSource.kt

package com.sebastiannarvaez.pokedex.feature.list
 
import androidx.paging.PagingSource
import androidx.paging.PagingState
import com.sebastiannarvaez.pokedex.data.PokemonRepository
import com.sebastiannarvaez.pokedex.domain.Pokemon
import kotlinx.coroutines.CancellationException
 
// De dónde salen las páginas. Paging le pregunta «dame la página que empieza
// en X» y esta clase se lo pide al repositorio.
// `PagingSource<Int, Pokemon>`: la clave de cada página es un `Int` (el
// desplazamiento: cuántos Pokémon hay antes) y lo que trae cada página, `Pokemon`.
internal class PokemonPagingSource(
    private val repository: PokemonRepository,
) : PagingSource<Int, Pokemon>() {
 
    // Paging la llama cada vez que necesita una página.
    override suspend fun load(params: LoadParams<Int>): LoadResult<Int, Pokemon> {
        // La primera vez no hay clave (`null`): se empieza en el 0.
        val offset = params.key ?: 0
        // Cuántos Pokémon se piden esta vez: lo decide Paging, no nosotros.
        val limit = params.loadSize
 
        // `try` devuelve un valor: la página si todo va bien, el error si algo falla.
        return try {
            val pokemon = repository.page(limit = limit, offset = offset)
            LoadResult.Page(
                data = pokemon,
                // La lista solo avanza: nunca se pide una página anterior. `null`
                // le dice a Paging que por arriba no hay nada que cargar.
                prevKey = null,
                // Página siguiente. Si ésta ha venido corta, se acabó la lista: `null`
                // apaga la petición de la siguiente y Paging deja de pedir.
                nextKey = if (pokemon.size < limit) null else offset + limit,
            )
        } catch (e: CancellationException) {
            // Que se cancele la carga (el usuario se va de la pantalla) no es un
            // fallo de red: se relanza para que no acabe como un error de la lista.
            throw e
        } catch (e: Throwable) {
            // Paging convierte esto en `LoadState.Error`, que la pantalla pinta con su
            // botón de reintentar. No se traga nada.
            LoadResult.Error(e)
        }
    }
 
    // Dónde empezar al recargar (tirar para refrescar, reintentar tras un fallo):
    // siempre desde el principio. Como la lista solo avanza y no carga hacia
    // atrás, empezar a mitad dejaría fuera todo lo anterior.
    override fun getRefreshKey(state: PagingState<Int, Pokemon>): Int? = null
}

src/commonMain/kotlin/com/sebastiannarvaez/pokedex/feature/list/PokemonListViewModel.kt

package com.sebastiannarvaez.pokedex.feature.list
 
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import androidx.paging.Pager
import androidx.paging.PagingConfig
import androidx.paging.PagingData
import androidx.paging.cachedIn
import com.sebastiannarvaez.pokedex.data.PokemonRepository
import com.sebastiannarvaez.pokedex.domain.Pokemon
import kotlinx.coroutines.flow.Flow
 
// El ViewModel de la lista. `internal constructor` significa que solo se puede
// construir dentro del módulo `shared` (el repositorio que recibe también es
// `internal`); la clase es pública, así que las apps la usan sin construirla
// ellas: la crea Koin.
class PokemonListViewModel internal constructor(
    // Sin `val`: es solo un parámetro del constructor, no una propiedad de la clase.
    // La lambda de `pagingSourceFactory` lo recuerda mientras haga falta.
    repository: PokemonRepository,
) : ViewModel() {
 
    // El flujo de páginas que la pantalla recoge. Cada emisión es un `PagingData`.
    val pokemon: Flow<PagingData<Pokemon>> = Pager(
        config = PagingConfig(
            // Veinte por página: cada una cuesta una petición de listado más una
            // por Pokémon, así que subirlo multiplica el tráfico.
            pageSize = PAGE_SIZE,
            // Cuántos quedan por delante antes de pedir la siguiente página.
            prefetchDistance = 5,
            // Sin huecos reservados para lo que aún no se ha cargado.
            enablePlaceholders = false,
        ),
        // Cómo crear la fuente de páginas; Paging la llama cuando la necesita
        // (por ejemplo, al refrescar).
        pagingSourceFactory = { PokemonPagingSource(repository) },
        // `.flow` es el flujo de `PagingData`; `cachedIn` lo guarda mientras
        // viva el ViewModel (explicado justo debajo).
    ).flow.cachedIn(viewModelScope)
 
    // Lo que va dentro de `companion object` se llama con el nombre de la clase,
    // sin crear ninguna instancia: `PokemonListViewModel.PAGE_SIZE`.
    companion object {
        // `const`: el valor se fija al compilar.
        const val PAGE_SIZE = 20
    }
}

    // El ViewModel de la lista; Koin le da el PokemonRepository que ya está registrado.
    viewModelOf(::PokemonListViewModel)