Kotlin Concurrency Expert

Overview

Android コードベースの Kotlin Coroutines の問題をレビューおよび修正します。構造化並行処理、ライフサイクル安全性、適切なスコープ指定、および最小限の動作変更で最新のベストプラクティスを適用します。

Workflow

1. 問題の分類

• 正確なエラー、クラッシュ、または症状 (ANR、メモリリーク、競合状態、不正な状態) をキャプチャします。
• プロジェクトの coroutines セットアップを確認: kotlinx-coroutines-android バージョン、lifecycle-runtime-ktx バージョン。
• 現在のスコープコンテキストを識別します (viewModelScope、lifecycleScope、カスタムスコープ、またはなし)。
• コードが UI にバインドされている (Dispatchers.Main) か、メインスレッド以外で実行される想定 (Dispatchers.IO、Dispatchers.Default) かを確認します。
• テスト可能性のための Dispatcher 注入パターンを検証します。

2. 最小限の安全な修正を適用

既存の動作を保持しながら、構造化並行処理とライフサイクル安全性を満たす編集を優先します。

一般的な修正:

• ANR / メインスレッドのブロッキング: 重い処理を withContext(Dispatchers.IO) または Dispatchers.Default に移動; suspend 関数がメインセーフであることを確認します。
• メモリリーク / ゾンビ coroutines: GlobalScope をライフサイクルにバインドされたスコープ (viewModelScope、lifecycleScope、または注入された applicationScope) に置き換えます。
• ライフサイクルコレクションの問題: 非推奨の launchWhenStarted を repeatOnLifecycle(Lifecycle.State.STARTED) に置き換えます。
• 状態の露出: MutableStateFlow / MutableSharedFlow をカプセル化; 読み取り専用の StateFlow または Flow を露出します。
• CancellationException の飲み込み: 汎用 catch (e: Exception) ブロックが CancellationException を再スロー することを確認します。
• 非協調的なキャンセレーション: ループ内で ensureActive() または yield() を追加して協調的キャンセレーションを実現します。
• コールバック API: リスナーを callbackFlow で変換し、適切な awaitClose クリーンアップを行います。
• ハードコードされた Dispatchers: テスト可能性のために CoroutineDispatcher をコンストラクタ経由で注入します。

Critical Rules

Dispatcher 注入 (テスト可能性)

// CORRECT: Dispatcher を注入
class UserRepository(
    private val ioDispatcher: CoroutineDispatcher = Dispatchers.IO
) {
    suspend fun fetchUser() = withContext(ioDispatcher) { ... }
}

// INCORRECT: ハードコードされた Dispatcher
class UserRepository {
    suspend fun fetchUser() = withContext(Dispatchers.IO) { ... }
}

ライフサイクル対応コレクション

// CORRECT: repeatOnLifecycle を使用
viewLifecycleOwner.lifecycleScope.launch {
    viewLifecycleOwner.repeatOnLifecycle(Lifecycle.State.STARTED) {
        viewModel.uiState.collect { state -> updateUI(state) }
    }
}

// INCORRECT: 直接コレクション (危険、非推奨)
lifecycleScope.launchWhenStarted {
    viewModel.uiState.collect { state -> updateUI(state) }
}

状態のカプセル化

// CORRECT: 読み取り専用 StateFlow を露出
class MyViewModel : ViewModel() {
    private val _uiState = MutableStateFlow(UiState())
    val uiState: StateFlow<UiState> = _uiState.asStateFlow()
}

// INCORRECT: ミュータブル状態が露出
class MyViewModel : ViewModel() {
    val uiState = MutableStateFlow(UiState()) // ミュータビリティが漏洩
}

例外処理

// CORRECT: CancellationException を再スロー
try {
    doSuspendWork()
} catch (e: CancellationException) {
    throw e // 必ず再スロー!
} catch (e: Exception) {
    handleError(e)
}

// INCORRECT: キャンセレーションを飲み込み
try {
    doSuspendWork()
} catch (e: Exception) {
    handleError(e) // CancellationException が飲み込まれる!
}

協調的キャンセレーション

// CORRECT: ループ内でキャンセレーションをチェック
suspend fun processLargeList(items: List<Item>) {
    items.forEach { item ->
        ensureActive() // キャンセレーションをチェック
        processItem(item)
    }
}

// INCORRECT: 非協調的 (キャンセレーションを無視)
suspend fun processLargeList(items: List<Item>) {
    items.forEach { item ->
        processItem(item) // キャンセレーションをチェックしない
    }
}

コールバック変換

// CORRECT: callbackFlow と awaitClose
fun locationUpdates(): Flow<Location> = callbackFlow {
    val listener = LocationListener { location ->
        trySend(location)
    }
    locationManager.requestLocationUpdates(listener)
    
    awaitClose { locationManager.removeUpdates(listener) }
}

スコープガイドライン

スコープ	使用場面	ライフサイクル
viewModelScope	ViewModel 操作	ViewModel とともにクリア
lifecycleScope	Activity/Fragment での UI 操作	ライフサイクル所有者とともに破棄
repeatOnLifecycle	UI での Flow コレクション	ライフサイクル状態の開始/停止に応じて
applicationScope (注入)	アプリ全体のバックグラウンド処理	アプリケーション存続期間
GlobalScope	決して使用しない	構造化並行処理を破壊

テストパターン

@Test
fun `loading data updates state`() = runTest {
    val testDispatcher = StandardTestDispatcher(testScheduler)
    val repository = FakeRepository()
    val viewModel = MyViewModel(repository, testDispatcher)
    
    viewModel.loadData()
    advanceUntilIdle()
    
    assertEquals(UiState.Success(data), viewModel.uiState.value)
}

参考資料

• Kotlin Coroutines Best Practices
• StateFlow and SharedFlow
• repeatOnLifecycle API