使用 IntelliJ IDEA 调试 Kotlin Flow – 教程

本教程演示了如何创建 Kotlin Flow 并使用 IntelliJ IDEA 调试它。

本教程假定您已了解协程和Kotlin Flow概念。

创建 Kotlin Flow

创建一个具有慢速发送器和慢速收集器的 Kotlin Flow：

1. 在 IntelliJ IDEA 中打开一个 Kotlin 项目。如果您没有项目，请创建一个。

2. 要在 Gradle 项目中使用 kotlinx.coroutines 库，请将以下依赖项添加到 build.gradle(.kts)：

    dependencies {
        implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2")
    }
    ```
```groovy [Groovy]
    dependencies {
        implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2'
    }
    ```
:::

    对于其他构建系统，请参阅 [`kotlinx.coroutines` README](https://github.com/Kotlin/kotlinx.coroutines#using-in-your-projects) 中的说明。

3.  打开 `src/main/kotlin` 中的 `Main.kt` 文件。

    `src` 目录包含 Kotlin 源文件和资源。`Main.kt` 文件包含将打印 `Hello World!` 的示例代码。

4.  创建 `simple()` 函数，该函数返回一个包含三个数字的 Flow：

    *   使用 [`delay()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/delay.html) 函数模拟 CPU 密集型阻塞代码。它会暂停协程 100 毫秒，而不会阻塞线程。
    *   在 `for` 循环中使用 [`emit()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow-collector/emit.html) 函数生成这些值。

    ```kotlin
    import kotlinx.coroutines.*
    import kotlinx.coroutines.flow.*
    import kotlin.system.*
 
    fun simple(): Flow<Int> = flow {
        for (i in 1..3) {
            delay(100)
            emit(i)
        }
    }
    ```

5.  修改 `main()` 函数中的代码：

    *   使用 [`runBlocking()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/run-blocking.html) 块来包裹协程。
    *   使用 [`collect()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/collect.html) 函数收集发出的值。
    *   使用 [`delay()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/delay.html) 函数模拟 CPU 密集型代码。它会暂停协程 300 毫秒，而不会阻塞线程。
    *   使用 [`println()`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/println.html) 函数打印从 Flow 收集到的值。

    ```kotlin
    fun main() = runBlocking {
        simple()
            .collect { value ->
                delay(300)
                println(value)
            }
    }
    ```

6.  点击 **Build Project** 构建代码。

    ![构建应用程序](flow-build-project.png)

## 调试协程

1.  在调用 `emit()` 函数的行设置断点：

    ![构建控制台应用程序](flow-breakpoint.png)

2.  点击屏幕顶部运行配置旁边的 **Debug**，以调试模式运行代码。

    ![构建控制台应用程序](flow-debug-project.png)

    **Debug** 工具窗口随即出现：
    *   **Frames** 选项卡包含调用堆栈。
    *   **Variables** 选项卡包含当前上下文中的变量。它告诉我们 Flow 正在发出第一个值。
    *   **Coroutines** 选项卡包含正在运行或已暂停的协程信息。

    ![调试协程](flow-debug-1.png)

3.  点击 **Debug** 工具窗口中的 **Resume Program** 恢复调试会话。程序将在同一断点处停止。

    ![调试协程](flow-resume-debug.png)

    现在 Flow 发出了第二个值。

    ![调试协程](flow-debug-2.png)

### 优化掉的变量

如果您使用 `suspend` 函数，在调试器中，您可能会在变量名旁边看到“was optimized out”文本：

![变量“a”已优化掉](variable-optimised-out.png)

此文本表示变量的生命周期已缩短，变量不再存在。
调试包含优化掉的变量的代码很困难，因为您无法看到它们的值。
您可以使用 `-Xdebug` 编译器选项禁用此行为。

::: warning

__切勿在生产环境中使用此标志__：`-Xdebug` [可能导致内存泄漏](https://youtrack.jetbrains.com/issue/KT-48678/Coroutine-debugger-disable-was-optimised-out-compiler-feature#focus=Comments-27-6015585.0-0)。

:::
## 添加并发运行的协程

1.  打开 `src/main/kotlin` 中的 `Main.kt` 文件。

2.  增强代码以并发运行发送器和收集器：

    *   添加对 [`buffer()`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/buffer.html) 函数的调用以并发运行发送器和收集器。`buffer()` 会存储发出的值，并在单独的协程中运行 Flow 收集器。

    ```kotlin
    fun main() = runBlocking<Unit> {
        simple()
            .buffer()
            .collect { value ->
                delay(300)
                println(value)
            }
    }
    ```

3.  点击 **Build Project** 构建代码。

## 调试包含两个协程的 Kotlin Flow

1.  在 `println(value)` 处设置新断点。

2.  点击屏幕顶部运行配置旁边的 **Debug**，以调试模式运行代码。

    ![构建控制台应用程序](flow-debug-3.png)

    **Debug** 工具窗口随即出现。

    在 **Coroutines** 选项卡中，您可以看到有两个协程并发运行。由于 `buffer()` 函数，Flow 收集器和发送器在单独的协程中运行。`buffer()` 函数会缓冲从 Flow 发出的值。发送器协程处于 **RUNNING** 状态，而收集器协程处于 **SUSPENDED** 状态。

3.  点击 **Debug** 工具窗口中的 **Resume Program** 恢复调试会话。

    ![调试协程](flow-debug-4.png)

    现在收集器协程处于 **RUNNING** 状态，而发送器协程处于 **SUSPENDED** 状态。

    您可以深入了解每个协程以调试您的代码。