Spec-Zone.ru › Kotlin 1.7

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

Этот учебник демонстрирует, как создать Kotlin Flow и отладить его с помощью IntelliJ IDEA.

Для работы с учебником предполагается, что у вас есть предварительные знания о корутинах и Kotlin Flow.

Создание 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(), которая возвращает flow из трех чисел:

    • Используйте функцию 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 мс без блокировки потока.

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

    fun main() = runBlocking {
        simple()
            .collect { value ->
                delay(300)
                println(value)
            }
    }
    
  6. Соберите код, нажав Собрать проект.

    Build an application

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

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

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

    Build a console application

    Откроется окно Отладка:

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

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

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

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

    Debug the coroutine

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

    Debug the coroutine

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

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

  2. Улучшите код, чтобы запустить источник и коллектор одновременно:

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

    fun main() = runBlocking<Unit> {
        simple()
            .buffer()
            .collect { value ->
                delay(300)
                println(value)
            }
    }
    
  3. Соберите код, нажав Собрать проект.

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

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

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

    Build a console application

    Откроется окно Отладка.

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

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

    Debugging coroutines

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

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

Последнее изменение: 28 сентября 2022 г.
Отладка корутин с помощью IntelliJ IDEA – учебник Сериализация

© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/docs/debug-flow-with-idea.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API