0Pricing
Android Academy · Lezione

RemoteMediator e caching

Combini il paging di rete e database

RemoteMediator e caching è una lezione Android Academy gratuita su CoddyKit. Questa è la lezione 4 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Android Academy, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Android Academy include 4 lezioni in totale.

Paging offline-first

Un semplice PagingSource di rete funziona, ma se la connessione cade l'elenco rimane vuoto. Per un'app robusta è preferibile che il database sia l'unica fonte di verità e che la rete lo aggiorni in background.

È esattamente ciò che consente RemoteMediator: effettuare il paging dal database locale e recuperare altri dati dalla rete quando il database non contiene più elementi.

L'architettura

Con RemoteMediator i dati fluiscono in una sola direzione:

  • L'interfaccia esegue il paging da un Room PagingSource
  • Quando Room si avvicina alla fine, RemoteMediator recupera la pagina successiva dalla rete
  • Il risultato della rete viene scritto in Room
  • Room emette le nuove righe e l'interfaccia si aggiorna

L'utente visualizza sempre immediatamente i dati memorizzati nella cache, anche offline.

// Network ---> RemoteMediator ---> Room (source of truth) ---> UI
// UI never reads the network directly

PagingSource di Room incluso

Room può generare automaticamente un PagingSource. È sufficiente dichiarare una query che restituisca PagingSource<Int, Entity> e Room lo implementerà.

È questa la sorgente da cui l'interfaccia esegue effettivamente il paging.

import androidx.paging.PagingSource
import androidx.room.Dao
import androidx.room.Query

@Dao
interface ArticleDao {
    @Query("SELECT * FROM articles ORDER BY position ASC")
    fun pagingSource(): PagingSource<Int, ArticleEntity>
}

Estendere RemoteMediator

RemoteMediator<Key, Value> dispone di un metodo obbligatorio, load(), e di un metodo facoltativo, initialize().

load() riceve un LoadType (REFRESH, PREPEND o APPEND) e il PagingState corrente, quindi restituisce un MediatorResult.

import androidx.paging.ExperimentalPagingApi
import androidx.paging.RemoteMediator

@OptIn(ExperimentalPagingApi::class)
class ArticleRemoteMediator(
    private val api: ArticleApi,
    private val db: AppDatabase
) : RemoteMediator<Int, ArticleEntity>() {
    // override suspend fun load(loadType, state): MediatorResult
}

Gestire LoadType

