[MVC] Bean Validation - 검증

Bean Validation

기본적은 검증 로직을 공통화하고, 표준화 한 것이 Bean Validation이다.

Bean Validation은 특정한 구현체가 아니라 Bean Validation 2.0이라는 기술 표준이다.

간단하게 말하자면, 검증 애노테이션과 여러 인터페이스의 모음이다. 이러한 Bean Validation을 구현한 기술들 중 일반적으로 우리는 하이버네이트 Validatior를 사용한다. 이름에 하이버네이트가 붙어있지만 ORM과는 관련이 없다.

 

아래는 참고 사이트다

Hibernate Validator 6.2.1.Final - Jakarta Bean Validation Reference Implementation: Reference Guide

 

 

 

---

 

사용

Bean Validation을 사용하려면 다음 의존관계를 추가해야 한다.

 

build.gradle에 추가

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

 

 

아래와 같이 사용할 수 있다.

import org.hibernate.validator.constraints.Range;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;


public record MemberSignUpDto(@NotBlank(message = "아이디를 입력해주세요") @Size(min = 7, max = 25, message = "아이디는 7~25자 내외로 입력해주세요")
                              String username,

                              @NotBlank(message = "비밀번호를 입력해주세요")
                              @Pattern(regexp = "^(?=.*[A-Za-z])(?=.*\\d)(?=.*[@$!%*#?&])[A-Za-z\\d@$!%*#?&]{8,30}$",
                                      message = "비밀번호는 8~30 자리이면서 1개 이상의 알파벳, 숫자, 특수문자를 포함해야합니다.")
                              String password,

                              @NotBlank(message = "이름을 입력해주세요") @Size(min=2, message = "사용자 이름이 너무 짧습니다.")
                              @Pattern(regexp = "^[A-Za-z가-힣]+$", message = "사용자 이름은 한글 또는 알파벳만 입력해주세요.")
                              String name,

                              @NotBlank(message = "닉네임을 입력해주세요.")
                              @Size(min=2, message = "닉네임이 너무 짧습니다.")
                              @NotBlank String nickName,


                              @NotNull(message = "나이를 입력해주세요")
                              @Range(min = 0, max = 150)
                              Integer age) {

}

@RestController
@RequiredArgsConstructor
public class MemberController {

    private final MemberService memberService;

    /**
     * 회원가입
     */
    @PostMapping("/signUp")
    @ResponseStatus(HttpStatus.OK)
    public void signUp(@Valid @RequestBody MemberSignUpDto memberSignUpDto) throws Exception {
        memberService.signUp(memberSignUpDto);
    }
}

 

 

참고로 javax.validation.constrains.NotNull처럼  javax.validation으로 시작한다면, 특정 구현체에 관계없이 기본적으로 제공되는 표준 인터페이스이고, Range처럼 org.hibernate.validator로 시작한다면 하이버네이트 validator 구현체를 사용할 때만 제공되는 검증 기능이다.

 

 

 

 

스프링 MVC에서 사용

스프링 부트는 'spring-boot-starter-validation'라이브러리를 넣으면 자동으로 Bean Validator를 인지하고 스프링에 통합한다.

스프링 부트는 LocalValidatorFactoryBean을 글로벌 Validator로 등록하는데, 이는 @NotNull등과 같은 애노테이션을 보고 검증을 수행한다. 이렇게 글로벌 Validator가 적용되어 있기 때문에 @Valid 혹은 @Validated만 적용하면 된다.

검증 오류가 발생한다면 FieldError 혹은 ObjectError를 생성하여 BindingResult에 등록해준다.

 

참고로 @Valid는 자바 표준 검증 애노테이션이고 @Validated는 스프링 전용 검증 애노테이션이다. 둘 다 모두 동일하게 작동하므로 아무거나 사용해도 되지만 @Validated는 내부에 groups라는 기능을 포함하고 있다. 그러나 groups는 잘 사용하지 않기 때문에, groups 때문에 @Validated를 사용하는 일은 드물 것이다.

 

 

 

 

 

BindException, MethodArgumentNotValidException  

