Study/spring

[Java] Spring Boot 3 @Valid 어노테이션 사용 예제

Spring Boot 3 버전에서 @Valid 어노테이션을 사용해서 객체를 검증하는 방법입니다.

ModelAttribute(Param)과 RequestBody 객체 2가지 방식을 예시로 설명하겠습니다.

Valid 사용 전 준비

Valid 사용을 위해 라이브러리를 추가합니다.

# pom.xml
<dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>
</dependencies>

# build.gradle
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-validation'
}

spring-boot-starter-validation 라이브러리를 추가합니다.

어노테이션 사용을 위한 컨트롤러입니다.

우선은 어떠한 제약조건도 걸지 않은 상태입니다.

참고로 Spring Boot 3 버전이기 때문에 jakarta.validation 패키지의 Valid 어노테이션이 사용되었습니다.

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import jakarta.validation.Valid;
import lombok.AllArgsConstructor;
import lombok.Getter;

@RestController
public class ValidController {

    @GetMapping("/valid/param")
    public ValidObject checkParam(@Valid ValidObject object) {
        return object;
    }

    @PostMapping("/valid/body")
    public ValidObject checkRequestBody(@Valid @RequestBody ValidObject object) {
        return object;
    }

    @Getter
    @AllArgsConstructor
    public class ValidObject {
        private String name;
        private Integer number;
    }
}

Param 방식과 RequestBody 방식으로 객체를 받아서 그대로 반환하는 API 2개를 만들었습니다.

@Valid 어노테이션이 객체에 붙어있는데, 이 어노테이션이 없으면 유효성 검사를 하지 않습니다.

Param(ModelAttribute) 방식과 RequestBody 방식일 때 객체를 검증하는 방법에 대해 설명드리겠습니다.

제약 조건 추가

우선 다음과 같은 제약 조건을 추가합니다.

import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.NotBlank;

...

@Getter
@AllArgsConstructor
public static class ValidObject {
    @NotBlank
    private String name;
    @Min(10)
    private Integer number;
}

@NotBlank 제약 조건을 추가했습니다.

@NotBlank 어노테이션이 붙은 변수는 비어있는 경우에 유효성 검사를 통과하지 못합니다.

@Min 어노테이션은 최소값을 정해주는 조건입니다.

최소값을 10으로 설정했기 때문에 변수의 값이 10 미만이면 유효성 검사를 통과하지 못합니다.