Communitygithub.com

Kotlin 協程與 Flow

Android 與 KMP 專案中 Kotlin 協程與 Flow 的慣用模式 — 結構化併發、Flow 運算子、StateFlow、錯誤處理與測試。在 Android 或 KMP 上撰寫協程或 Flow 程式碼,或除錯取消與並行時使用。

Kotlin 協程與 Flow 是什麼?

此技能為 Android 與 Kotlin Multiplatform (KMP) 專案提供一套全面的 Kotlin 協程與 Flow 使用模式。它涵蓋結構化併發與範圍階層、Flow 運算子與轉換、以及使用 StateFlow 與 SharedFlow 的狀態與一次性事件管理。技能也包含有關調度器 (Dispatchers) 的詳細內容,包括跨平台考量,以及合作式取消與 try/finally 區塊的正確清理。針對測試,它提供使用 Turbine 測試 StateFlow 與 TestDispatcher 的實例,並指出應避免的反模式。此技能對於任何在 Android 或 KMP 中撰寫非同步 Kotlin 程式碼的開發者都很有價值,有助於編寫更安全、更易於維護的協程與 Flow 程式碼。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/affaan-m/ECC/tree/main/skills/kotlin-coroutines-flows

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

Kotlin 協程與 Flow 是做什麼的?

在 Android 與 Kotlin Multiplatform 專案中,結構化併發、基於 Flow 的反應式串流以及協程測試的模式。

何時啟用

  • 使用 Kotlin 協程撰寫非同步程式碼
  • 使用 Flow、StateFlow 或 SharedFlow 處理反應式資料
  • 處理並行操作(平行載入、防抖、重試)
  • 測試協程與 Flow
  • 管理協程範圍與取消

結構化併發

範圍階層

Application
  └── viewModelScope (ViewModel)
        └── coroutineScope { } (結構化子項)
              ├── async { } (並行任務)
              └── async { } (並行任務)

永遠使用結構化併發 — 不要使用 GlobalScope:

// 不好
GlobalScope.launch { fetchData() }

// 好 — 範圍綁定 ViewModel 生命週期
viewModelScope.launch { fetchData() }

// 好 — 範圍綁定 Composable 生命週期
LaunchedEffect(key) { fetchData() }

平行分解

使用 coroutineScope + async 進行平行工作:

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

當子協程失敗不應取消兄弟協程時,使用 supervisorScope:

suspend fun syncAll() = supervisorScope {
    launch { syncItems() }       // 此處失敗不會取消 syncStats
    launch { syncStats() }
    launch { syncSettings() }
}

Flow 模式

冷 Flow — 一次性到串流轉換

fun observeItems(): Flow<List<Item>> = flow {
    // 每當資料庫變更時重新發射
    itemDao.observeAll()
        .map { entities -> entities.map { it.toDomain() } }
        .collect { emit(it) }
}

用於 UI 狀態的 StateFlow

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

WhileSubscribed(5_000) 在最後一個訂閱者離開後,會保持上游活躍 5 秒 — 可在不重新啟動的情況下度過配置變更。

結合多個 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())

Flow 運算子

// 防抖搜尋輸入
searchQuery
    .debounce(300)
    .distinctUntilChanged()
    .flatMapLatest { query -> repository.search(query) }
    .catch { emit(emptyList()) }
    .collect { results -> _state.update { it.copy(results = results) } }

// 使用指數退避重試
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

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("已刪除項目"))
        }
    }
}

// 在 Composable 中收集
LaunchedEffect(Unit) {
    viewModel.effects.collect { effect ->
        when (effect) {
            is Effect.ShowSnackbar -> snackbarHostState.showSnackbar(effect.message)
            is Effect.NavigateTo -> navController.navigate(effect.route)
        }
    }
}

調度器

// CPU 密集型工作
withContext(Dispatchers.Default) { parseJson(largePayload) }

// IO 密集型工作
withContext(Dispatchers.IO) { database.query() }

// 主執行緒 (UI) — 在 viewModelScope 中為預設
withContext(Dispatchers.Main) { updateUi() }

在 KMP 中,使用 Dispatchers.Default 和 Dispatchers.Main(所有平台皆可用)。Dispatchers.IO 僅限 JVM/Android — 在其他平台上請使用 Dispatchers.Default 或透過 DI 提供。

取消

合作式取消

長時間運行的迴圈必須檢查取消狀態:

suspend fun processItems(items: List<Item>) = coroutineScope {
    for (item in items) {
        ensureActive()  // 若已取消則擲回 CancellationException
        process(item)
    }
}

使用 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) }  // 即使取消也一定會執行
    }
}

測試

使用 Turbine 測試 StateFlow

