[Kotlin & Spring] Amazon S3 업로드 - 공통 에러 처리 핸들링, runCatching

정말 작은 역할이지만 조금씩 사이드 프로젝트를 진행하고 있는데, 코틀린 문법을 공부하면서 새로운 점을 알게 되어 기록하고자 한다! (코틀린... 익숙해지면 정말 편할 것 같지만 아직은 잘 모르겠다. 어렵다!)

 

---

✔️ Amazon S3 with Kotlin

코틀린과 s3를 연동하게 되면, 예기치 못한 서버 오류에 대비하여 파일을 삽입하거나 삭제할 때, 혹은 url 정보를 받아올 때 다음과 같이 Exception이 발생할 수 있게 된다.

 

한 가지 궁금한 점은, AmazonServiceException의 경우 부모 타입이 SdkClientException인데 왜 구분해두었을까...

 

아무튼, 기존에는 서버 에러에 대해 전혀 고려하지 않은 상태로 다음과 같은 코드를 작성하였었다.

fun deleteFile(fileKey: String) {
    val bucketName = s3Properties.bucketName
    s3Client.deleteObject(bucketName, fileKey)
}

외부 api를 사용하는 만큼, 당연하게도 외부 오류에 대해서 처리를 했어야 했는데 이를 간과해버렸다 🥲

코드 리뷰를 통해서 해당 부분에 대해서 지적을 받았고, 그래서 처음에는 다음과 같이 코드를 작성하였다.

class S3Exception(cause: Throwable? = null) :
        PureureumException(cause = cause, errorCode = ErrorCode.S3_UPLOAD_FAILED)

fun deleteFile(fileKey: String) {
    val bucketName = s3Properties.bucketName
    try {
        s3Client.deleteObject(bucketName, fileKey)
    } catch (e: SdkClientException) {
        throw S3Exception(e)
    }
}

S3Exception은 자체적으로 정의한 Exception이다. 

하지만, 너무 자바스럽게 코드를 작성한 것이 아닐까? 라는 의문이 들어서 이것저것 찾아보았다.

그리고 얻어낸 것이, 코틀린에는 runCatching이라는 게 존재했었다! 😲

 

---

✔️ 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)
    }
}

Calls the specified function block with this value as its receiver and returns its encapsulated result if invocation was successful, catching any Throwable exception that was thrown from the block function execution and encapsulating it as a failure.

함수블록을 receiver에게 호출하고, 호출이 성공하면 결과를 반환한다. 성공하면 성공에 대해서 캡슐화를 진행하고, 예외가 발생하면 실패로 캡슐화를 진행한다. 여기서 'Result'라는 친구가 사용되는 것을 볼 수 있다. (에러 발생 시 Result.failure, 아니라면 Result.success)

@SinceKotlin("1.3")
@JvmInline
public value class Result<out T> @PublishedApi internal constructor(
@PublishedApi
    internal val value: Any?
            ) : Serializable {
            // discovery
            }

public companion object {
    /**
     * Returns an instance that encapsulates the given [value] as successful value.
     */
    @Suppress("INAPPLICABLE_JVM_NAME")
    @InlineOnly
    @JvmName("success")
    public inline fun <T> success(value: T): Result<T> =
            Result(value)

    /**
     * Returns an instance that encapsulates the given [Throwable] [exception] as failure.
     */
    @Suppress("INAPPLICABLE_JVM_NAME")
    @InlineOnly
    @JvmName("failure")
    public inline fun <T> failure(exception: Throwable): Result<T> =
            Result(createFailure(exception))
}

코드 내부를 확인해보면, 성공일 경우 T 타입의 값을 가지게 되고, 실패일 경우 exception을 값으로 가지는 것을 볼 수 있다.

---

✔️ Result를 사용하면 뭐가 좋은데?

Result는 내부적으로 꽤나 다양한 메서드들을 제공하고 있다.

 

💬 getOrNull

@InlineOnly
public inline fun getOrNull(): T? =
        when {
            isFailure -> null
            else -> value as T
        }

에러가 발생하면 해당 에러를 무시하고, null을 반환하도록 할 수 있다.

 

💬 getOrDefault

