Skip to content
Server Plugin

요청 검증

필수 의존성: io.ktor:ktor-server-request-validation

코드 예제: request-validation

네이티브 서버Ktor는 Kotlin/Native를 지원하므로 추가 런타임이나 가상 머신 없이도 서버를 실행할 수 있습니다. 지원: ✅

RequestValidation 플러그인은 들어오는 요청의 본문(body)을 검증하는 기능을 제공합니다. 직렬 변환기(serializer)가 구성된 ContentNegotiation 플러그인이 설치되어 있다면, 가공되지 않은 원시 요청 본문(raw request body)이나 지정된 요청 객체의 프로퍼티를 검증할 수 있습니다. 요청 본문 검증에 실패하면 플러그인은 RequestValidationException을 발생시키며, 이는 StatusPages 플러그인을 사용하여 처리할 수 있습니다.

의존성 추가 ​

RequestValidation을 사용하려면 빌드 스크립트에 ktor-server-request-validation 아티팩트를 추가하세요:

kotlin
implementation(ktorLibs.server.requestValidation)
위 코드 스니펫은 Ktor 의존성을 지정하기 위해 Ktor 버전 카탈로그를 사용합니다.
groovy
implementation ktorLibs.server.requestValidation
위 코드 스니펫은 Ktor 의존성을 지정하기 위해 Ktor 버전 카탈로그를 사용합니다.
xml
<dependency>
    <groupId>io.ktor</groupId>
    <artifactId>ktor-server-request-validation-jvm</artifactId>
    <version>${ktor_version}</version>
</dependency>

RequestValidation 설치 ​

애플리케이션에 RequestValidation 플러그인을 설치하려면, 지정된 모듈모듈을 사용하면 라우트를 그룹화하여 애플리케이션의 구조를 설계할 수 있습니다.의 install 함수에 전달하세요. 다음 예제는 RequestValidation을 설치하는 방법을 보여줍니다:

  • embeddedServer() 함수 호출 내에서 설치.
  • Application 클래스에 명시적으로 정의된 module() 확장 함수 내에서 설치.
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.plugins.requestvalidation.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(RequestValidation)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.plugins.requestvalidation.*
// ...
fun Application.module() {
    install(RequestValidation)
    // ...
}

RequestValidation 플러그인은 특정 라우트에 설치할 수도 있습니다. 이는 애플리케이션의 서로 다른 리소스에 대해 다른 RequestValidation 설정이 필요한 경우 유용할 수 있습니다.

RequestValidation 구성 ​

RequestValidation 구성은 주로 세 단계로 진행됩니다:

  1. 본문 내용 수신
  2. 검증 함수 구성
  3. 검증 예외 처리

1. 본문 수신 ​

RequestValidation 플러그인은 타입 매개변수와 함께 receive 함수를 호출할 때 요청 본문을 검증합니다. 예를 들어, 아래 코드 스니펫은 본문을 String 값으로 수신하는 방법을 보여줍니다:

kotlin
routing {
    post("/text") {
        val body = call.receive<String>()
        call.respond(body)
    }
}

2. 검증 함수 구성 ​

요청 본문을 검증하려면 validate 함수를 사용하세요. 이 함수는 성공 또는 실패 검증 결과를 나타내는 ValidationResult 객체를 반환합니다. 실패한 결과의 경우 RequestValidationException이 발생합니다.

validate 함수에는 두 가지 오버로드가 있어 두 가지 방식으로 요청 본문을 검증할 수 있습니다:

  • 첫 번째 validate 오버로드는 요청 본문에 지정된 타입의 객체로 접근할 수 있게 해줍니다. 아래 예제는 String 값을 나타내는 요청 본문을 검증하는 방법을 보여줍니다:

    kotlin
    install(RequestValidation) {
        validate<String> { bodyText ->
            if (!bodyText.startsWith("Hello"))
                ValidationResult.Invalid("Body text should start with 'Hello'")
            else ValidationResult.Valid
        }
    }

    특정 직렬 변환기로 구성된 ContentNegotiation 플러그인이 설치되어 있다면 객체 프로퍼티를 검증할 수 있습니다. 자세한 내용은 예제: 객체 프로퍼티 검증을 참고하세요.

  • 두 번째 validate 오버로드는 ValidatorBuilder를 받아 사용자 정의 검증 규칙을 제공할 수 있도록 합니다. 자세한 내용은 예제: 바이트 배열 검증을 참고하세요.

