ANDROID - načítanie dát z REST API: Retrofit, Kotlin a coroutines

Načítanie dát zo servera patrí v Android aplikáciách medzi najčastejšie úlohy. Štandardom je dnes knižnica Retrofit, ktorá z obyčajného rozhrania v Kotline vytvorí HTTP klienta, a coroutines, vďaka ktorým sa sieťová komunikácia píše ako sekvenčný kód bez callbackov a bez blokovania hlavného vlákna.

V návode načítame zoznam príspevkov z testovacieho API JSONPlaceholder a zobrazíme ho v Jetpack Compose vrátane stavu načítania a chyby.

Závislosti

Projekt vytvorte v Android Studiu zo šablóny Empty Activity (Compose). Do app/build.gradle.kts pridajte:

plugins {
    // ... pôvodné pluginy
    kotlin("plugin.serialization") version "2.0.21"   // rovnaká verzia ako Kotlin v projekte
}

dependencies {
    implementation("com.squareup.retrofit2:retrofit:2.11.0")
    implementation("com.squareup.retrofit2:converter-kotlinx-serialization:2.11.0")
    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3")
    implementation("androidx.lifecycle:lifecycle-viewmodel-compose:2.8.7")
    implementation("androidx.lifecycle:lifecycle-runtime-compose:2.8.7")
}

Uvedené verzie sú príklad – Android Studio vám pri každej závislosti ponúkne aktuálnu.

Aplikácia potrebuje povolenie na prístup na internet. Do AndroidManifest.xml nad značku <application>:

<uses-permission android:name="android.permission.INTERNET" />

Ak by aplikácia hlásila UnknownHostException alebo SecurityException, toto povolenie chýba ako prvé.

Dátová trieda

API vracia JSON v tvare {"userId":1,"id":1,"title":"…","body":"…"}. Zodpovedajúca trieda:

import kotlinx.serialization.Serializable

@Serializable
data class Prispevok(
    val id: Int,
    val userId: Int,
    val title: String,
    val body: String
)

Rozhranie API

Každá metóda rozhrania je jeden endpoint. Anotácie určujú metódu HTTP a cestu, kľúčové slovo suspend umožní volať ju z coroutine:

import retrofit2.http.GET
import retrofit2.http.Path
import retrofit2.http.Query

interface PrispevkyApi {

    @GET("posts")
    suspend fun zoznam(@Query("userId") pouzivatel: Int? = null): List<Prispevok>

    @GET("posts/{id}")
    suspend fun detail(@Path("id") id: Int): Prispevok
}

Parameter s hodnotou null Retrofit do adresy vôbec nepridá, takže zoznam() vráti všetky príspevky a zoznam(1) zavolá posts?userId=1.

Vytvorenie klienta

import kotlinx.serialization.json.Json
import okhttp3.MediaType.Companion.toMediaType
import retrofit2.Retrofit
import retrofit2.converter.kotlinx.serialization.asConverterFactory

object Siet {
    private val json = Json { ignoreUnknownKeys = true }

    val api: PrispevkyApi = Retrofit.Builder()
        .baseUrl("https://jsonplaceholder.typicode.com/")   // musí končiť lomkou
        .addConverterFactory(json.asConverterFactory("application/json".toMediaType()))
        .build()
        .create(PrispevkyApi::class.java)
}

ignoreUnknownKeys = true je dôležité: keď server neskôr pridá do odpovede nové pole, aplikácia nespadne. Klienta vytvorte iba raz – preto object; vo väčšom projekte by ho dodávala knižnica na vkladanie závislostí (Hilt, Koin).

ViewModel a stav obrazovky

Stav obrazovky opíšeme uzavretou triedou – obrazovka je vždy práve v jednom z troch stavov:

import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch
import java.io.IOException
import retrofit2.HttpException

sealed interface PrispevkyStav {
    data object Nacitava : PrispevkyStav
    data class Hotovo(val prispevky: List<Prispevok>) : PrispevkyStav
    data class Chyba(val sprava: String) : PrispevkyStav
}

class PrispevkyViewModel(
    private val api: PrispevkyApi = Siet.api
) : ViewModel() {

    private val _stav = MutableStateFlow<PrispevkyStav>(PrispevkyStav.Nacitava)
    val stav: StateFlow<PrispevkyStav> = _stav.asStateFlow()

    init {
        nacitaj()
    }

    fun nacitaj() {
        viewModelScope.launch {
            _stav.value = PrispevkyStav.Nacitava
            _stav.value = try {
                PrispevkyStav.Hotovo(api.zoznam())
            } catch (e: IOException) {
                PrispevkyStav.Chyba("Nie ste pripojený k internetu.")
            } catch (e: HttpException) {
                PrispevkyStav.Chyba("Server vrátil chybu ${e.code()}.")
            }
        }
    }
}

