[Validation] spring boot validation 사용법과 종류

Validation

Spring Boot에서는 Validation을 통해 클라이언트에서 요청시 전송한 데이터의 유효성을 검증하기 위한 기능들을 제공한다.

 

왜 Validation을 사용할까

• 주로 Controller에서 클라이언트로 부터 전송된 데이터의 유효성을 검증함
• 유효성 검증 코드를 직접 구현할 수 있으나, request시 들어오는 모든 데이터에 대한 검증 코드로 인해 코드의 양이 많아 질 수 있으며 서비스 로직에 방해될 수 있음
• 요청 항목이 많아질 수록 검증 과정이 길어짐
• 여러명의 개발자가 검증 로직을 개발하는 경우 일관성이 없어질 수 있음
• Validation을 사용하면 검증 로직을 일관성 있게 구현할 수 잇음
• Validation을 사용해서 검증 로직을 단순화 시킬 수 있음

 

라이브러리 의존성 추가

implementation 'org.springframework.boot:spring-boot-starter-validation'

 

Spring Boot에서 기본적으로 제공하는 라이브러리. 입력 값 검증을 위한 의존성들이 포함되어 있다. 

Validation 종류

어노테이션	설명	특징
@Size	문자열 길이 검증	int 타입에서 사용 불가
@NotNull	null 불가
@NotEmpty	null, ""(빈 문자열) 불가
@NotBlank	null, ""(빈 문자열), " "(공백 문자열) 불가
@Pattern	정규식 검증
@Max	최대값
@Min	최소값
@Past	과거 날짜인지 검증	Date 타입에서 사용. request 전송시 "yyyy-MM-dd" 형식으로 사용

 

https://jakarta.ee/specifications/bean-validation/3.0/jakarta-bean-validation-spec-3.0.html#builtinconstraints

Jakarta Bean Validation specification

• Validation에서 제공하는 어노테이션 스펙은 jakarta 문서에서 확인 가능
• Built-In Constraint definitions 섹션 확인

 

예시코드

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
@JsonNaming(value = PropertyNamingStrategies.SnakeCaseStrategy.class)
public class UserRegisterRequest {
    @NotBlank(message = "username은 빈 값이 될 수 없습니다.")
    @Size(min = 4, max = 10, message = "username은 4~10자리여야 합니다.")
    private String username;

    private String password;

    @Min(value = 19, message = "age는 19살 이상 부터 가능합니다.")
    private Integer age;

    @Past(message = "생년월일은 과거의 날짜여야 합니다.")
    private Date birth;

    @Pattern(regexp = "^01([0|1|6|7|8|9])-?([0-9]{3,4})-?([0-9]{4})$", message = "유효한 휴대폰 형식이 아닙니다.")
    private String phoneNumber;

    public User toEntity() {
        return User.builder()
                .username(username)
                .password(password)
                .role(Role.MEMBER)
                .build();
    }
}

 

• request 데이터에 대한 데이터의 유효성을 검증하므로 주로 entity가 아닌 dto에 validation annotation을 추가

 

RequestBody

    @PostMapping
    public  String register(@Valid @RequestBody UserRegisterRequest request) {
        log.info("init : {}", request);
        return request.toString();
    }

 

• @Valid 어노테이션을 사용해서 유효성을 검증

RequestParam

@RestController
@RequiredArgsConstructor
@RequestMapping("api/v1/user")
@Validated // 경우에 따라 생략 가능
class UserApiController {
		@GetMapping(path = "/book")
        public String queryParam(
            @RequestParam("category") @Size(min = 2) String category,
            @RequestParam("issued-day") @Past  @DateTimeFormat(pattern = "yyyy-MM-dd") Date issuedDay
        ) {
            return category + " " + issuedDay;
        }
}

 

http://localhost:8080/api/book?category=fiction&issued-day=2020-01-01

 

PathVariable

 

@RestController
@RequiredArgsConstructor
@RequestMapping("api/v1/user")
@Validated // 경우에 따라 생략 가능
class UserApiController {
        @GetMapping(path = "/book/{category}/{issued-day}")
        public String queryParam(
            @PathVariable("category") @Size(min = 2) String category,
            @PathVariable("issued-day") @Past @DateTimeFormat(pattern = "yyyy-MM-dd") Date issuedDay
        ) {
            return category + " " + issuedDay;
        }
}

 

http://localhost:8080/api/book/fiction/2020-01-01

 

기존에는 RequestParam, PathVariable 사용시 @Validated 애노테이션을 사용해야 했으나 스프링부트 3.2에서 애노테이션이 없어도 자동으로 인식하도록 업데이트 됨 (아래 참고 사이트 참고)

 

 

참고 사이트

https://mangkyu.tistory.com/379

[SpringBoot] 스프링 부트3.2(SpringBoot3.2)에 추가된 유효성 검사 기능(MethodValidator) 파헤치기