3. 검증 예외 처리 ​

요청 검증에 실패하면 RequestValidation은 RequestValidationException을 발생시킵니다. 이 예외를 통해 요청 본문에 접근하고 해당 요청에 대한 모든 검증 실패 이유를 가져올 수 있습니다.

다음과 같이 StatusPages 플러그인을 사용하여 RequestValidationException을 처리할 수 있습니다:

kotlin
install(StatusPages) {
    exception<RequestValidationException> { call, cause ->
        call.respond(HttpStatusCode.BadRequest, cause.reasons.joinToString())
    }
}

전체 예제는 여기에서 확인할 수 있습니다: request-validation.

예제: 객체 프로퍼티 검증 ​

이 예제에서는 RequestValidation 플러그인을 사용하여 객체 프로퍼티를 검증하는 방법을 살펴보겠습니다. 서버가 다음과 같은 JSON 데이터와 함께 POST 요청을 수신한다고 가정해 봅니다:

HTTP
POST http://0.0.0.0:8080/json
Content-Type: application/json

{
  "id": -1,
  "firstName": "Jet",
  "lastName": "Brains"
}

id 프로퍼티에 대한 검증을 추가하려면 다음 단계를 따르세요:

  1. 위의 JSON 객체를 설명하는 Customer 데이터 클래스를 생성합니다:

    kotlin
    @Serializable
    data class Customer(val id: Int, val firstName: String, val lastName: String)
  2. JSON 직렬 변환기와 함께 ContentNegotiation 플러그인을 설치합니다:

    kotlin
    install(ContentNegotiation) {
        json()
    }
  3. 서버 측에서 다음과 같이 Customer 객체를 수신합니다:

    kotlin
    post("/json") {
        val customer = call.receive<Customer>()
        call.respond(customer)
    }
  4. RequestValidation 플러그인 설정에서 id 프로퍼티가 지정된 범위에 속하는지 확인하는 검증을 추가합니다:

    kotlin
    install(RequestValidation) {
        validate<Customer> { customer ->
            if (customer.id <= 0)
                ValidationResult.Invalid("A customer ID should be greater than 0")
            else ValidationResult.Valid
        }
    }

    이 경우, id 값이 0 이하이면 RequestValidation이 RequestValidationException을 발생시킵니다.

예제: 바이트 배열 검증 ​

이 예제에서는 바이트 배열로 수신된 요청 본문을 검증하는 방법을 살펴보겠습니다. 서버가 다음과 같은 텍스트 데이터와 함께 POST 요청을 수신한다고 가정해 봅니다:

HTTP
POST http://localhost:8080/array
Content-Type: text/plain

-1

데이터를 바이트 배열로 수신하고 검증하려면 다음 단계를 수행하세요:

  1. 서버 측에서 다음과 같이 데이터를 수신합니다:
    kotlin
    post("/array") {
        val body = call.receive<ByteArray>()
        call.respond(String(body))
    }
  2. 수신된 데이터를 검증하기 위해, ValidatorBuilder를 인수로 받아 사용자 정의 검증 규칙을 제공할 수 있는 두 번째 validate 함수 오버로드를 사용합니다:
    kotlin
    install(RequestValidation) {
        validate {
            filter { body ->
                body is ByteArray
            }
            validation { body ->
                check(body is ByteArray)
                val intValue = String(body).toInt()
                if (intValue <= 0)
                    ValidationResult.Invalid("A value should be greater than 0")
                else ValidationResult.Valid
            }
        }
    }