Prečo práve takto:

  • viewModelScope coroutine automaticky zruší, keď používateľ obrazovku natrvalo opustí – nedôjde k úniku pamäte ani k zbytočnej práci.
  • ViewModel prežije otočenie displeja, takže sa dáta pri otočení nenačítavajú znova.
  • Retrofit vykoná suspend volanie na vlastnom vlákne, takže netreba prepínať na Dispatchers.IO.
  • IOException znamená problém so sieťou, HttpException odpoveď 4xx alebo 5xx. Iné výnimky (napr. chybný JSON) zámerne nezachytávame – ide o chybu v programe, ktorú treba počas vývoja vidieť.

Obrazovka v Jetpack Compose

import androidx.compose.foundation.layout.*
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.material3.*
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import androidx.lifecycle.compose.collectAsStateWithLifecycle
import androidx.lifecycle.viewmodel.compose.viewModel

@Composable
fun PrispevkyObrazovka(vm: PrispevkyViewModel = viewModel()) {
    val stav by vm.stav.collectAsStateWithLifecycle()

    when (val s = stav) {
        PrispevkyStav.Nacitava -> Box(Modifier.fillMaxSize(), contentAlignment = Alignment.Center) {
            CircularProgressIndicator()
        }

        is PrispevkyStav.Chyba -> Column(
            Modifier.fillMaxSize().padding(24.dp),
            verticalArrangement = Arrangement.Center,
            horizontalAlignment = Alignment.CenterHorizontally
        ) {
            Text(s.sprava)
            Spacer(Modifier.height(12.dp))
            Button(onClick = vm::nacitaj) { Text("Skúsiť znova") }
        }

        is PrispevkyStav.Hotovo -> LazyColumn(contentPadding = PaddingValues(16.dp)) {
            items(s.prispevky, key = { it.id }) { p ->
                Card(Modifier.fillMaxWidth().padding(vertical = 6.dp)) {
                    Column(Modifier.padding(16.dp)) {
                        Text(p.title, style = MaterialTheme.typography.titleMedium)
                        Spacer(Modifier.height(4.dp))
                        Text(p.body, style = MaterialTheme.typography.bodyMedium, maxLines = 3)
                    }
                }
            }
        }
    }
}

V MainActivity stačí v setContent { … } zavolať PrispevkyObrazovka(). Výraz when nad uzavretou triedou musí pokryť všetky stavy – ak neskôr pridáte nový, kompilátor vás upozorní na každé miesto, kde ho treba ošetriť.

Ladenie komunikácie

Ak chcete vidieť, čo aplikácia posiela a prijíma, pridajte závislosť com.squareup.okhttp3:logging-interceptor a pri vytváraní klienta:

val klient = OkHttpClient.Builder()
    .addInterceptor(HttpLoggingInterceptor().apply {
        level = if (BuildConfig.DEBUG) HttpLoggingInterceptor.Level.BODY
                else HttpLoggingInterceptor.Level.NONE
    })
    .build()

Retrofit.Builder()
    .baseUrl("https://jsonplaceholder.typicode.com/")
    .client(klient)
    // ...

Požiadavky a odpovede sa potom zobrazia v okne Logcat. V produkčnej verzii logovanie vypnite – vypisovali by sa aj prihlasovacie tokeny. Ak BuildConfig neexistuje, zapnite v build.gradle.kts voľbu buildFeatures { buildConfig = true }.

Zhrnutie

  • Nezabudnite na povolenie INTERNET v manifeste.
  • Endpointy opíšte rozhraním s suspend funkciami, Retrofit vytvorí implementáciu.
  • V JSON parseri zapnite ignoreUnknownKeys.
  • Volania spúšťajte vo viewModelScope a stav obrazovky vystavte cez StateFlow.
  • Rozlišujte chybu siete (IOException) a chybu servera (HttpException).
O autorovi

Ing.Jaroslav Vadel

Som zakladateľom www.projectik.eu. Hrám sa na programátora, ktorý ovláda: c#,cpp,java,unity3d,php,html,NI testand,NI Vision Builder,Cognex In-Sight,NI LabView "Naprogramovať program, ktorý funguje vie každy. Ale to, že program funguje ešte neznamena, že je napísany správne "

Súvisiace články