1. @Valid 어노테이션
스프링부트 RestController를 이용해 @RequestBody 객체를 사용자로부터 가져올 때, 들어오는 값을 검증할 수 있다.
@Valid는 JSR-303 표준 스펙으로써 빈 검증기(Bean Validator)를 이용해 객체의 제약 조건을 검증하도록 지시하는 어노테이션이다. 이 @Valid를 이용하면 service 단이 아닌 객체 안에서 들어오는 값에 대해 검증을 할 수 있다.
특징은 객체의 필드에 달린 어노테이션으로 편리하게 검증을 한다는 것이다. SpringBoot에서 이를 사용하려면 아래의 의존성만 추가해주면 된다.
implementation group: 'org.springframework.boot', name: 'spring-boot-starter-validation'
2. @Valid시 발생하는 Exception Handling
@ControllerAdvice
@Valid로 requestBody로 들어온 객체의 검증 시 BadRequest가 나가는 경우 custom한 errorhandling도 할 수 있다.
잘못된 객체 값이 나갔을 때 스프링부트 로그를 확인해서..
@ControllerAdvice로 전역 에러 핸들링 혹은 @Controller 단에서의 지역 에러 핸들링을 사용하면 된다.
3. @Valid의 동작 원리
모든 요청은 프론트 컨트롤러인 디스패처 서블릿을 통해 컨트롤러로 전달된다.
전달 과정에서는 컨트롤러 메소드의 객체를 만들어주는 ArgumentResolver가 동작하는데,
@Valid 역시 ArgumentResolver에 의해 처리가 된다.
대표적으로 @RequestBody는 Json 메세지를 객체로 변환해주는 작업이 ArgumentResolver의 구현체인 RequestResponseBodyMethodProcessor가 처리하며, 이 내부에서 @Valid로 시작하는 어노테이션이 있을 경우에 유효성 검사를 진행한다. ( @Valid가 아니라 커스컴 어노테이션인 @ValidMMinji 여도 동작한다.)
만약 @ModelAttribute를 사용중이라면 ModelAttributeMethodProcessor에 의해 @Valid가 처리된다.
그리고 검증에 오류가 있다면 MethodArgumentNotValidException 예외가 발생하게 되고, 디스패처 서블릿에 기본으로 등록된 예외 리졸버(Exception Resolver)인 DefaultHandlerExceptionResolver에 의해 400 BadRequest 에러가 발생한다.
org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public org.springframework.http.ResponseEntity<java.lang.Void> com.example.testing.validator.UserController.addUser(com.example.testing.validator.AddUserRequest) with 2 errors: [Field error in object 'addUserRequest' on field 'email': rejected value [asdfad]; codes [Email.addUserRequest.email,Email.email,Email.java.lang.String,Email]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [addUserRequest.email,email]; arguments []; default message [email],[Ljavax.validation.constraints.Pattern$Flag;@18c5ad90,.*]; default message [올바른 형식의 이메일 주소여야 합니다]] [Field error in object 'addUserRequest' on field 'age': rejected value [5]; codes [Min.addUserRequest.age,Min.age,Min.int,Min]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [addUserRequest.age,age]; arguments []; default message [age],12]; default message [12 이상이어야 합니다]]
at org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.resolveArgument(RequestResponseBodyMethodProcessor.java:141) ~[spring-webmvc-5.3.15.jar:5.3.15]
at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:122) ~[spring-web-5.3.15.jar:5.3.15]
이한 이유로 @Valid는 기본적으로 컨트롤러에서만 동작하며 기본적으로 다른 계층에서는 검증이 되지 않는다.
다른 계층에서 파라미터를 검증하기 위해서는 @Validated와 결합되어야 한다.
4. 문자열 유무 검증
@NotBlank, @NotEmpty, @NotNull의 차이점
@NotBlank
- null 이 아닌 값.
- 공백이 아닌 문자를 하나 이상 포함.
@NotEmpty
- Type : CharSequence (length of character) Collection (collection size) Map (map size Array (array length)
- null 이거나 empty(빈 문자열)가 아니어야 한다.
@NotNull
- Type : 어떤 타입이든 수용.
- null 이 아닌 값.
@Null
- Type :어떤 타입이든 수용한다.
- null 값.
@NotNull : 반드시 값이 있어야 한다.
@NotEmpty : 반드시 값이 존재하고 길이 혹은 크기가 0보다 커야한다.
@NotBlank : 반드시 값이 존재하고 공백 문자를 제외한 길이가 0보다 커야 한다. (가장 강력)
|
null |
"" |
" " | |
|
@NotNull |
Invalid |
Valid |
Valid |
|
@NotEmpty |
Invalid |
Invalid |
Valid |
|
@NotBlank |
Invalid |
Invalid |
Invalid |
이외에도 정규식을 검증하는 @Pattern
크기를 검증하는 @Size
Boolean 값을 검증하는 @AssertTrue 등이 있다.
(@NotBlank, @NotEmpty, @NotNull의 차이점은 볼때마다 헷갈려서 정리함..)
참고:
https://www.baeldung.com/spring-boot-bean-validation
https://www.baeldung.com/java-bean-validation-not-null-empty-blank
![[Spring Boot] @Valid 동작 원리와 @NotBlank·@NotEmpty·@NotNull의 차이](/posts/spring-boot-valid-notblank-notempty-notnull/images/image_1.jpg)