Kotlin 코루틴(Coroutines)의 Cancellation과 Timeouts

새차원님의 코틀린 코루틴 강의를 듣고 정리한 내용입니다

1. Cancellation and Timeouts

1. Cancel

실행한 코루틴을 중단하는 방법 : 바로 cancel 함수를 통해서 가능하다!

import kotlinx.coroutines.*

fun main() =runBlocking{
    val job = launch{
        repeat(5) { i ->
            println("Coroutine A, $i")
            delay(500L)
        }
    }

    delay(1000L)
    println("tired")
    job.cancel()
    job.join()
    println("quit")
}

 

하지만 cancel도 적용되는 조건이 주어진다.

일단 코루틴 코드가 협조적일 필요가 있다. 코드를 짤 때 아래의 요소들을 생각하면서 짜보자.

• 주기적으로 suspend 함수 사용
  • suspend 함수는 취소가 가능하다
• isActive 변수를 사용하여 명시적으로 상태를 체크

1. suspend 함수를 사용한 cancel

아래 코드는 의도한 대로 종료하지 않는다.

import kotlinx.coroutines.*

fun main() =runBlocking{
	val startTime = System.currentTimeMillis()
  val job =launch(Dispatchers.Default){
		var nextPrintTime = startTime
	  var i =0
    while(i < 5){
	    if (System.currentTimeMillis() >= nextPrintTime){
				println("Job : I am sleeping ${i++}")
        nextPrintTime += 500L
			}
		}
	}
	delay(1300L)
	println("tired")
	job.cancelAndJoin()
	println("quit")
}

 

오잉? 왜 그러지

이는 바로, launch 내부에 suspend 함수가 없기 때문이다!

 

이는 아래 인텔리제이에서 더 잘 확인할 수 있다.

 

가장 왼쪽에 초록 곡선이 있는 화살표가 suspend 함수를 의미한다.

위의 main은 suspend 함수인 delay()를 launch 함수 안에 사용했고, 아래 main은 전혀 사용하지 않았다.

 

그래서 위 main과 다르게 아래 main은 의도한 대로 작동하지 않는다.

 

 

이 문제를 해결하기 위해 suspend 함수를 사용하면 되는데,

이때 yield()도 사용이 가능하다.

yield는 Exception과 함께 반환되어, 예외를 받고 싶다면 try catch문을 사용하면 된다.

 

import kotlinx.coroutines.*

fun main() =runBlocking{
val startTime = System.currentTimeMillis()
val job =launch(Dispatchers.Default){
	try {
		var nextPrintTime = startTime
    var i = 0
    while (i < 5) {
	    if (System.currentTimeMillis() >= nextPrintTime) {
	      yield()
				println("Job : I am sleeping ${i++}")
        nextPrintTime += 500L
			}
	  }
	} catch (e: Exception) {
			println("Exception $e")
    }
	}
	delay(1300L)
	println("tired")
  job.cancelAndJoin()
	println("quit")
}

2. isActive 변수를 사용한 cancel

상태 변수를 사용해서도 cancel이 가능하다.

isActive 변수는 cancel()가 호출되면 true에서 false로 바뀐다.

 

import kotlinx.coroutines.*

fun main() =runBlocking{
  val job =launch(Dispatchers.Default){
    var i = 0
      println("Before : isActive $isActive")
      while (isActive) {
          println("Job : I am sleeping ${i++}")
      }
      println("After : isActive $isActive")
  }
  delay(1L)
  println("tired")
  job.cancelAndJoin()
  println("quit")
}

3. Closing resources with finally

코루틴을 종료할 때 리소스를 해제하기 위해 try-finally 구문을 사용한다.

import kotlinx.coroutines.*

fun main() =runBlocking{
	val job =launch{
	try {
		repeat(5){i->
			println("Coroutine A, $i")
			delay(500L)
		}
	} finally {
		println("I am running finally")
	  }
	}

	delay(1000L)
	println("tired")
  job.cancelAndJoin()
	println("quit")
}

 

4. Run non-cancellable bloc

취소 된 코루틴 안에서 코루틴으로 suspend 해야 할 경우, 즉 finally 안에서 코루틴을 불러오는 경우

도 엄청 레어하게 존재한다.

import kotlinx.coroutines.*

fun main() =runBlocking{
	val job =launch{
		try {
			repeat(5){i->
				println("Coroutine A, $i")
	      delay(500L)
			}
		} finally {
		  withContext(NonCancellable){
				println("Job : I am running finally")
	      delay(1000L)
				println("Job : and Just Delay")
			}
		}
	}
	delay(1000L)
	println("tired")
	job.cancelAndJoin()
	println("quit")
}

 

2. Timeout

cancel을 사용하지 않고도, 정해진 시간이 되면 코루틴이 cancel되는 매직

1. withTimeout

import kotlinx.coroutines.*

fun main() =runBlocking{
	withTimeout(1300L){
		repeat(100){i->
			println("I am Sleeping, $i")
      delay(500L)
		}
  }
}

하지만 코루틴 종료와 동시에 TimeoutCancellationException을 반환한다.

이를 보완한 방법이 Null을 반환하는 것!

2. withTimeoutOrNull

import kotlinx.coroutines.*

fun main() =runBlocking{
	val result = withTimeoutOrNull(1300L){
		repeat(100){i->
			println("I am Sleeping, $i")
	    delay(500L)
		}
	}
	println("result id $result")
}

이렇게 null을 반환하면서 Timeout이 실행되어 코루틴이 종료가 된다.

 

 

참조

새차원의 코틀린 코루틴(Coroutines) 강좌