[Spring] 💾 유효성 검사 (@Valid, @Validated, BindingResult)

유효성 검사

---

request 후, 서버 측에서 데이터를 바인딩할 때 데이터가 유효한지 검사하는 것을 말한다.

💡 바인딩 (binding)

사용자 입력을 가지고 커맨드 객체를 생성하는 작업을 스프링에서는 바인딩(binding)한다고 한다.

BindingResult

---

스프링이 제공하는 검증 오류 보관 객체이다. 데이터에 유효하지 않은 속성이 있다면, 그에 대한 오류 정보가 담긴다. 해당 정보를 컨트롤러에 전달해 오류 페이지를 별도로 처리해 줄 수 있다.

🚨 컨트롤러의 파라미터로 사용할 때, 반드시 @Valid 뒤에 위치해야 한다.

@Valid

---

자바 표준 검증 어노테이션이다. 컨트롤러의 메소드에 작성한다. 컨트롤러에서만 동작하기 때문에, 다른 계층에서의 검증이 필요할 때는 @Validated와 결합해야 한다. @Valid에 의한 예외 클래스는 MethodArgumentNotValidException이다.

@Validated

---

스프링에서 제공하는 검증 어노테이션이다. @Validated를 클래스명 위에 작성하고, 유효성을 검증할 메소드에 @Valid를 작성해야 한다. @Validated에 의한 예외 클래스는 ConstraintViolationException이다.

사용 예시

---

다음과 같은 엔티티가 있다.

package com.example.demo.entity;

import java.time.LocalDate;

import javax.validation.constraints.*;

import com.example.demo.entity.*;

import lombok.*;

@Data
@AllArgsConstructor
@Builder
@Accessors(chain=true)
public class Member {
	private String username;
	private String password;
	private String irum;
	private String email;
	private LocalDate birthday;
	private LocalDate joinday;
	private Boolean enabled;
	private String authority;
	private String checkcode;
	private Integer count;
	private Level levels;
	private Integer loginFailCnt;
}

이러한 엔티티에서 아이디(username), 비밀번호, 이름, 이메일만 유효성 검증을 해야 한다고 생각해 보자. 이 상태 그대로 넘기게 되면, 필요하지 않은 필드들은 null 값으로 넘어가게 된다. 이때 필요한 것이 DTO이다.

DTO

package com.example.demo.dto;

import java.time.LocalDate;

import javax.validation.constraints.*;

import com.example.demo.entity.Member;

import lombok.*;

@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class MemberDto {
	@Data
	public static class Join {
		@NotEmpty(message = "아이디는 필수 입력입니다.")
		@Pattern(regexp = "^[A-Z0-9]{8,10}$", message = "아이디는 대문자나 숫자 8-10자입니다.")
		private String username;
		@NotEmpty(message = "비밀번호는 필수 입력입니다.")
		private String password;
		@NotEmpty(message = "이름은 필수 입력입니다.")
		private String irum;
		@NotEmpty(message = "이메일은 필수 입력입니다.")
		private String email;
		// @NotEmpty(message = "생일은 필수 입력입니다.")
		private LocalDate birthday;
		
		public Member toEntity() {
			return Member.builder().username(username).password(password).irum(irum).email(email).birthday(birthday).build();
		}
	}
}

Join 클래스의 각 필드 제약 조건에 따라 유효성 검사를 한다.

Controller

@Validated
@Controller
public class MemberController {
	@Autowired
	private MemberService service;
    
	@PreAuthorize("isAnonymous()")
	@PostMapping("/member/join")
	public String join(@Valid MemberDto.Join dto, BindingResult bindingResult, RedirectAttributes ra) {
		service.join(dto);
		ra.addFlashAttribute("msg", "가입 확인 코드를 이메일로 보냈습니다. 이메일을 확인하세요");
		return "redirect:/member/check_join";
	}
  }

컨트롤러 클래스명 위에 @Validated를 작성하고, 유효성 검증을 할 메소드에 @Valid를 작성했다. 만약 검증 오류가 발생하면, 해당 검증 오류는 ConstraintViolationException으로 bindingResult에 담긴다.

ControllerAdvice

package com.example.demo.controller.advice;

import javax.validation.*;

import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.mvc.support.*;

@ControllerAdvice(basePackages = "com.example.demo.controller.mvc")
public class MyShopAdvice {
	@ExceptionHandler(ConstraintViolationException.class)
	public String constraintViolationException(ConstraintViolationException e, RedirectAttributes ra) {
		ra.addFlashAttribute("msg", e.getMessage());
		return "redirect:/system/error";
	}
}

ConstraintViolationException은 ControllerAdvice에 의해 처리된다.

제약 조건 어노테이션

---

@NotNull: 해당 값이 null이 아닌지 검증함
@NotEmpty: 해당 값이 null이 아니고, 빈 스트링("") 아닌지 검증함(" "은 허용됨)
@NotBlank: 해당 값이 null이 아니고, 공백(""과 " " 모두 포함)이 아닌지 검증함
@AssertTrue: 해당 값이 true인지 검증함
@Size: 해당 값이 주어진 값 사이에 해당하는지 검증함(String, Collection, Map, Array에도 적용 가능)
@Min: 해당 값이 주어진 값보다 작지 않은지 검증함
@Max: 해당 값이 주어진 값보다 크지 않은지 검증함

참고 자료

---

[Spring] @Valid와 @Validated를 이용한 유효성 검증의 동작 원리 및 사용법 예시 - (1/2)