[Coroutine] 취소

💡 중단 함수를 사용하는 코루틴에서 취소를 통해서 자원 낭비와 메모리 누수를 줄일 수 있는 방법에 대하여 학습하였습니다.

cancellation

• 중단 함수를 사용하는 몇몇 클래스와 라이브러리는 항상 취소를 지원합니다.
• 단순히 스레드를 죽이면, 연결을 닫고 자원을 해제하는 기회가 없기 때문에 최악의 취소 방법이 됩니다.
• 개발자들이 상태가 액티브한지 확인하지 않아도 되고, 간단하고 안전한 방식으로 취소할 수 있도록 코루틴은 이를 지원하고 있습니다.

기본적인 취소

• Job 인터페이스는 cancel 메서드를 통해서 취소를 지원합니다.

cancel()

• 이를 호출한 코루틴은 첫 번째 중단점에서 잡을 끝냅니다.
• 잡이 자식을 가지고 있따면 그들 또한 취소되며, 부모는 영향을 받지 않습니다.
• 잡이 취소되면, 취소된 잡은 새로운 코루틴의 부모로 사용될 수 없습니다.
• 잡을 취소하면, Cancelling → Cancelled 상태로 변합니다.

val job = launch {
    repeat(1_000) { i ->
        delay(200)
        println("$i")
    }
}

delay(1100)
job.cancel()
job.join()

// 0
// 1
// 2
// 3
// 4

• job.join()을 뒤에 추가하면, 코루틴이 취소를 마칠 때까지 중단되므로 경쟁 상태가 발생하지 않습니다.

cancelAndJoin()

• kotlin.coroutines 라이브러리는 cancel과 join을 함께 호출할 수 있는 확장함수를 제공합니다.

public suspend fun Job.cancelAndJoin() {
    cancel()
    return join()
}

• 이 방법으로 Job과 연결 된 수많은 코루틴을 한번에 취소할 수 있습니다.
• 플랫폼의 종류를 불문하고 동시에 수행되는 작업 그룹 전체를 취소시켜야 할 때가 있습니다.
• 안드로이드로 예를 들면 사용자가 뷰 창을 나갔을 때, 뷰에서 시작된 모든 코루틴을 취소하는 경우입니다.

취소의 작동 방식

• 잡이 취소되면 Cancelling 상태로 바뀝니다.
• 상태가 바뀐 뒤 첫 번째 중단점에서 CancellationException 예외를 던지며, 예외를 잡거나 다시 던질 수 있습니다.

// in coroutineScope
val job = Job()
launch(job){
    try {
        repeat(1_000) { i ->
            delay(200)
            println("$i")
        }
    } catch (e : CancellationException) {
        println(e)
        throw e
    }
}
job.cancelAndJoin()
// JobCancellationException

취소 중 코루틴 한 번 더 호출하기

• 코루틴이 실제로 종료되기 전에 CancellationException을 잡고, 좀 더 많은 연산이 수행 가능합니다.
• 하지만 정리 과정 중에 중단을 허용하지는 않습니다.
• Job이 이미 Cancelling 상태가 되었을 때, 중단하거나 다른 코루틴을 시작하는 것은 불가능합니다.
• 이런 경우 withContext를 사용할 수 있습니다.
  • 이미 코루틴이 취소되었을 때 중단 함수를 반드시 호출해야 하는 경우가 발생
  • 데이터베이스의 변경 사항을 롤백해야 하는 경우
  • 이는 코드 블록의 컨텍스트를 바꾸는 것이며, withContext 내부에서는 취소될 수 없는 Job인 NonCancellable 객체를 사용할 수 있습니다.
  • 이 때 블록 내부에서 잡은 액티브 상태를 유지하며, 중단 함수를 원하는 만큼 호출할 수 있습니다.

val job = Job()
launch(job) {
    try {
        delay(200)
        println("Coroutine finished")
    } finally {
        println("Finally")
        withContext(NonCancellable){
            delay(1000L)
            println("Cleanup Done")
        }
    }
}
delay(100)
job.cancelAndJoin()
println("Done")

// Finally
// Cleanup Done
// Done

invokeOnCompletion()

• 자원을 해제하는 데 자주 사용되는 Job의 메서드입니다.
• 잡이 Completed나 Cancelled와 같은 마지막 상태에 도달했을 때 호출될 핸들러를 지정하는 역할을 합니다.

val job = launch {
    delay(1000)
}
job.invokeOnCompletion { exception: Throwable? ->
    println("Finished")
}
delay(400)
job.cancelAndJoin()

