[Kotlin Coroutines] Job

kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-job/index.html

Job - kotlinx-coroutines-core

interface Job : Element

백그라운드 작업. 개념적으로는 작업은 완료로 끝나는 수명주기를 가지고 있고, 취소할 수 있다.

상위-하위 계층/부모-자식 계층으로 이루어져 있어서 부모가 취소되면 모든 자녀들도 바로 재귀적으로 취소된다.

CancellationExeption 외의 exception으로 자식이 취소되면 즉시 부모와 부모의 모든 다른 자녀들도 취소된다. SupervisorJob으로 이 동작은 사용자가 지정할 수 있다. 

 

기본적인 Job의 인스턴스의 생성은 다음과 같다.

• launch 코루틴 빌더로 Coroutine job이 생성된다. 특정 블록 안에서 실행하고 블록의 완료 때 완료된다.
• Job() 팩토리 함수로 CompletableJob이 생성된다. CompletableJob.complete 함수가 호출되면 완료된다.

개념적으로 Job의 실행은 결과 값을 만들어내지 않는다.

 

상태

Job은 상태(state)를 가진다. 상태는 isActive, isComplete, isCancelled 로 확인할 수 있다.

                                          wait children
    +-----+ start  +--------+ complete   +-------------+  finish  +-----------+
    | New | -----> | Active | ---------> | Completing  | -------> | Completed |
    +-----+        +--------+            +-------------+          +-----------+
                     |  cancel / fail       |
                     |     +----------------+
                     |     |
                     V     V
                 +------------+                           finish  +-----------+
                 | Cancelling | --------------------------------> | Cancelled |
                 +------------+                                   +-----------+

 대게 코루틴은 active 상태로 생성된다. 코루틴 빌더가 CoroutineStart.LAZY 를 매개변수로 넣으면 new 상태의 코루틴을 생성해 start() 함수를 사용할 수 있다. 이러한 job은 start또는 join으로 active 상태가 된다.

Job의 active 상태는 1) 코루틴이 작업하는 동안, 2) CompleteableJob이 완료(complete)되기 전까지, 또는 3) 코루틴이 fail되거나 cancell되기 전까지이다.

 

active한 Job에 exception이 생겨 실패하면 cancelling 상태가 된다. Job은 언제든 cancel 함수로 취소 가능혀 즉시 cancelling 상태로 전환된다. Job이 모든 작업을 마치고 모든 자녀들이 완료되면 cancelled 상태가 된다.

 

active한 코루틴의 body의 완료나 CompletableJob.complete가 호출되면 Job은 completing 상태가 된다. completed 상태가 되기 전에 모든 자녀들이 완료되기를 기다린다. completing 상태는 Job의 내부적인 상태라서 자녀들의 완료를 내부적으로 기다리는 동안에 바깥에서는 active 상태로 확인된다. 

 

취소 원인

Job의 body가 exception을 발생시키면 코루틴 Job은 예외적으로 완료된다고 한다. CompletableJob은 CompletableJob.completeExeptionally를 호출해서 예외적으로 완료된다. 예외적으로 완료된 Job은 취소되고 해당 exception은 Job의 취소 원인이 된다.

 

Job의 취소를 발생시킨 exception의 종류에 따라서 실패와 정상적인 취소가 구분된다.

• CancellationException이 정상적으로 취소시키고,
• 그 외 다른 exception들은 실패시킨다. 

Job이 실패하면 같은 exception으로 부모도 취소된다. Job의 취소는 부모를 취소시키지 않는다. 부모는 이렇게 자녀들을 을(재귀적으로 모든 자녀들을) 취소시킬 수 있다.

 

동시성과 비동기성

thread-safe하다

 

함수

abstract suspend fun join(): Unit

job이 완료될 때까지 코루틴을 일시정시시킨다. Job이 완료되었을 때와 코루틴이 아직 active 상태일 때 join()을 호출하면 job이 재실행한다. job이 new 상태일 때에는 코루틴을 실행시킨다.

 

abstract fun cancel(cause: CancellationException? = null) : Unit

job을 취소시킨다. cause는 디버깅 목적으로 취소 이유를 상세하게 에러메시지로 남기고 싶을 때 사용할 수 있다.

 

fun Job.cancel(message: String, casue: Throwable? = null) : Unit

현재 Job을 취소시킨다.

 

fun CoroutineContext.cancel(cause: CancellationException? = null): Unit

이 context 안의 Job을 취소시킨다.

 

suspend fun Job.cancelAndJoin(): Unit

Job을 취소시키고 취소된 Job이 완료될 때까지 실행하는 코루틴을 일시중지시킨다.