Отладка Kotlin Flow с помощью IntelliJ IDEA – учебное пособие

Создание Kotlin flow

Создайте Kotlin flow с медленным эмиттером и медленным коллектором:

1. Откройте Kotlin-проект в IntelliJ IDEA. Если у вас нет проекта, создайте его.

2. Чтобы использовать библиотеку kotlinx.coroutines в проекте Gradle, добавьте следующую зависимость в build.gradle(.kts):

   dependencies {
       implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4")
   }
   

   dependencies {
       implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4'
   }
   

   Для других систем сборки см. инструкции в kotlinx.coroutines README.

3. Откройте файл Main.kt в src/main/kotlin.

   Папка src содержит Kotlin-исходные файлы и ресурсы. Файл Main.kt содержит пример кода, который будет выводить Hello World!.

4. Создайте функцию simple(), которая возвращает поток из трёх чисел:

   • Используйте функцию delay(), чтобы имитировать ресурсоёмкий код блокировки ЦП. Она приостанавливает корутину на 100 мс без блокировки потока.

   • Произведите значения в цикле for с помощью функции emit().

   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() для обертывания корутины.

   • Соберите изменённые значения с помощью функции collect().

   • Используйте функцию delay() для имитации ресурсоёмкого кода. Она приостанавливает корутину на 300 мс без блокировки потока.

   • Выведите собранное значение из потока с помощью функции println().

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

6. Соберите код, нажав Собрать проект.

   

Отладка корутины

1. Установите точку останова в строке, где вызывается функция emit():

   

2. Запустите код в режиме отладки, нажав Отладка рядом с конфигурацией запуска в верхней части экрана.

   

   Открывается окно инструментов Отладка:

   • Вкладка Фреймы содержит стек вызовов.

   • Вкладка Переменные содержит переменные в текущем контексте. Она показывает, что поток выдает первое значение.

   • Вкладка Корутины содержит информацию о работающих или приостановленных корутинах.

   

3. Возобновите сеанс отладки, нажав Возобновить программу в окне инструментов Отладка. Программа остановится на той же точке останова.

   

   Теперь поток выдает второе значение.

   

Оптимизированные переменные

Если вы используете suspend функции, в отладчике рядом с именем переменной может отображаться текст «была оптимизирована»:

Это означает, что срок жизни переменной был уменьшен, и переменная больше не существует. Отладка кода с оптимизированными переменными затруднена, поскольку вы не видите их значения. Вы можете отключить это поведение с помощью опции компилятора -Xdebug.

Добавление одновременно выполняющейся корутины

1. Откройте файл Main.kt в src/main/kotlin.

2. Улучшите код для одновременного выполнения эмиттера и коллектора:

   • Добавьте вызов функции buffer() для одновременного выполнения эмиттера и коллектора. buffer() сохраняет изменённые значения и запускает коллектор потока в отдельной корутине.

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

3. Соберите код, нажав Собрать проект.

Отладка Kotlin flow с двумя корутинами

1. Установите новую точку останова в println(value).

2. Запустите код в режиме отладки, нажав Отладка рядом с конфигурацией запуска в верхней части экрана.

   

   Открывается окно инструментов Отладка.

   На вкладке Корутины вы можете увидеть, что две корутины выполняются одновременно. Коллектор и эмиттер потока выполняются в отдельных корутинах из-за функции buffer() . Функция buffer() буферизует испускаемые значения из потока. Корутина эмиттера имеет статус ВЫПОЛНЯЕТСЯ, а корутина коллектора имеет статус ПРИОСТАНОВЛЕНА.

3. Возобновите сеанс отладки, нажав Возобновить программу в окне инструментов Отладка.

   

   Теперь корутина коллектора имеет статус ВЫПОЛНЯЕТСЯ, а корутина эмиттера имеет статус ПРИОСТАНОВЛЕНА.

   Вы можете углубиться в каждую корутину для отладки вашего кода.