@Valid를 통해 검증을 한 후, 만약 요구사항을 충족하지 못하여 실패한 경우 위의 두 예외를 발생시킨다. 

@ModelAttribute 어노테이션으로 받은 파라미터에서 검증 오류가 발생한 경우 BindException이 발생하고

@RequestBody 어노테이션으로 받은 파라미터에서 검증 오류가 발생한 경우 MethodArgumentNotValidException를 발생시킨다.

 

추가로 MethodArgumentNotValidException 는 BindException을 상속받아 구현되었다.

 

 

 

---

 

에러 코드 내용 설정

Bean Validation은 기본적으로 에러 메시지를 제공하지만, 이를 바꾸고 싶을 수 있을것이다. 

 

Bean Validation을 사용하면 여러 메시지 코드를 생성해주는데 @NotBlank를 예시로 확인해보자.

NotBlank 사용 시 생성되는 에러 코드

정리하면 다음과 같다

 

@NotBlack

• NotBlank.memberSignUpDto.nickName (검증 애노테이션, 오류가 발생한 객체 이름, 필드)
• NotBlank.nickName (검증 애노테이션, 필드)
• NotBlank.java.lang.String (검증 애노테이션, 적용된 타입)
• NotBlank (검증 애노테이션)

다른 검증 애노테이션도 이와 비슷하게 생성된다.

참고로 이와같은 에러 코드는 MessageCodesResolver가 만들어준다.

 

이를 스프링이 제공하는 메시지 기능을 사용하여 바꿀 수 있는 것이다.

 

참고

[MVC] 국제화, 메시지 기능 (+ LocaleResolver)

 

 

 

 

위의 NotBlanck의 메세지를 한번 바꾸어보자.

 

NotBlank.memberSignUpDto.nickName=회원가입 시 별명은 꼭 입력해야 합니다.
NotBlank.nickName=별명은 빈칸일 수 없습니다.
NotBlank.java.lang.String=해당 문자열은 빈칸일 수 없습니다.
NotBlank=빈칸일 수 없습니다.

(더 상세한 것일수록 우선순위가 높게 적용된다.)

 

 

 

 

BeanValidation 메시지 찾는 순서

1. 생성된 메시지 코드 순서대로 messageSource에서 메시지 찾기
2. 애노테이션의 message 속성 사용 (예 : @NotBlank(message = "공백은 안돼용"))
3. 라이브러리가 제공하는 기본 값 사용 -> "공백일 수 없습니다."

 

 

 

 

 

스프링이 직접 만들어준 오류 메시지 처리하기

검증 오류는 개발자가 직접 설정할 수도 있지만, Integer 타입에 String을 넣는 등의 오류는 스프링이 직접 검증 오류에 추가한다.

(주로 타입 정보가 맞지 않을 경우 말생하는 오류)

 

타입이 맞지 않는 경우에는 typeMismatch라는 오류가 발생한다.

다음과 같은 형식이다.

• typeMismatch.item.price
• typeMismatch.price
• typeMismatch.java.lang.Integer
• typeMismatch

위 또한 메시지 소스에 등록하여 처리할 수 있다.

 

 

참고

@RequestBody를 통해 Json을 파싱하는 경우에는 타입이 맞지 않을경우 HttpMessageNotReadableException가 발생하며, 이 경우에는 MessageCodesResolver가 작동하지 않아 에러코드가 생성되지 않는다.

 

 

---

 

여러 필드의 값을 조합하여 검증하는 경우

예를 들어 어떤 상품을 주문할 때, 상품의 가격과 수량이 X원 이상을 넘겨야 하는 경우 이를 어떻게 처리할까?

 

위와 같이 특정 필드가 아닌, 오브젝트에 포함된 여러 필드의 값을 검증하여 발생시키는 오브젝트 오류의 경우 어떻게 처리할 수 있을까?

 

@ScriptAssert를 사용하면 되지만, 사실 이것보다는 그냥 자바 코드를 직접 작성하여 처리하는 것을 권장하며, 그럼에도 알아보고 싶다면 직접 검색해서 찾아보도록 하자.

 

 

 

 

📔 Reference

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

 

Spring Boot Bean Validation 제대로 알고 쓰자