[kotlin] Ktor Locations 예외 처리

26 Dec 2023

kotlin

Ktor에서는 URL 경로에 대한 매개 변수를 처리하기 위해 Locations 기능을 제공합니다. Locations를 사용한 라우팅을 구현하다 보면 매개 변수를 잘못된 형식으로 전달했을 때 발생하는 예외를 처리해야 할 때가 있습니다. 이 글에서는 Ktor의 Locations를 사용한 예외 처리에 대해 알아보겠습니다.

Ktor Locations이란?

Ktor는 경로와 관련된 매개 변수를 파싱하고 생성하기 위한 라이브러리를 제공하는데, 이를 Locations이라고 합니다. Locations를 사용하면 URL 경로의 매개 변수를 객체로 매핑하여 편리하게 처리할 수 있습니다.

예를 들어, 다음과 같이 Location을 정의하고 이를 통해 URL 경로의 매개 변수를 파싱할 수 있습니다.

data class UserLocation(val userId: Int, val name: String)

val userLocation = location<UserLocation> {
    param<Int>("userId")
    param<String>("name")
}

위의 코드에서 UserLocation 클래스는 userId와 name 매개 변수를 가지고 있으며, userLocation은 이를 파싱하기 위한 Location 객체를 정의한 것입니다.

예외 처리

Locations를 사용하다 보면 잘못된 형식의 매개 변수가 전달될 수 있습니다. 이 경우 Ktor에서 제공하는 LocationException을 활용하여 예외를 처리할 수 있습니다.

다음은 Location을 사용한 라우팅에서 발생하는 예외를 처리하는 예제입니다.

install(Locations)

routing {
    handle {
        try {
            val user = call.receive(UserLocation)
            // 유효한 매개 변수를 사용하는 코드
        } catch (e: LocationException) {
            // 잘못된 형식의 매개 변수를 처리하는 코드
            call.respondText("잘못된 형식의 매개 변수입니다.", status = HttpStatusCode.BadRequest)
        }
    }
}

위의 코드에서 /user 엔드포인트로 POST 요청이 들어오면 UserLocation 객체로 매핑하고, 그 과정에서 잘못된 형식의 매개 변수가 전달되었다면 LocationException이 발생하여 해당 예외를 처리합니다.

결론

Ktor의 Locations를 사용하여 URL 경로의 매개 변수를 효과적으로 처리할 수 있지만, 잘못된 형식의 매개 변수에 대한 예외 처리는 항상 고려해야 합니다. 위의 예제를 참고하여 안정적인 예외 처리를 구현해보세요.

참고문헌:

Ktor Documentation (https://ktor.io/docs/locations.html)