kotlin-coroutines-flows

Kotlin Coroutines & Flows

Patterns pour la concurrence structurée, les flux réactifs basés sur Flow, et les tests de coroutines dans les projets Android et Kotlin Multiplatform.

Quand activer

• Écrire du code asynchrone avec les coroutines Kotlin
• Utiliser Flow, StateFlow ou SharedFlow pour des données réactives
• Gérer des opérations concurrentes (chargement parallèle, debounce, retry)
• Tester les coroutines et les Flows
• Gérer les scopes de coroutines et l'annulation

Concurrence structurée

Hiérarchie des scopes

Application
  └── viewModelScope (ViewModel)
        └── coroutineScope { } (enfant structuré)
              ├── async { } (tâche concurrente)
              └── async { } (tâche concurrente)

Toujours utiliser la concurrence structurée — jamais GlobalScope :

// MAUVAIS
GlobalScope.launch { fetchData() }

// BON — limité au cycle de vie du ViewModel
viewModelScope.launch { fetchData() }

// BON — limité au cycle de vie du composable
LaunchedEffect(key) { fetchData() }

Décomposition parallèle

Utilisez coroutineScope + async pour le travail parallèle :

suspend fun loadDashboard(): Dashboard = coroutineScope {
    val items = async { itemRepository.getRecent() }
    val stats = async { statsRepository.getToday() }
    val profile = async { userRepository.getCurrent() }
    Dashboard(
        items = items.await(),
        stats = stats.await(),
        profile = profile.await()
    )
}

SupervisorScope

Utilisez supervisorScope lorsque les échecs d'enfants ne doivent pas annuler les frères :

suspend fun syncAll() = supervisorScope {
    launch { syncItems() }       // un échec ici n'annulera pas syncStats
    launch { syncStats() }
    launch { syncSettings() }
}

Patterns Flow

Cold Flow — Conversion d'un one-shot en flux

fun observeItems(): Flow<List<Item>> = flow {
    // Réémet chaque fois que la base de données change
    itemDao.observeAll()
        .map { entities -> entities.map { it.toDomain() } }
        .collect { emit(it) }
}

StateFlow pour l'état de l'interface utilisateur

class DashboardViewModel(
    observeProgress: ObserveUserProgressUseCase
) : ViewModel() {
    val progress: StateFlow<UserProgress> = observeProgress()
        .stateIn(
            scope = viewModelScope,
            started = SharingStarted.WhileSubscribed(5_000),
            initialValue = UserProgress.EMPTY
        )
}

WhileSubscribed(5_000) maintient le flux amont actif pendant 5 secondes après le départ du dernier abonné — survit aux changements de configuration sans redémarrer.

Combinaison de plusieurs Flow

val uiState: StateFlow<HomeState> = combine(
    itemRepository.observeItems(),
    settingsRepository.observeTheme(),
    userRepository.observeProfile()
) { items, theme, profile ->
    HomeState(items = items, theme = theme, profile = profile)
}.stateIn(viewModelScope, SharingStarted.WhileSubscribed(5_000), HomeState())

Opérateurs Flow

// Debounce de la saisie de recherche
searchQuery
    .debounce(300)
    .distinctUntilChanged()
    .flatMapLatest { query -> repository.search(query) }
    .catch { emit(emptyList()) }
    .collect { results -> _state.update { it.copy(results = results) } }

// Retry avec backoff exponentiel
fun fetchWithRetry(): Flow<Data> = flow { emit(api.fetch()) }
    .retryWhen { cause, attempt ->
        if (cause is IOException && attempt < 3) {
            delay(1000L * (1 shl attempt.toInt()))
            true
        } else {
            false
        }
    }

SharedFlow pour les événements uniques

class ItemListViewModel : ViewModel() {
    private val _effects = MutableSharedFlow<Effect>()
    val effects: SharedFlow<Effect> = _effects.asSharedFlow()

    sealed interface Effect {
        data class ShowSnackbar(val message: String) : Effect
        data class NavigateTo(val route: String) : Effect
    }

