[Coroutine] 코루틴 스코프 만들기

 💡 안드로이드와 백엔드에서 코루틴 스코프를 어떻게 만들고 활용하는지 학습하였습니다.

CoroutineScope 팩토리 함수

• CoroutineScope는 coroutineContext를 유일한 프로퍼티로 가지고 있는 인터페이스입니다.

interface CoroutineScope {
    val coroutineContext: CoroutineContext
}

CoroutineScope 객체 생성

• CoroutineScope 인터페이스를 구현한 클래스를 만들고 내부에서 코루틴 빌더를 직접 호출할 수 있지만, 이 방법은 문제가 있습니다.
  • cancel이나 ensureActivce 같은 메서드를 직접 호출하면 문제가 발생함
  • 갑자기 전체 스코프를 취소하면 코루틴이 더 이상 시작될 수 없음

class SomeClass : CoroutineScope 

• 대신 코루틴 스코프 인터페이스를 프로퍼티로 가지고 있다가 코루틴 빌더를 호출할 때 사용하는 방법이 선호됩니다.

class SomeClass {
    val scope: CoroutineScope = ...
}

• 가장 좋은 방법은 CoroutineScope 팩토리 함수를 사용하는 것입니다.
  • 이 함수는 컨텍스트를 넘겨 받아 스코프를 생성합니다.
  • 잡이 컨텍스트에 없으면 구조화된 동시성을 위해 Job을 추가할 수도 있습니다.

public fun CoroutineScope(
    context: CoroutineContext
): CoroutineScope =
    ContextScope(
        if (context[Job] != null) context
        else context + Job()
    )

internal class ContextScope(
    context: CoroutineContext
): CoroutineScope

• 생성자처럼 보이는 함수는 가짜 생성자로 구현되어 있습니다.
  • 생성자 대신 팩토리 함수를 사용하라

안드로이드에서 스코프 만들기

• 대부분의 안드로이드 애플리케이션은 MVC 모델을 기반으로 한 MVVM, MVP 아키텍처가 사용되고 있습니다.
• 이러한 아키텍처에서는 사용자에게 보여 주는 부분을 ViewModels나 Presenters와 같은 객체로 추출합니다.
  • 일반적으로 코루틴이 가장 먼저 시작되는 객체이며, 유즈 케이스나 저장소와 같은 계층에서는 중단 함수를 사용합니다.
  • 프래그먼트나 액티비티에서도 시작할수 있습니다.
• 안드로이드에서 어떤 부분에서 코루틴을 시작하든지 간에 코루틴을 만드는 방법은 모두 비슷합니다.

abstract class BaseViewModel : ViewModel() {
    protected val scope = CoroutineScope(TODO())
}

class MainViewModel() : BaseViewModel {
    fun onCrate() {
        scope.launch {
            // in CoroutineScope
        }
    }
}

스코프에서 컨텍스트 정의하기

• 안드로이드에서는 메인 스레드가 많은 수의 함수를 호출해야 하므로 기본 디스패처를 Dispatchers.Main으로 지정하는 것이 좋습니다.

abstract class BaseViewModel: ViewModel() {
    protected val scope =
        CoroutineScope(Dispatchers.Main + Job())
    override fun onCleared() {
        scope.cancel()
    }
}

• 일반적으로 사용자가 스크린을 나가면, 진행 중인 모든 작업을 취소해야 합니다.
• 따라서 위처럼 onCleared()를 활용해 스코프를 취소할 수 있습니다.
• 또한 자식 코루틴만을 취소하는 것이 더 좋은 방법이며, 자식 코루틴만 취소하면 뷰 모델이 액티브한 상태로 유지되는 한, 같은 스코프에서 새로운 코루틴을 시작할 수 있습니다.

override fun onCleared() {
    scope.coroutineContext.cancelChildren()
}

• 또한 코루틴을 독립적으로 작동시키기 위해서 SupervisorJob을 활용할 수 있습니다.
  • 코루틴 하나가 취소된 경우 부모와 다른 자식 코루틴이 함께 취소되는 것을 방지할 수 있습니다.

protected val scope =
    CoroutineScope(Dispatchers.Main + SupervisorJob())

잡히지 않은 예외 처리

• 안드로이드에서 아래와 같은 에러를 띄울 수 있습니다.
  • HTTP 호출로 401 에러를 받으면 로그인 창을 띄워야 합니다.
  • 503 Service Unavailable의 경우 서버에 문제가 생겼다는 메세지를 보여야 합니다.
• BaseActivity에 예외 처리 핸들러를 한 번만 정의해두고 뷰 모델에 전달하는 방법을 가장 많이 사용합니다.
• 잡히지 않은 예외가 있는 경우 CoroutineExceptionHandler를 사용해 해당 함수를 호출할 수 있습니다.

abstract class BaseViewModel(
    private val onError: (Throwable) -> Unit
): ViewModel() {
    private val exceptionHandler =
        CorouitneEcceptionHandler { _, throwable ->
            onError(throwable)
        }

    private val context =
        Dispathcers.Main + SupervisorJob() + exceptinoHandler

    protected val scope = CoroutineScope(context)
}

viewModelScope와 lifecycleScope

• 최근에는 안드로이드 애플리케이션에서 스코프를 따로 정의하는 대신에 viewModelScope와 lifecycleScope를 사용할 수 있습니다.
• Dispatchers.Main과 SupervisorJob을 사용하고, 뷰 모델이나 라이프사이클이 종료되었을 때 잡을 취소시킨다는 점에서 위 코드와 매우 동일하다는 것을 알 수 있습니다.

viewModelScope.launch {
    // on coroutine
}

백엔드에서 코루틴 만들기

• 백엔드 프레임워크에서 중단 함수를 기본적으로 지원합니다.
• Ktor에서 모든 핸들러는 기본적으로 중단 함수를 활용하며, 따로 스코프를 만들 필요가 없습니다.

suspend fun delay(timeMillis: Long) {...}
suspend fun someNetworkCallReturningValue(): SomeType {
 ...
}

추가적인 호출을 위한 스코프 생성

• 추가적인 연산을 시작하기 위한 스코프를 종종 만들곤 합니다.
• 이런 스코프는 함수나 생성자의 인자를 통해 주입되며, 스코프를 호출 중단하기 위한 목적으로만 사용하려는 경우 SupervisorScope를 사용하는 것만으로 충분합니다.

val analyticsScope = CoroutineScope(SupervisorJob())

• CoroutineExceptionHandler를 사용해서 예외를 관리할 수 있습니다.

private val exceptionHandler =
    CoroutineExceptionHandler { _, throwable ->
        FirbaseCrashlytics.getInstance()
            .recordException(throwable)
    }
val analyticsScope = CoroutineScope(
    SupervisorJob() + exceptionHandler
)

• 또한 다른 디스패처를 설정함으로써 커스텀 할 수 있습니다.
• 스코프에서 블로킹을 호출한다면 Dispathcers.IO를 사용하고, 안드로이드 메인 뷰를 다뤄야 한다면 Dispathcers.Main을 사용할 수 있습니다.

val analyticsScope = CoroutineScope(
    SupervisorJob() + Dispathcers.IO
)