runCatching

📣 runCatching 은 try-catch 를 대체할 수 있는 코틀린의 문법이다. 

try-catch 문은 실패시의 핸들링을 처리할 수 있었다면,

runCatching 은 성공, 실패시 둘 다 처리 할 수 있다.

@InlineOnly
@SinceKotlin("1.3")
public inline fun <T, R> T.runCatching(block: T.() -> R): Result<R> {
    return try {
        Result.success(block())
    } catch (e: Throwable) {
        Result.failure(e)
    }
}

보다시피, 리턴 타입은 Result 라는 객체이며, 

전달받은 내용을 실행해서, 

성공한다면 Result.success() 를 통해 성공했다는 내용을 담은 Result 객체,

실패한다면 Result.failure() 를 통해 에러 내용을 담은 Result 객체를 반환한다.

기본 문법

runCatching { } : 중괄호 안에 try 하고자 하는 구문을 작성

onSuccess { } : 위 runCatch 구문이 성공시 매핑할 구문을 작성. it 은 위 구문의 결과.

onFailure { } : 위 runCatch 구문이 실패시 매핑할 구문을 작성. it 은 위 구문에서 던진 Throwable 객체.

also { } : 기존 try-catch-finally 에서 finally 에서 작성하던 구문을 작성할 수 있음.

복잡한 상황

map { } : 성공한 값에 대해 한번더 가공이 가능. 여기서 예외가 발생하면 runCatching 구문 밖으로 예외를 던짐.

mapCatching { } : 성공한 값에 대해 한번더 가공이 가능. 여기서 예외가 발생하면 runCatching 구문 밖으로 예외를 던지지 않고, 그 예외를 담은 Result 객체 반환. 이후 onFailure 등으로 다시 잡아서 처리가능.

recover { } : 실패한 값에 대해 한번더 핸들링이 가능. 여기서 예외가 발생하면 runCatching 구문 밖으로 예외를 던짐.

recoverCatching { } :실패한 값에 대해 한번더 핸들링이 가능. 여기서 예외가 발생하면 runCatching 구문 밖으로 예외를 던지지 않고, 그 예외를 담은 Result 객체 반환. 이후 onFailure 등으로 다시 잡아서 처리가능.

runCatching 구문의 return 값이 필요할때

getOrNull() : 위에서 반환된 Result 객체가 성공객체 일 때 값 반환. 실패면 null

getOrDefault(~) : 위에서 반환된 Result 객체가 성공객체 일 때 값 반환. 실패면 뒤에 정의한 값 반환.

getOrThrow() : 위에서 반환된 Result 객체가 성공객체 일 때 값 반환. 실패면 Result 객체의 예외 throw.

getOrElse { } : 위에서 반환된 Result 객체가 성공객체 일 때 값 반환. 실패면 뒤에 정의한 구문 실행.

Result 객체는 함수의 반환형으로 쓰일 수 없다.

Result<T>.getOrThrow(): T
Result<T>.getOrElse(onFailure: (exception: Throwable) -> R): R
Result<T>.getOrDefault(defaultValue: R): R
Result<T>.onSuccess(action: (value: T) -> Unit): Result<T>
Result<T>.onFailure(action: (exception: Throwable) -> Unit): Result<T>
Result<T>.fold(
    onSuccess: (value: T) -> R,
    onFailure: (exception: Throwable) -> R
): R

Result<T>.map(transform: (value: T) -> R): Result<R>
Result<T>.mapCatching(transform: (value: T) -> R): Result<R>
Result<T>.recover(transform: (exception: Throwable) -> R): Result<R>
Result<T>.recoverCatching(transform: (exception: Throwable) -> R): Result<R>

runCatching {
         doing...
      }.fold({
        // 성공시만 실행
      },{
        // 실패시만 실행
      })
            
var fruitName: String? = null
// 실패 시 default 값을 반환
fruitName = fruitResult.getOrDefault("")
// 실패 시 else block의 결괏값을 반환
fruitName = fruitResult.getOrElse {
    when(it) {
        is IllegalStateException -> "Sold out"
        is NullPointerException -> "null"
        else -> throw it
    }
}
// 실패시 throwable이 다시 throw 
fruitName = fruitResult.getOrThrow()

// map, recover을 이용해 성공과 실패 시 원하는 값으로 바꿀 수 있음
fruitResult.map {
    it.toUpperCase()
}

// Exception 별로 다시 한번 더 핸들링이 가능
fruitResult.recover {
    when(it) {
        is IllegalStateException -> "Sold out"
        is NullPointerException -> "null"
        else -> throw it
    }
}

참고자료

https://uchun.dev/runCatching%EC%9D%84-%EC%9D%B4%EC%9A%A9%ED%95%9C-kotlin%EC%97%90%EC%84%9C-exception%EC%B2%98%EB%A6%AC-%EB%B0%A9%EB%B2%95/