第3章：泄漏数据采集工具——自定义DumpService、协程调试API、Flow生命周期回调注入

3.1 现象识别：何时需要启动数据采集？

Flow订阅泄漏通常在以下现象出现时触发采集流程：

• 内存快照异常：LeakCanary 报告 Flow 相关实例（如 FlowCollector、SafeCollector）泄漏。
• 协程泄漏：CoroutineExceptionHandler 捕获 JobCancellationException 以外的异常，或 dumpCoroutines 显示未取消的协程持有外部引用。
• 性能退化：反复出现 OutOfMemoryError，且堆栈中多次出现 AbstractFlow.collect。

使用以下判断规则快速决策是否执行本章的数据采集工具：

3.2 数据采集工具一：自定义 DumpService

通过继承 DumpService 注册 Flow 状态快照命令，用于离线分析。

实现步骤：

1. 创建 FlowDumpService 类，重写 onDump 方法
2. 在 AndroidManifest.xml 中声明可调试状态
3. 通过 adb shell dumpsys flow 触发采集

// FlowDumpService.kt
class FlowDumpService : DumpService("flow") {
    override fun onDump(args: Array<out String>?, fd: FileDescriptor) {
        val writer = PrintWriter(fd.outputStream())
        // 获取全局 Flow 注册表
        val flowRegistry = FlowTracker.registry
        synchronized(flowRegistry) {
            for ((id, entry) in flowRegistry) {
                writer.println("Flow[$id]")
                writer.println("  collector: ${entry.collector?.javaClass?.name}")
                writer.println("  scope: ${entry.scope.isActive}")
                writer.println("  refs: ${entry.references?.joinToString(", ")}")
                writer.println("---")
            }
        }
        writer.flush()
    }
}

// AndroidManifest.xml 片段
<service android:name=".debug.FlowDumpService"
    android:exported="true"
    android:permission="android.permission.DUMP" />

触发命令：

adb shell dumpsys flow
# 输出示例
Flow[0x7f8e]
  collector: com.example.InfiniteCollector
  scope: false
  refs: Activity@0x1234, ViewModel@0x5678
---

采集结果中 refs 列表表示 Flow 未被释放的引用路径，可用于后续原因定位。

3.3 数据采集工具二：协程调试 API

利用 kotlinx.coroutines.debug 包中的 DebugProbes 和 dumpCoroutinesInfo 函数，实时捕获所有协程状态。

初始化（在 Application.onCreate 中）：

DebugProbes.install()  // 开启协程调试仪表
// 注意：发布版本需卸载
// DebugProbes.uninstall()

采集快照：

fun captureCoroutineSnapshot() {
    val info = DebugProbes.dumpCoroutinesInfo()
    info.forEach { coroutineInfo ->
        Log.d("CoroutineDump", """
            Job: ${coroutineInfo.job}
            State: ${coroutineInfo.state}
            IsCompleted: ${coroutineInfo.isCompleted}
            Context: ${coroutineInfo.context}
            Stacktrace:
            ${coroutineInfo.creationStackTrace?.joinToString("\n")}
        """.trimIndent())
    }
}

判断规则： 如果某个协程的 state 为 SUSPENDED 且 isCompleted 为 false，同时其 context 中包含 Job 的父级已被取消，则该协程可能泄漏。

3.4 数据采集工具三：Flow 生命周期回调注入

利用 Flow 的操作符 onStart、onCompletion、onEach 注入跟踪逻辑，记录每个集合的创建与销毁。

通用跟踪包装：

fun <T> Flow<T>.tracked(name: String): Flow<T> {
    val registry = FlowTracker.registry
    val id = System.identityHashCode(this)
    return this
        .onStart {
            registry[id] = FlowEntry(
                collector = collect.invoke()?.javaClass,
                scope = currentCoroutineContext()[Job] ?: SupervisorJob(),
                references = emptyList()
            )
            Log.d("FlowTracker", "[$name] Flow started, id=$id")
        }
        .onCompletion { cause ->
            registry.remove(id)
            if (cause != null) {
                Log.w("FlowTracker", "[$name] Flow completed with exception: $cause")
            } else {
                Log.d("FlowTracker", "[$name] Flow completed normally")
            }
        }
        .onEach { value ->
            // 可在此记录活跃的引用路径
            val currentRefs = Thread.currentThread().stackTrace
                .take(3)
                .map { it.className + "." + it.methodName }
            registry[id]?.references = currentRefs
        }
}

使用示例：

class MyViewModel : ViewModel() {
    val dataFlow: Flow<Data> = repository.observe()
        .tracked("MyViewModel-data")  // 注入生命周期跟踪
        .catch { emit(Data.Default) }
        .flowOn(Dispatchers.IO)
}

采集结果通过 FlowTracker.registry 实时查询，或与 DumpService 集成输出。

3.5 数据采集流程总览

下图展示三种工具的协同采集策略：

3.6 原因定位：基于采集数据诊断泄漏

采集到数据后，使用以下排查表快速定位：

3.7 修复动作：对症下药

• DumpService 报告引用链指向未关闭的 lifecycleScope：在 onDestroy 中调用 lifecycleScope.cancel()。
• 协程调试API 显示悬挂协程：检查 launch 是否未绑定 CoroutineScope，改用 viewModelScope 或 lifecycleScope。
• Flow 生命周期注入显示未完成：确保 Flow 链末端有 .catch 或 .onCompletion 处理异常，避免意外中断导致不执行回调。

标准修复模板：

// 修复前
fun observeData() {
    viewModelScope.launch {
        repository.flow.collect { /* 处理 */ }
    }
}

// 修复后
fun observeData() {
    viewModelScope.launch {
        repository.flow
            .catch { e -> Log.e("Flow", "Error in collection", e) }
            .collect { /* 处理 */ }
    }
}
// 确保 repository.flow 使用 flowOn(Dispatchers.Default) 避免线程泄漏

3.8 复测：验证修复有效性

执行相同的采集步骤，确认以下指标归零：

• DumpService 输出中不再有 scope: false 且 refs 非空的条目。
• 协程调试API 快照中所有协程均为 isCompleted=true 或在合理时间内完成。
• Flow 生命周期注入的 registry 在界面销毁后立即清空。

建议编写自动化复测脚本，集成到 CI 管道：

# 自动化复测命令示例
adb shell am instrument -w -e class com.example.FlowLeakTest com.example.debug.test/androidx.test.runner.AndroidJUnitRunner
adb shell dumpsys flow > /tmp/post_fix_flow_dump.txt
grep -c "scope: false" /tmp/post_fix_flow_dump.txt  # 预期结果为 0

3.9 预防：建设持续监测体系

将数据采集工具嵌入开发流程：

• 在 debug 构建中自动启用 DebugProbes 和 FlowTracker，并周期记录（每 30 秒一次快照）。
• 创建自定义 LeakAssertionRule，在功能测试结束时断言无残留 Flow 或协程。
• 使用 strictMode 的 onCoroutineLeakListener（需 Kotlin 1.9+）自动上报。