[Coroutine] 코루틴 컨텍스트

💡 코루틴 빌더에서 활용되는 코루틴 컨텍스트에 대하여 학습하였습니다.

코루틴 컨텍스트

• 코루틴 빌더의 정의를 보면 첫 번째 파라미터가 CoroutineContext임을 알 수 있습니다.

fun CoroutineScope.launch(
    context: CoroutineContext = EmptyCoroutineContext,
    start: CoroutineStart = CoroutineStart.DEFAULT,
    block: suspend CoroutineScope.() -> Unit
): Job

• 리시버뿐만 아니라 마지막 인자의 리시버도 CoroutineScope 타입이며, 중요한 개념으로 활용되는 CoroutineContext의 정의를 알아야 합니다 !

CoroutineContext 인터페이스

• CoroutineContext는 원소나 원소들의 집합을 나타내는 인터페이스입니다.
• 컨텍스트의 지정과 변경을 편리하게 하기 위해 CoroutineContext의 모든 원소는 CourtineContext로 되어 있습니다.
• 또한 컨텍스트에서 모든 원소는 식별할 수 있는 유일한 Key를 가지고 있습니다.

CoroutineContext에서 원소 찾기

• CoroutineContext는 컬렉션과 개념이 비슷하기 때문에 get을 사용한 유일한 키를 가진 원소를 찾을 수 있습니다.
• 원소를 찾지 못한다면 Null이 반환됩니다.

fun main() {
    val ctx: CoroutineContext = CoroutineName("A name")

    val coroutineName: CoroutineName? = ctx[CoroutineName] //ctx.get(Job)
    val job: Job? = ctx[job]
    println(job) // null
}

• CoroutineContext는 코틀린 코투틴이 언어적으로 지원하기 있기 때문에 kotlin.coroutines에서 import됩니다.
• 하지만 Job이나 CoroutineName과 같은 컨텍스트는 kotlinx.coroutines 라이브러리를 import합니다.

컨텍스트 더하기

• CoroutineContext는 두 개의 CoroutineContext를 합쳐 하나의 CoroutineContext로 만들 수 있다는 특징이 있습니다.
• 다른 키를 가진 두 원소를 더하면 만들어진 컨텍스트는 두 가지 키를 모두 가집니다.

fun main() {
    val ctx1: CoroutineContext = CoroutineName("name1")
    println(ctx1[CoroutineName]?.name) //name1
    println(ctx1[Job]?.isActive) // null

    val ctx2: CoroutineContext = Job()
    println(ctx2[CoroutineName]?.name) // null
    println(ctx2[Job]?.isActive) // true 

    val ctx3 = ctx1 + ctx2
    println(ctx3[CoroutineName]?.name) // name1
    println(ctx2[Job]?.isActive) // true 
}

컨텍스트 원소 제거

• minusKey 함수에 키를 넣는 방식으로 원소를 컨텍스트에서 제거할 수 있습니다.

fun main() {
    val ctx1: CoroutineContext = CoroutineName("name1") + Job()
    println(ctx1[CoroutineName]?.name) //name1
    println(ctx1[Job]?.isActive) // true

    val ctx2: ctx1.minusKey(CoroutineName)
    println(ctx2[CoroutineName]?.name) // null
    println(ctx2[Job]?.isActive) // true 

    val ctx3 = (ctx1 + CoroutineName("name2")).minusKey(CoroutineName)
    println(ctx3[CoroutineName]?.name) // null
    println(ctx2[Job]?.isActive) // true 
}

컨텍스트 폴딩

• 컨텍스트의 각 원소를 조작해야 하는 경우 다른 컬렉션의 fold와 유사한 메서드를 사용 가능합니다.

[fold]

• 컬렉션을 순회하면서 각 원소를 누적하여 하나의 값을 생성하는 고계 함수입니다.
• 초기값과 누적 함수를 매개변수로 받아, 컬렉션의 각 원소에 대해 누적 함수를 적용햐여 최종 값을 반환합니다.

