응답 유효성 검사

코드 예시: client-validate-2xx-response, client-validate-non-2xx-response

기본적으로 Ktor는 상태 코드에 따라 응답의 유효성을 검사하지 않습니다. 필요한 경우 다음 유효성 검사 전략을 사용할 수 있습니다.

• expectSuccess 속성을 사용하여 2xx가 아닌 응답에 대해 예외를 발생시킵니다.
• 2xx 응답에 대한 더 엄격한 유효성 검사를 추가합니다.
• 2xx가 아닌 응답의 유효성 검사를 사용자 지정합니다.

기본 유효성 검사 활성화

Ktor를 사용하면 expectSuccess 속성을 true로 설정하여 기본 유효성 검사를 활성화할 수 있습니다. 이 작업은 클라이언트 구성 수준에서 수행할 수 있습니다.

import io.ktor.client.*
import io.ktor.client.engine.cio.*

val client = HttpClient(CIO) {
    expectSuccess = true
}

... 또는 요청 수준에서 동일한 속성을 사용하여 수행할 수 있습니다. 이 경우, 2xx가 아닌 오류 응답에 대해 다음 예외가 발생합니다.

• 3xx 응답의 경우 RedirectResponseException.
• 4xx 응답의 경우 ClientRequestException.
• 5xx 응답의 경우 ServerResponseException.

사용자 지정 유효성 검사

HttpCallValidator 플러그인을 사용하여 2xx 응답에 대한 추가 유효성 검사를 추가하거나 기본 유효성 검사를 사용자 지정할 수 있습니다. HttpCallValidator를 설치하려면 클라이언트 구성 블록 내에서 HttpResponseValidator 함수를 호출합니다.

val client = HttpClient(CIO) {
    HttpResponseValidator {
        // ...
    }
}

2xx 응답 유효성 검사

위에서 언급했듯이, 기본 유효성 검사는 2xx가 아닌 오류 응답에 대해 예외를 발생시킵니다. 2xx 응답에 대한 더 엄격한 유효성 검사 및 확인이 필요한 경우, HttpCallValidator에서 사용할 수 있는 validateResponse 함수를 사용합니다.

아래 예시에서 클라이언트는 JSON 형식으로 오류 세부 정보가 포함된 2xx 응답을 수신합니다. validateResponse는 CustomResponseException을 발생시키는 데 사용됩니다.

val client = HttpClient(CIO) {
    install(ContentNegotiation) { json() }
    HttpResponseValidator {
        validateResponse { response ->
            val error: Error = response.body()
            if (error.code != 0) {
                throw CustomResponseException(response, "Code: ${error.code}, message: ${error.message}")
            }
        }
    }
}

2xx가 아닌 예외 처리

기본 유효성 검사를 사용자 지정하고 2xx가 아닌 응답에 대한 예외를 특정 방식으로 처리해야 하는 경우, handleResponseExceptionWithRequest를 사용합니다. 아래 예시에서 클라이언트는 기본 ClientRequestException 대신 404 응답에 대해 사용자 지정 MissingPageException을 발생시킵니다.

val client = HttpClient(CIO) {
    expectSuccess = true
    HttpResponseValidator {
        handleResponseExceptionWithRequest { exception, request ->
            val clientException = exception as? ClientRequestException ?: return@handleResponseExceptionWithRequest
            val exceptionResponse = clientException.response
            if (exceptionResponse.status == HttpStatusCode.NotFound) {
                val exceptionResponseText = exceptionResponse.bodyAsText()
                throw MissingPageException(exceptionResponse, exceptionResponseText)
            }
        }
    }
}