@InlineOnly
@SinceKotlin("1.3")
public inline fun <R, T : R> Result<T>.getOrDefault(defaultValue: R): R {
        if (isFailure) return defaultValue
        return value as T
}

에러가 발생하면 지정한 기본값을 반환하도록 설정한다.

 

💬 getOrElse

@InlineOnly
@SinceKotlin("1.3")
public inline fun <R, T : R> Result<T>.getOrElse(onFailure: (exception: Throwable) -> R): R {
    contract {
    	callsInPlace(onFailure, InvocationKind.AT_MOST_ONCE)
    }
    return when (val exception = exceptionOrNull()) {
        null -> value as T
        else -> onFailure(exception)
    }
}

에러가 발생하면 특정한 동작을 수행한다.

여기서 두 개의 인자를 받는데, 첫 번째는 객체가 성공적으로 값을 가지고 있을 때 해당 값을 반환하는 람다 함수, 두 번째는 객체가 실패했을 경우 Throwable 객체를 처리하여 반환할 대체 값을 생성하는 람다 함수이다.

 

여기서 내부적으로 contract 블록을 활용하면 (인라인 함수에서만 사용 가능) 함수 호출의 전제 조건, 혹은 사후 조건 등을 정의할 수 있는데, 여기서는 callInPlace 함수를 활용하여 onFailure 함수가 최대 1번만 호출되는 것을 보장한다. 

그리고, when절을 통해서 객체가 가지고 있는 값을 가져오거나, 실패했을 경우 대체 값을 반환하게 된다. (exceptionOrNull 함수를 통해 실패한 경우 Throwable을, 그리고 onFailure를 통해 대체값을 생성하게 된다.)

 

🫠 인라인 함수

// 일반 함수
fun add(a: Int, b: Int): Int {
    return a + b
}

// 인라인 함수
inline fun add(a: Int, b: Int): Int {
	return a + b
}

인라인 함수라는 것을 처음 들어봐서 간단하게 작성해보고자 한다.

인라인 함수는 호출되는 위치에 함수의 내용을 복사하여 함수 호출 비용을 줄이는데, inline 키워드를 사용해 선언한다.

일반 함수는 호출할 때마다 해당 함수에 대한 스택 프레임에 생성되고, 함수가 실행이 되고, 결과값을 반환한 뒤 스코프가 끝나면 스택 프레임이 제거된다. 하지만, 인라인 함수는 호출 시점에 호출부에서 함수가 직접 삽입되기 때문에, 함수 호출의 오버 헤드를 줄이게 된다.

 

💬 exceptionOrNull

public fun exceptionOrNull(): Throwable? =
        when (value) {
            is Failure -> value.exception
            else -> null
        }

에러가 발생한 경우에만 해당 에러 객체를 반환하고, 아니라면 null을 반환한다.

 

---

✔️ runCatching 적용하기

아무튼, 위에 나온 다양한 메서드를 활용하여 내 코드에 적용해보았다.

fun deleteFile(fileKey: String) {
    val bucketName = s3Properties.bucketName
    return runCatching {
        	s3Client.deleteObject(bucketName, fileKey)
        }.getOrElse {
        	throw S3Exception(it)
        }
}

확실히 이전보다 코틀린스럽게 작성한 것 같아서 좋았다. 

하지만, 문제점이 있었다. 파일 삭제, 생성, 조회 시에도 모두 runCatching 블록이 들어가다 보니 중복이 되는 것이었다.

 

그래서, 함수형 인터페이스를 활용해보고자 했다.

private fun <T> execute(operation: () -> T): T {
        return runCatching { operation() }
        .getOrElse { throw S3Exception(it) }
}

별거 없다. 그냥 실행해야 하는 로직에 대해서 매개변수로 람다로 넘겨주는 것이다.

 

위의 호출부도 다음과 같이 줄일 수 있게 된다.

override fun deleteFile(fileKey: String) {
    val bucketName = s3Properties.bucketName
    return execute {
    	s3Client.deleteObject(bucketName, fileKey)
    }
}

덕분에 s3 관련 에러 로직들은 한 번에 처리할 수 있게 되었다 😊

 

---

 

얼른 코틀린 잘하고 싶다... 아직 너무 어렵다 🥲

스프링도, JPA도 다 다시 공부해야겠다... 다 까먹었다... ㅎ 힘내자...