// Finished

• 핸들러의 파라미터 중 하나인 예외의 종류는 다음과 같습니다.
  • 잡이 예외 없이 끝나면 null이 됩니다.
  • 코루틴이 취소되었으면 CancellationException이 됩니다.
  • 코루틴을 종료시킨 예외가 발생할 수 있습니다.
• 이 함수는 취소하는 중에 동기적으로 호출되며, 어떤 스레드에서 실행할지 결정할 수는 없습니다.

중단될 수 없는 걸 중단하기

• 취소는 중단점에서 일어나기 때문에 중단점이 없으면 취소를 할 수 없습니다.
• 중단을 위해서 Thread.sleep을 사용할 수 있지만, 이는 좋지 않은 방법이며 이런 상황을 대체하는 여러가지 방법이 있습니다.

yield()를 주기적으로 호출

• yield는 코루틴을 중단하고 즉시 재실행합니다.
• 중단점이 생겼기 때문에 취소를 포함해 중단 중에 필요한 모든 작업을 할 수 있는 기회가 주어집니다.
• 중단 가능하지 않으면서 CPU 집약적이거나 시간 집약적인 연산들이 중단 함수에 있다면, 각 연산들 사이에 yield를 사용하는 것이 좋습니다.

suspend fun cpuIntensiveOperations() =
    withContext(Dispatchers.Default) {
        cpuIntensiveOperation1()
        yield()
        cpuIntensiveOperation2()
        yield()
        cpuIntensiveOperation3()
    }

잡의 상태를 추적

• 코루틴 빌더 내부에서 this는 빌더의 스코프를 참조하고 있습니다.
• coroutineContext[Job] 또는 coroutineContext.job을 통해서 현재 상태가 무엇인지 확인할 수 있으며, 이를 톧해 액티브한지 확인할 수 있습니다.

// isActive
public val CortoineScpoe.isActive : Boolean
    get() = coroutineContext[Job]?.isActive ?: true

suspend fun main(): Unit = coroutineScope {
    val job = Job()
    launch(job){
        do {
            // 상태가 액티브할 때 
        } while(isActivte)
    }
}

• 또는 ensureActive() 함수를 활용해서 Job이 액티브한 상태가 아니면 CancellationException을 던질 수 있습니다.

suspend fun main(): Unit = coroutineScope {
    val job = Job()
    launch(job) {
        Thread.sleep(200)
        ensureActive()
    }
    delay(100)
    job.cancelAndJoin()
}

yield()와 ensureActive()의 차이

• 두 함수 모두 다른 코루틴이 실행할 수 있는 기회를 준다는 점에서 결과는 비슷하지만, 매우 다른 기능을 하고 있습니다.
• ensuereActive() 함수는 반드시 CoroutineScope(또는 CoroutineContext나 Job)에서 호출되어야 합니다.
  • 일반적으로 좀 더 가벼운 작업이기 때문에 자주 사용하고 있습니다.
• yield()는 전형적인 최상위 중단 함수입니다.
  • 스코프가 필요하지 않기 때문에 일반적인 중단 함수에서도 사용될 수 있지만, 디스패처를 사용할 때 스레드가 바뀌는 문제가 생길 수 있습니다.
  • 때문에 CPU 사용량이 크거나 스레드를 블로킹하는 중단 함수에서 자주 사용됩니다.

suspendCancellableCoroutine

• 이 함수는 suspendCoroutine과 비슷하지만, 컨티뉴에이션 객체를 몇 가지 메서드가 추가된 CancellableContinuation<T>로 래핑합니다.
• 가장 중요한 메서드는 코루틴이 취소되었을 때 행동을 정의하는 데 사용하는 invokeOnCancellation 메서드입니다.
• 이 메서드는 라이브러리의 실행을 취소하거나 자원을 해제할 때 주로 사용합니다.

suspend fun someTask() = suspendCancellableCoroutine { cont ->
    cont.invokeOnCancellation {
        // 정리 작업을 수행
    }
    // 나머지 구현 부분
}

• 또한 CancellableContinuation<T>에서도 (isActive, isCompleted, isCancelled 프로퍼티를 사용) 잡의 상태를 확인할 수 있으며, 컨티뉴에이션을 취소할 때 취소가 되는 원인을 추가적으로 제공할 수 있습니다.

요약

• 취소는 코루틴의 강력하고 중요한 기능이며, 사용하는 데 까다로운 경우가 있습니다.
• 하지만 취소를 적절하게 사용하면 자원 낭비와 메모리 누수를 줄일 수 있습니다.