@Test
fun `搜尋更新項目列表`() = runTest {
    val fakeRepository = FakeItemRepository().apply { emit(testItems) }
    val viewModel = ItemListViewModel(GetItemsUseCase(fakeRepository))

    viewModel.state.test {
        assertEquals(ItemListState(), awaitItem())  // 初始狀態

        viewModel.onSearch("查詢")
        val loading = awaitItem()
        assertTrue(loading.isLoading)

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

使用 TestDispatcher 測試

@Test
fun `平行載入正確完成`() = runTest {
    val viewModel = DashboardViewModel(
        itemRepo = FakeItemRepo(),
        statsRepo = FakeStatsRepo()
    )

    viewModel.load()
    advanceUntilIdle()

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

偽造 Flow

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

應避免的反模式

  • 使用 GlobalScope — 會洩漏協程,沒有結構化取消
  • 在沒有範圍的 init {} 中收集 Flow — 應使用 viewModelScope.launch
  • 使用可變集合的 MutableStateFlow — 永遠使用不可變複本:_state.update { it.copy(list = it.list + newItem) }
  • 捕獲 CancellationException — 讓它傳播以實現正確的取消
  • 使用 flowOn(Dispatchers.Main) 收集 — 收集的調度器是呼叫者的調度器
  • 在 @Composable 中不使用 remember 建立 Flow — 每次重組都會重新建立 flow

參考資料

參閱技能:compose-multiplatform-patterns 以了解 Flow 的 UI 消費。 參閱技能:android-clean-architecture 以了解協程在各層中的定位。

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

accessibility

Design, implement, and audit inclusive digital products using WCAG 2.2 Level AA. Use when building or auditing UI that must meet WCAG 2.2 Level AA, or when reviewing a change for keyboard, contrast, or screen-reader support.

affaan-m/content-engine

Create platform-native content systems for X, LinkedIn, TikTok, YouTube, newsletters, and repurposed multi-platform campaigns. Use when the user wants social posts, threads, scripts, content calendars, or one source asset adapted cleanly across platforms.

affaan-m/ECC

Multi-platform content distribution across X, LinkedIn, Threads, and Bluesky. Adapts content per platform using content-engine patterns. Never posts identical content cross-platform. Use when the user wants to distribute content across social platforms.

affaan-m/fal-ai-media

Unified media generation via fal.ai MCP — image, video, and audio. Covers text-to-image (Nano Banana), text/image-to-video (Seedance, Kling, Veo 3), text-to-speech (CSM-1B), and video-to-audio (ThinkSound). Use when the user wants to generate images, videos, or audio with AI.

affaan-m/manim-video

日本語翻訳:このファイルは manim-video 用の日本語翻訳が必要です

affaan-m/remotion-video-creation

Remotion のベストプラクティス - React で動画を作成する。3D、アニメーション、音声、字幕、チャート、トランジションなどをカバーするドメイン固有の29のルール。

affaan-m/video-editing

AI-assisted video editing workflows for cutting, structuring, and augmenting real footage. Covers the full pipeline from raw capture through FFmpeg, Remotion, ElevenLabs, fal.ai, and final polish in Descript or CapCut. Use when the user wants to edit video, cut footage, create vlogs, or build video content.

agent-architecture-audit

Full-stack diagnostic for agent and LLM applications. Audits the 12-layer agent stack for wrapper regression, memory pollution, tool discipline failures, hidden repair loops, and rendering corruption. Produces severity-ranked findings with code-first fixes. Essential for developers building agent applications, autonomous loops, or any LLM-powered feature. Use when an agent or LLM feature misbehaves and the failing layer is unknown, or before shipping an agent stack.

agent-eval

Head-to-head comparison of coding agents (Claude Code, Aider, Codex, etc.) on custom tasks with pass rate, cost, time, and consistency metrics. Use when choosing between coding agents, or when a change to an agent setup needs measured pass rate, cost, and time rather than an impression.

agent-harness-construction

Design and optimize AI agent action spaces, tool definitions, and observation formatting for higher completion rates. Use when defining or revising an agent

agentic-engineering

Operate as an agentic engineer using eval-first execution, decomposition, and cost-aware model routing. Use when planning or executing engineering work that agents will carry out end to end.

agentic-os

Build persistent multi-agent operating systems on Claude Code. Covers kernel architecture, specialist agents, slash commands, file-based memory, scheduled automation, and state management without external databases. Use when building a persistent multi-agent system on Claude Code with its own memory, commands, and scheduling.

agent-introspection-debugging

Structured self-debugging workflow for AI agent failures using capture, diagnosis, contained recovery, and introspection reports. Use when an agent run fails and you need a reproducible diagnosis instead of a retry.

agent-payment-x402

Add x402 payment execution to AI agents with per-task budgets, spending controls, and non-custodial wallets. Supports Base through agentwallet-sdk and X Layer through OKX Payments / OKX Agent Payments Protocol. Use when an agent must pay for something itself and needs per-task budgets, spending controls, and a non-custodial wallet.

agent-self-evaluation

Use after completing any non-trivial task. The agent self-rates its output on 5 axes — accuracy, completeness, clarity, actionability, conciseness — with concrete evidence per criterion. Produces a structured 1-5 scorecard with specific improvement suggestions.

agent-sort

Build an evidence-backed ECC install plan for a specific repo by sorting skills, commands, rules, hooks, and extras into DAILY vs LIBRARY buckets using parallel repo-aware review passes. Use when ECC should be trimmed to what a project actually needs instead of loading the full bundle.

ai-first-engineering

Engineering operating model for teams where AI agents generate a large share of implementation output. Use when setting team process, review gates, or ownership rules for a codebase largely written by agents.

ai-regression-testing

Regression testing strategies for AI-assisted development. Sandbox-mode API testing without database dependencies, automated bug-check workflows, and patterns to catch AI blind spots where the same model writes and reviews code. Use when adding regression coverage to AI-assisted code, or when the same model both wrote and reviewed a change.

android-clean-architecture

Clean Architecture patterns for Android and Kotlin Multiplatform projects — module structure, dependency rules, UseCases, Repositories, and data layer patterns. Use when structuring modules, layers, or data flow in an Android or KMP project.

angular-developer

Generates Angular code and provides architectural guidance. Trigger when creating projects, components, or services, or for best practices on reactivity (signals, linkedSignal, resource), forms, dependency injection, routing, SSR, accessibility (ARIA), animations, styling (component styles, Tailwind CSS), testing, or CLI tooling.

相關技能