    private fun deleteItem(id: String) {
        viewModelScope.launch {
            repository.delete(id)
            _effects.emit(Effect.ShowSnackbar("Élément supprimé"))
        }
    }
}

// Collecter dans le Composable
LaunchedEffect(Unit) {
    viewModel.effects.collect { effect ->
        when (effect) {
            is Effect.ShowSnackbar -> snackbarHostState.showSnackbar(effect.message)
            is Effect.NavigateTo -> navController.navigate(effect.route)
        }
    }
}

Dispatchers

// Travail intensif en CPU
withContext(Dispatchers.Default) { parseJson(largePayload) }

// Travail lié aux E/S
withContext(Dispatchers.IO) { database.query() }

// Thread principal (UI) — par défaut dans viewModelScope
withContext(Dispatchers.Main) { updateUi() }

En KMP, utilisez Dispatchers.Default et Dispatchers.Main (disponibles sur toutes les plateformes). Dispatchers.IO est limité à JVM/Android — utilisez Dispatchers.Default sur les autres plateformes ou fournissez-le via DI.

Annulation

Annulation coopérative

Les boucles longues doivent vérifier l'annulation :

suspend fun processItems(items: List<Item>) = coroutineScope {
    for (item in items) {
        ensureActive()  // lance CancellationException si annulé
        process(item)
    }
}

Nettoyage avec try/finally

viewModelScope.launch {
    try {
        _state.update { it.copy(isLoading = true) }
        val data = repository.fetch()
        _state.update { it.copy(data = data) }
    } finally {
        _state.update { it.copy(isLoading = false) }  // s'exécute toujours, même en cas d'annulation
    }
}

Tests

Tester StateFlow avec Turbine

@Test
fun `la recherche met à jour la liste d'éléments`() = runTest {
    val fakeRepository = FakeItemRepository().apply { emit(testItems) }
    val viewModel = ItemListViewModel(GetItemsUseCase(fakeRepository))

    viewModel.state.test {
        assertEquals(ItemListState(), awaitItem())  // initial

        viewModel.onSearch("requête")
        val loading = awaitItem()
        assertTrue(loading.isLoading)

        val loaded = awaitItem()
        assertFalse(loaded.isLoading)
        assertEquals(1, loaded.items.size)
    }
}

Tester avec TestDispatcher

@Test
fun `le chargement parallèle se termine correctement`() = runTest {
    val viewModel = DashboardViewModel(
        itemRepo = FakeItemRepo(),
        statsRepo = FakeStatsRepo()
    )

    viewModel.load()
    advanceUntilIdle()

    val state = viewModel.state.value
    assertNotNull(state.items)
    assertNotNull(state.stats)
}

Simuler des Flux

class FakeItemRepository : ItemRepository {
    private val _items = MutableStateFlow<List<Item>>(emptyList())

    override fun observeItems(): Flow<List<Item>> = _items

    fun emit(items: List<Item>) { _items.value = items }

    override suspend fun getItemsByCategory(category: String): Result<List<Item>> {
        return Result.success(_items.value.filter { it.category == category })
    }
}

Anti-patrons à éviter

• Utiliser GlobalScope — fuit les coroutines, pas d'annulation structurée
• Collecter des Flow dans init {} sans scope — utilisez viewModelScope.launch
• Utiliser MutableStateFlow avec des collections mutables — utilisez toujours des copies immutables : _state.update { it.copy(list = it.list + newItem) }
• Attraper CancellationException — laissez-la se propager pour une annulation correcte
• Utiliser flowOn(Dispatchers.Main) pour la collecte — le dispatcher de collecte est celui de l'appelant
• Créer Flow dans @Composable sans remember — recrée le flux à chaque recomposition

Références

Voir la skill : compose-multiplatform-patterns pour la consommation des Flow dans l'interface utilisateur. Voir la skill : android-clean-architecture pour savoir où placer les coroutines dans les couches.