Android Academy · Lekcja

RemoteMediator i buforowanie

Połącz stronicowanie sieciowe i bazodanowe

RemoteMediator i buforowanie to bezpłatna lekcja Android Academy na CoddyKit. To lekcja 4 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej Android Academy, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs Android Academy zawiera 4 lekcji w sumie.

Paginacja offline-first

Zwykły sieciowy PagingSource działa, ale gdy połączenie zostanie przerwane, lista jest pusta. W solidnej aplikacji baza danych powinna być jedynym źródłem prawdy, a sieć powinna uzupełniać ją w tle.

Właśnie to umożliwia RemoteMediator: dane są stronicowane z lokalnej bazy danych, a gdy zabraknie w niej danych, aplikacja pobiera kolejne z sieci.

Architektura

W przypadku RemoteMediator dane przepływają w jednym kierunku:

Interfejs użytkownika stronicuje dane z obiektu PagingSource biblioteki Room
Gdy Room zbliża się do końca danych, RemoteMediator pobiera z sieci kolejną stronę
Wynik z sieci jest zapisywany w Room
Room emituje nowe wiersze, a interfejs użytkownika się aktualizuje

Użytkownik zawsze natychmiast widzi dane z pamięci podręcznej, nawet w trybie offline.

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

PagingSource biblioteki Room bez dodatkowej pracy

Room może automatycznie wygenerować obiekt PagingSource. Wystarczy zadeklarować zapytanie zwracające PagingSource<Int, Entity>, a Room zajmie się jego implementacją.

To właśnie z tego źródła interfejs użytkownika pobiera dane stronami.

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>
}

Dziedziczenie po RemoteMediator

RemoteMediator<Key, Value> ma jedną wymaganą metodę — load() — oraz opcjonalną metodę initialize().

load() otrzymuje obiekt LoadType (REFRESH, PREPEND lub APPEND) oraz bieżący obiekt PagingState, a następnie zwraca obiekt 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
}

Obsługa LoadType

W metodzie load() na podstawie LoadType decyduje Pan lub Pani, którą stronę pobrać:

REFRESH — wczytanie pierwszej strony (lub strony w pobliżu kotwicy)
PREPEND — zazwyczaj nie trzeba nic robić; należy zwrócić endOfPaginationReached = true
APPEND — wczytanie strony znajdującej się za ostatnią posiadaną stroną

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
    }
}

Tabela kluczy zdalnych

W przeciwieństwie do obiektu PagingSource, RemoteMediator nie może bezpośrednio zwracać kluczy następnej i poprzedniej strony — trzeba je utrwalać. Należy przechowywać je w niewielkiej tabeli kluczy zdalnych obok danych.

Dzięki temu można kontynuować operacje APPEND/PREPEND po ponownym uruchomieniu aplikacji.

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?
)

Zapisywanie wyników z sieci w Room

Po pobraniu strony należy zapisać elementy i ich klucze w Room w ramach transakcji. Podczas REFRESH najpierw należy wyczyścić stare tabele, aby pamięć podręczna pozostała spójna.

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() })
}

Zwracanie MediatorResult

Metodę load() należy zakończyć, zwracając obiekt MediatorResult:

Success(endOfPaginationReached = true), gdy nie ma już więcej stron
Success(endOfPaginationReached = false), gdy mogą istnieć kolejne strony
Error(e) w przypadku błędu — zostanie on udostępniony jako 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)
}

Konfigurowanie Pager z remoteMediator

Należy utworzyć obiekt Pager zarówno z remoteMediator, jak i z obiektem Room pagingSourceFactory. Mediator uzupełnia Room, a interfejs użytkownika pobiera dane stronami z Room.

Ponieważ używane jest eksperymentalne API, należy włączyć je za pomocą @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

Wyszukiwanie kluczy dla APPEND

W przypadku ładowania APPEND potrzebny jest obiekt nextKey ostatnio wczytanego elementu. Należy użyć kotwicy PagingState, aby znaleźć właściwy klucz zdalny w tabeli kluczy.

Funkcje pomocnicze ułatwiają zachowanie czytelności metody load() podczas obsługi REFRESH, APPEND i 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)

Buforowanie i aktualność danych

Ponieważ dane znajdują się w Room, aplikacja wczytuje je natychmiast i działa offline. Aby uniknąć wyświetlania nieaktualnych treści, należy przesłonić metodę initialize() i na podstawie wieku pamięci podręcznej zdecydować, czy podczas uruchamiania wykonać odświeżenie.

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
    }
}

Szybkie sprawdzenie

W konfiguracji z RemoteMediator co jest jedynym źródłem prawdy, z którego interfejs użytkownika pobiera dane stronami?

Podsumowanie: RemoteMediator i buforowanie

Zbudował Pan lub zbudowała Pani potok stronicowania offline-first:

Interfejs użytkownika pobiera dane stronami z obiektu PagingSource biblioteki Room — jedynego źródła prawdy
RemoteMediator.load() obsługuje REFRESH/PREPEND/APPEND i zapisuje wyniki w Room w ramach transakcji
Tabela kluczy zdalnych przechowuje klucze następnej i poprzedniej strony także po ponownym uruchomieniu aplikacji
Obiekt Pager otrzymuje zarówno remoteMediator, jak i pagingSourceFactory
initialize() steruje aktualnością pamięci podręcznej

Może Pan teraz lub może Pani teraz wydajnie wczytywać nieskończone listy — online i offline. Gratulujemy ukończenia kursu Paging 3.

Często zadawane pytania

Czy lekcja „RemoteMediator i buforowanie” jest bezpłatna?

Tak — pełny tekst „RemoteMediator i buforowanie” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu Android Academy, przejdź na CoddyKit PRO. Kurs Android Academy zawiera 4 lekcji w sumie.

Co nauczysz się w „RemoteMediator i buforowanie”?

Połącz stronicowanie sieciowe i bazodanowe Ćwiczysz Android Academy z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć Android Academy?

Nie wymagamy żadnego doświadczenia. Android Academy w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 4 z 4.

Ile czasu zajmuje lekcja „RemoteMediator i buforowanie”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji Android Academy?

Tak. Każda lekcja Android Academy zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

← Powrót do Android Academy