TIL

4강 코루틴 취소

• 코루틴을 적절히 취소하는 것은 중요
  • 컴퓨터 자원을 아껴야 한다!

코루틴을 취소하는 방법

• launch에 의해 반환되는 job 객체의 cacel을 호출하면 코루틴을 취소할 수 있다.
• 다만 취소 대상인 코루틴도 취소에 협조를 해주어야 한다.

취소에 협조하는 방법1. suspend 함수 호출

• kotlinx.coroutines 패키지의 suspend 함수인 yeild() 또는 delay() 함수를 호출하면 취소에 협조할 수 있다.
• 아래 코드에서 첫 번째 코루틴(job1)은 취소에 협조 했기에 잘 취소되어 job2만 실행되었다.

fun main(): Unit = runBlocking {
  val job1 = launch {
    delay(1_000L)
    printWithThread("Job 1")
  }
  val job2 = launch {
    delay(1_000L)
    printWithThread("Job 2")
  }
  delay(100L) // 첫번째 코루틴 실행을 잠시 기다린다.
  job1.cancel()
}
// 실행 결과
// [main @coroutine#3] Job 2

• main 스레드 제어 흐름은 다음과 같다.
  1. job1 코루틴을 실행하려 하지만 1초 기다려야 해서 job2를 봄
  2. job2 코루틴을 실행하려 하지만 1초 기다려야 해서 넘어감
  3. 그 다음 실행할 코드도 0.1초를 기다려야 하고 실행할 코드가 없어(모두 delay 중) 잠시 대기
  4. 가장 대기 시간이 빠른 0.1초 대기가 끝나고 job1.cancel을 호출
  5. 그다음 대기가 끝난 job1을 실행하려 하지만 취소되었기에 실행하지 않는다.
  6. job2 실행
• 다만 주의할 점은 코루틴이 취소되기 전에 실행될 수도 있다는 점이다.

fun main(): Unit = runBlocking {
  val job = launch {
    delay(10L)
    printWithThread("Job 1")
  }
  delay(100L)
  job.cancel()
}
// 실행 결과
// [main @coroutine#2] Job 1

• main 스레드 제어 흐름
  1. job 코루틴을 실행하려 하지만 0.01초 대기
  2. 그 다음 코드 블럭을 실행하려 하지만 0.1초 대기
  3. 0.01초 대기가 더 빨리 끝나기에 cancel 호출 전에 job 코루틴 실행
• 이처럼 취소에 협조하기 위해서는 yeild나 delay 같은 제어를 넘기는 suspend 함수 호출이 필수적이다.
  • 제어를 넘기지 않으면 cancel 코드가 존재해도 cancel 코드에 도달하지 못한채 코루틴이 전부 실행되고 만다.

취소에 협조하는 방법2. isActive로 직접 상태를 확인해 CancellationException을 던지기

• isActive
  • 코루틴 블럭 내부에선 isActive 프로퍼티에 접근할 수 있다.
  • 현재 코루틴이 활성화되어 있는지 취소 신호를 받았는지 구분할 수 있다.
• Dispatchers.Default
  • 취소 신호를 전달하기 위해선 코루틴이 다른 스레드에서 실행되어야 한다.
  • Dispatchers.Default을 launch와 함께 사용하면 코루틴을 다른 스레드에서 실행시킬 수 있다.

fun main(): Unit = runBlocking {
  val job = launch(Dispatchers.Default) {
    var i = 1
    var nextPrintTime = System.currentTimeMillis() // 현재 시각
    while (i <= 5) { // 5번 반복
      if (nextPrintTime <= System.currentTimeMillis()) {
        printWithThread("${i++}번째 출력")
        nextPrintTime += 1_000L // 1초 후에 다시 출력되도록
        
      if (!isActive) { //
        throw CancellationException()
      }
    }
  }
  delay(100L)
  printWithThread("취소 시작")
  job.cancel()
}

// 실행 결과
// [DefaultDispatcher-worker-1 @coroutine#2] 1        !
// [main @coroutine#1] 취소 시작
  

• 코루틴 코드가 다른 스레드에서 실행된 것을 확인할 수 있다.
  • 한 번 출력하고 1초가 지나야 다른 출력을 할 수 있는데 0.1초 대기가 끝난 main 스레드가 cancel를 호출해버린 것

• Dispatchers.Default가 없었다면 main 스레드가 while을 돌면서 제어를 점유하고 있기 때문에 취소가 동작하지 않았을 것이다.

• delay() 같은 함수도 취소를 감지하면 CancellationException을 던지며 코루틴을 종료하게 된다.
  • 때문에 이 예외를 catch로 무시하면 코루틴은 취소되지 않는다.

fun main(): Unit = runBlocking {
  val job = launch {
    try {
      delay(1_000L)
    } catch (e: CancellationException) { // 예외 무시
    }
    printWithThread("delay에 의해 취소되지 않음")
  }
  
  delay(100L)
  printWithThread("취소 시작")
  job.cancel()
}

// 실행 결과
// [main @coroutine#1] 취소 시작
// [main @coroutine#2] delay에 의해 취소되지 않음