TIL

8강 suspending function

suspending lambda

suspending function
- suspend가 붙은 함수
- 다른 suspend 함수를 호출할 수 있다.
main 함수에서 suspend 함수를 사용할 수 있었던건 launch 등의 코루틴 빌더의 마지막 파라미터가 suspending lambda이기 때문이다.

fun main(): Unit = runBlocking {
  launch {
    delay(100L)
  }
}

// launch의 시그니처
public fun CoroutineScope.launch(
    context: CoroutineContext = EmptyCoroutineContext,
    start: CoroutineStart = CoroutineStart.DEFAULT,
    block: suspend CoroutineScope.() -> Unit
): Job

main에서 suspend 함수인 delay를 호출할 때 main이 suspend 함수일 필요는 없고 delay를 실행시키는 block 파라미터가 suspend 함수였던 것

suspend function의 활용

suspend 함수는 코루틴이 중지 되었다가 재개 될 수 있는 지점이다.
- 그러한 지점을 suspension point라 부른다.
- 무조건 중지되는 것이 아닌 중지 될 수 있는 지점이라는 것이 핵심이다.
suspend 함수를 활용하면 여러 비동기 라이브러리를 사용할 수 있도록 도와준다.
아래 코드는 async와 Deffered(async의 반환 값)를 사용해 콜백 없이 코드를 작성했다.

fun main(): Unit = runBlocking {
  val result1 = async {
    apiCall1() 
  }
  // val result1: Defferred<Int>
  
  val result2 = async {
    apiCall2(result1.await())
  }
  
  printWithThread(result2.await())
}

// apiCall1, apiCall2를 외부 라이브러리라 가정 (1초 걸림)
fun apiCall1(): Int { 
  Thread.sleep(1_000L)
  return 100
}

fun apiCall2(num: Int): Int {
  Thread.sleep(1_000L)
  return num * 2
}

위 코드의 아쉬운 점은 CompletableFuture나 Reactor 같은 다른 라이브러리를 사용해야 한다면 변경이 main에 전파된다는 점이다.
- suspend 함수를 활용하면 이 문제를 개선할 수 있다.

fun main(): Unit = runBlocking {
  val result1 = apiCall1()
  val result2 = apiCall2(result1)
  
  printWithThread(result2)
}

suspend fun apiCall1(): Int {
  return CoroutineScope(Dispatchers.Default).async {
    Thread.sleep(1_000L)
    100
  }.await()
}

suspend fun apiCall2(num: Int): Int { // 여기선 CompletableFuture 사용
  return CompletableFuture.supplyAsync {
    Thread.sleep(1_000L)
    num * 2
  }.await() // 이 await는 코루틴이 만들어 놓은 확장함수이다.
}

apiCall1, apiCall2를 suspend 함수로 변경해 내부에서 어떤 비동기 라이브러리를 사용하던 해당 함수의 선택으로 남겨둔 것

추가적인 suspend 함수

coroutineScope
- 추가적인 코루틴을 만들고 주어진 함수 블록이 바로 실행된다.
  - launch나 async로 만들어진 코루틴은 바로 실행되지 않는다.
- 만들어진 코루틴이 모두 완료되면 다음 코드로 넘어간다.
- 코루틴들을 동시에 실행하고 싶으면서 기능들을 다른 함수로 분리하고 싶을 때 사용할 수 있다.

fun main(): Unit = runBlocking {
  printWithThread("START")
  printWithThread(calculateResult())
  printWithThread("END")
}

suspend fun calculateResult(): Int = coroutineScope {
  val num1 = async {
    delay(1_000L)
    10 
  }
  
  val num2 = async {
    delay(1_000L)
    20
  }
  
  num1.await() + num2.await()
}

// 출력 결과 (launch 등과 달리 바로 실행되기에 30이 END 전에 출력된다.)
// START
// 30
// END

withContext
- coroutineScope와 기본적으로 유사하다
- context에 변화를 줄 수 있다.
- 아래는 Dispatcher를 바꿔 사용하는 예제다.

fun main(): Unit = runBlocking {
  printWithThread("START")
  printWithThread(calculateResult())
  printWithThread("END")
}

suspend fun calculateResult(): Int = withContext(Dispatchers.Default) {
  val num1 = async {
    delay(1_000L)
     10 
  }
  
  val num2 = async {
    delay(1_000L)
    20
  }
  
  num1.await() + num2.await()
}

// 출력 결과
// START
// 30
// END

withTimeout withTimeoutOrNull
- coroutineScope와 기본적으로 유사
- 주어진 시간 안에 새로 생긴 코루틴이 완료 되어야 한다.
- 주어진 시간에 코루틴이 완료되지 않으면
  - withTimeout은 예외를 던진다.
  - withTimeoutOrNull은 null을 반환한다.

fun main(): Unit = runBlocking {
  withTimeout(1_000L) {
    delay(1_500L)
    10 + 20 
  }
}

// 출력 결과
// Exception in thread "main" kotlinx.coroutines.TimeoutCancellationException: Timed out waiting for 1000 ms