如何避免忘记收集带有副作用的Kotlin Flow？

我开发的应用中使用了带有副作用但有时不返回值的Flow，常犯的错误是忘记收集该Flow，导致副作用无法触发。示例代码如下：

import kotlinx.coroutines.flow.flow

fun createFlowWithSideEffects() = flow<Unit> {
    println("Side-effect")
}

fun main() {
    createFlowWithSideEffects()
    // 因为Flow从未被收集，所以副作用永远不会执行
}

一、避免此类问题的编码模式 #

• 明确命名标记：给仅含副作用的Flow命名时添加launch或effect前缀，比如launchLoggingEffect()，通过命名直接提醒调用者这是需要触发执行的操作，而非普通数据流。
• 封装收集逻辑：不直接暴露原始Flow，而是在函数内部封装收集逻辑，提供挂起函数或返回Job的函数。示例：

fun launchSideEffect(): Job = CoroutineScope(Dispatchers.Default).launch {
    flow<Unit> {
        println("Side-effect")
    }.collect()
}

调用时直接执行launchSideEffect()，无需手动收集，从根源避免遗漏。

• 热流处理规范：如果使用SharedFlow/StateFlow这类热流，确保创建时就配置好订阅逻辑，或添加明确注释提醒调用者必须订阅。

二、可预警未收集Flow的Linter工具 #

• Detekt：Kotlin生态常用的静态代码分析工具，支持自定义规则。可以编写规则检测返回Flow<Unit>或带有副作用标记的Flow被调用后未执行收集操作的情况，编译阶段给出警告。
• Ktlint：默认规则无此检测，但可通过自定义规则扩展，实现类似Detekt的检测逻辑，在代码检查阶段提醒开发者。
• Android Lint（Android项目专属）：针对Android应用，可自定义Lint规则，扫描代码中调用Flow创建函数但未调用collect()、launchIn()等收集方法的场景，给出错误或警告提示。

内容的提问来源于stack exchange，提问作者David Hadley