IntelliJ IDEA를 사용하여 Kotlin Flow 디버깅하기 – 튜토리얼

이 튜토리얼에서는 Kotlin Flow를 생성하고 IntelliJ IDEA를 사용하여 디버깅하는 방법을 설명합니다.

이 튜토리얼은 코루틴(coroutines) 및 Kotlin Flow 개념에 대한 사전 지식이 있다고 가정합니다.

Kotlin Flow 생성하기

느린 emitter(방출기)와 느린 collector(수집기)를 가진 Kotlin flow를 생성합니다.

1. IntelliJ IDEA에서 Kotlin 프로젝트를 엽니다. 프로젝트가 없다면 새로 생성하세요.

2. Gradle 프로젝트에서 kotlinx.coroutines 라이브러리를 사용하려면 build.gradle(.kts)에 다음 의존성을 추가하세요.

   KotlinGroovy

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

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

   다른 빌드 시스템의 경우 kotlinx.coroutines README의 지침을 참조하세요.

3. src/main/kotlin에 있는 Main.kt 파일을 엽니다.

   src 디렉터리는 Kotlin 소스 파일과 리소스를 포함합니다. Main.kt 파일에는 Hello World!를 출력하는 샘플 코드가 포함되어 있습니다.

4. 세 개의 숫자로 구성된 flow를 반환하는 simple() 함수를 생성합니다.

   • delay() 함수를 사용하여 CPU를 소모하는 블로킹(blocking) 코드를 흉내 냅니다. 이 함수는 스레드를 차단하지 않고 100ms 동안 코루틴을 일시 중단(suspend)합니다.
   • 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() 함수를 사용하여 CPU를 소모하는 코드를 흉내 냅니다. 이 함수는 스레드를 차단하지 않고 300ms 동안 코루틴을 일시 중단합니다.
   • println() 함수를 사용하여 flow에서 수집된 값을 출력합니다.

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

6. Build Project를 클릭하여 코드를 빌드합니다.

   

코루틴 디버깅하기

1. emit() 함수가 호출되는 라인에 중단점(breakpoint)을 설정합니다.

   

2. 화면 상단의 실행 구성 옆에 있는 Debug를 클릭하여 디버그 모드로 코드를 실행합니다.

   

   Debug 도구 창이 나타납니다:

   • Frames 탭에는 호출 스택(call stack)이 포함되어 있습니다.
   • Variables 탭에는 현재 컨텍스트의 변수들이 포함되어 있습니다. 여기서는 flow가 첫 번째 값을 방출하고 있음을 보여줍니다.
   • Coroutines 탭에는 실행 중이거나 일시 중단된 코루틴에 대한 정보가 포함되어 있습니다.

   

3. Debug 도구 창에서 Resume Program을 클릭하여 디버거 세션을 재개합니다. 프로그램이 동일한 중단점에서 멈춥니다.

   

   이제 flow가 두 번째 값을 방출합니다.

   

최적화되어 제거된 변수 (Optimized-out variables)

suspend 함수를 사용하는 경우, 디버거에서 변수 이름 옆에 "was optimized out"이라는 텍스트가 표시될 수 있습니다.

이 텍스트는 변수의 수명이 단축되어 해당 변수가 더 이상 존재하지 않음을 의미합니다. 최적화된 변수는 값을 볼 수 없기 때문에 코드를 디버깅하기 어렵습니다. -Xdebug 컴파일러 옵션을 사용하여 이 동작을 비활성화할 수 있습니다.

이 플래그를 프로덕션에서 절대로 사용하지 마세요: -Xdebug는 메모리 누수를 유발할 수 있습니다.

동시 실행 코루틴 추가하기

1. src/main/kotlin에 있는 Main.kt 파일을 엽니다.

2. emitter와 collector가 동시에 실행되도록 코드를 개선합니다.

   • buffer() 함수 호출을 추가하여 emitter와 collector를 동시에 실행합니다. buffer()는 방출된 값을 저장하고 flow collector를 별도의 코루틴에서 실행합니다.

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

3. Build Project를 클릭하여 코드를 빌드합니다.

두 개의 코루틴이 있는 Kotlin Flow 디버깅하기

1. println(value)에 새로운 중단점을 설정합니다.

2. 화면 상단의 실행 구성 옆에 있는 Debug를 클릭하여 디버그 모드로 코드를 실행합니다.

   

   Debug 도구 창이 나타납니다.

   Coroutines 탭에서 두 개의 코루틴이 동시에 실행되고 있음을 확인할 수 있습니다. buffer() 함수로 인해 flow collector와 emitter가 별도의 코루틴에서 실행됩니다. buffer() 함수는 flow에서 방출된 값을 버퍼링합니다. emitter 코루틴은 RUNNING 상태이고, collector 코루틴은 SUSPENDED 상태입니다.

3. Debug 도구 창에서 Resume Program을 클릭하여 디버거 세션을 재개합니다.

   

   이제 collector 코루틴이 RUNNING 상태가 되고, emitter 코루틴은 SUSPENDED 상태가 됩니다.

   각 코루틴을 더 자세히 살펴보며 코드를 디버깅할 수 있습니다.