In load() si decide quale pagina recuperare in base a LoadType:

  • REFRESH - carica la prima pagina (o quella intorno all'anchor)
  • PREPEND - di solito non c'è nulla da fare; restituisce endOfPaginationReached = true
  • APPEND - carica la pagina successiva all'ultima disponibile
val page: Int = when (loadType) {
    LoadType.REFRESH -> 1
    LoadType.PREPEND ->
        return MediatorResult.Success(endOfPaginationReached = true)
    LoadType.APPEND -> {
        val lastKey = db.remoteKeyDao().last()?.nextKey
            ?: return MediatorResult.Success(endOfPaginationReached = true)
        lastKey
    }
}

Tabella delle chiavi remote

A differenza di un PagingSource, un RemoteMediator non può restituire direttamente le chiavi successiva e precedente: è necessario salvarle. Le chiavi vanno memorizzate in una piccola tabella di chiavi remote insieme ai dati.

In questo modo è possibile riprendere le operazioni APPEND/PREPEND dopo il riavvio dell'app.

import androidx.room.Entity
import androidx.room.PrimaryKey

@Entity(tableName = "remote_keys")
data class RemoteKey(
    @PrimaryKey val articleId: Int,
    val prevKey: Int?,
    val nextKey: Int?
)

Scrivere i risultati della rete in Room

Dopo aver recuperato una pagina, scriva gli elementi e le relative chiavi in Room all'interno di una transazione. Durante REFRESH, cancelli prima le vecchie tabelle, così la cache rimane coerente.

db.withTransaction {
    if (loadType == LoadType.REFRESH) {
        db.remoteKeyDao().clearAll()
        db.articleDao().clearAll()
    }
    val nextKey = if (response.items.isEmpty()) null else page + 1
    db.remoteKeyDao().insertAll(
        response.items.map { RemoteKey(it.id, prevKey = page - 1, nextKey = nextKey) }
    )
    db.articleDao().insertAll(response.items.map { it.toEntity() })
}

Restituire MediatorResult

Si concluda load() restituendo un MediatorResult:

  • Success(endOfPaginationReached = true) quando non ci sono altre pagine
  • Success(endOfPaginationReached = false) quando potrebbero essercene altre
  • Error(e) in caso di errore, mostrato come LoadState.Error
return try {
    val response = api.getArticles(page = page, size = state.config.pageSize)
    db.withTransaction { /* write items + keys */ }
    MediatorResult.Success(
        endOfPaginationReached = response.items.isEmpty()
    )
} catch (e: IOException) {
    MediatorResult.Error(e)
} catch (e: HttpException) {
    MediatorResult.Error(e)
}

Collegare Pager con remoteMediator

Costruisca il Pager con remoteMediator e pagingSourceFactory di Room. Il mediator riempie Room; l'interfaccia esegue il paging da Room.

Poiché utilizza un'API sperimentale, abiliti l'opt-in con @OptIn(ExperimentalPagingApi::class).

@OptIn(ExperimentalPagingApi::class)
fun articles(): Flow<PagingData<ArticleEntity>> = Pager(
    config = PagingConfig(pageSize = 20),
    remoteMediator = ArticleRemoteMediator(api, db),
    pagingSourceFactory = { db.articleDao().pagingSource() }
).flow

Cercare le chiavi per APPEND

Per un caricamento APPEND è necessario il nextKey dell'ultimo elemento caricato. Utilizzi l'anchor di PagingState per trovare la chiave remote corretta nella tabella delle chiavi.

Le funzioni di supporto mantengono leggibile load() per REFRESH, APPEND e PREPEND.

private suspend fun lastRemoteKey(
    state: PagingState<Int, ArticleEntity>
): RemoteKey? {
    return state.pages.lastOrNull { it.data.isNotEmpty() }
        ?.data?.lastOrNull()
        ?.let { db.remoteKeyDao().keyFor(it.id) }
}

// In load(): for APPEND
val nextKey = lastRemoteKey(state)?.nextKey
    ?: return MediatorResult.Success(endOfPaginationReached = true)

Memorizzazione nella cache e aggiornamento

Poiché i dati risiedono in Room, l'app si carica immediatamente e funziona offline. Per evitare contenuti obsoleti, esegua l'override di initialize() per decidere se aggiornare i dati all'avvio in base all'età della cache.

override suspend fun initialize(): InitializeAction {
    val lastUpdate = db.remoteKeyDao().lastUpdatedMillis() ?: 0L
    val cacheTimeout = TimeUnit.HOURS.toMillis(1)
    return if (System.currentTimeMillis() - lastUpdate >= cacheTimeout) {
        InitializeAction.LAUNCH_INITIAL_REFRESH
    } else {
        InitializeAction.SKIP_INITIAL_REFRESH
    }
}

Verifica rapida

In una configurazione con RemoteMediator, qual è l'unica fonte di verità da cui l'interfaccia esegue il paging?

Riepilogo: RemoteMediator e caching

Ha realizzato una pipeline di paging offline-first:

  • L'interfaccia esegue il paging da un PagingSource di Room, l'unica fonte di verità
  • RemoteMediator.load() gestisce REFRESH/PREPEND/APPEND e scrive i risultati in Room all'interno di una transazione
  • Una tabella di chiavi remote conserva le chiavi successiva e precedente tra i riavvii
  • Il Pager riceve sia un remoteMediator sia un pagingSourceFactory
  • initialize() controlla l'aggiornamento della cache

Ora può caricare in modo efficiente elenchi senza fine, online o offline. Congratulazioni per aver completato il corso Paging 3.

Domande Frequenti

La lezione «RemoteMediator e caching» è gratuita?

Sì — il testo completo di «RemoteMediator e caching» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Android Academy, passa a CoddyKit PRO. Il corso Android Academy include 4 lezioni in totale.

Cosa imparerò in «RemoteMediator e caching»?

Combini il paging di rete e database Eserciti Android Academy con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Android Academy?

Non è richiesta alcuna esperienza precedente. Android Academy su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 4 di 4.

Quanto tempo richiede la lezione «RemoteMediator e caching»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Android Academy?

Sì. Ogni lezione Android Academy include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

  1. Perché usare il paging
  2. PagingSource e Pager
  3. Paging nelle liste Compose
  4. RemoteMediator e caching
← Torna a Android Academy