fun main() {
    val numbers = listOf(1,2,3,4,5)
    val sum = numbers.fold(0) { acc, number ->
        acc + number
    }
    println(sum) // 15
}

inline fun <T, R> Iterable<T>.fold(
    initial: R,
    operation: (acc: R, T) -> R
): R

• CoroutineContext에서 fold를 아래 규칙을 통해 적용할 수 있습니다.
  • 누산기의 첫 번째 값을 넣어줌
  • 누산기의 현재 상태와 현재 실행되고 있는 누산기의 다음 상태를 계산할 연산 진행

fun main() {
    val ctx1: CoroutineContext = CoroutineName("name1")

    ctx1.fold("") { acc, element -> "$acc$element" }
        .also(::println)
}

코투린 컨텍스트와 빌더

• CoroutineContext는 코루틴의 데이터를 저장하고 전달하는 방법입니다.
• 부모-자식 관계의 영향 중 하나로 부모는 기본적으로 컨텍스트를 자식에게 전달합니다.
• 자식은 부모로부터 컨텍스트를 상속받는다고 할 수 있습니다.

fun CoroutineScope.log(msg: String) {
    val name = coroutineContext[CoroutineName]?.name
    println("[$name] $msg")
}

fun main() = runBlocking(CorutineName("main")) {
    log("Started") //[main] Started
    val v1 = async {
        delay(500)
        log("Running async") // [main] Running async
        42
    }
    launch {
        delay(1000)
        log(Running launch") // [main] Running launch
    }
    log("the answer is ${v1.await()}")
    // [main] the answer is 42
}

• 물론 모든 자식은 빌더의 인자에서 정의된 특정 컨텍스트를 가질 수 있으며, 부모로부터 상속받은 컨텍스트를 대체할 수 있습니다.
• 아래와 같은 공식이 적용됩니다.

newContext = defaultContext + parentContext + childContext

• defaultContext는 ContinuationInterceptor가 설정되지 않았을 때 사용하는 Dispathcers.Default이며, 애플리케이션이 디버그 모드일 때는 CoroutineId도 디폴트로 설정됩니다.
• Job은 항상 변경 가능하며, 코루틴의 자식과 부모가 소통하기 위해 사용되는 특별한 컨텍스트입니다.

중단 함수에서의 컨텍스트

• CoroutineScope는 컨텍스트를 접근할 때 사용하는 coroutineContext 프로퍼티를 가지고 있습니다.
• 따라서 일반적인 중단 함수에서도 컨텍스트에 접근 가능하며, 개별적으로 생성도 가능합니다.

// 중단 함수에서 컨텍스트 접근
suspend fun printName() {
    println(coroutineContext[CoroutineName]?.name)
}

suspend fun main() = withContext(CoroutineName("Outer")){
    printName() // Outer
    launch(CoroutineName("Inner"){
        printName() // Inner
    }
            delay(10)
            printName() // Outer
}

// 컨텍스트 생성
class MyCustomContext: CoroutineContext.Element {
    override val key : CoroutineContext.Key<*> = Key

    companion object Key :
        CoroutineCotext.Key<MyCustomContext>
}

• 컨텍스트를 생성하는 경우는 매우 적지만, 테스트 환경과 프로덕션 환경에서 서로 다른 값을 쉽게 주입하기 위해 가끔 사용합니다.

요약

• coroutineContext는 맵이나 집합과 같은 컬렉션이랑 개념적으로 비슷합니다.
• coroutineContext는 Element 인터페이스의 인덱싱된 집합이며, Element 또한 coroutineContext입니다.
• coroutineContext 안의 모든 원소는 식별할 때 사용되는 유일한 Key를 가지고 있습니다.
• 이는 코루틴에 관련된 정보를 객체로 그룹화하고 전달하는 보편적이 방법이며, 코루틴에 저장됩니다.
• coroutineContext를 사용해서 코루틴의 상태를 확인하고, 어떤 스레드를 선택할지 등 코루틴의 작동 방식을 정할 수 있습니다.