[SpringCore] Validation (유효성 검증)

Validation이란 어떤 데이터 (주로 사용자 또는 다른 서버의 request)의 값이 유효한지, 잘못된 내용이 있는지 확인하는 단계를 뜻합니다. 예를들어 이메일 주소의 양식은 "email@email.com"의 양식어어야 하는데, 이 양식과 일치하지 않는 값이 들어온다면 해당 값의 저장을 막을 수 있습니다.

 

Validation을 진행하는 방법은 크게 두 가지로 나눌 수 있습니다.

i) Java Bean Validation (어노테이션 기반)

ii) Spring validator 인터페이스 구현을 통한 validation

 

먼저 Java Bean Validation부터 살펴보겠습니다.

 

Java Bean Validation

스프링 부트에서는 gradle에 의존성 하나만 추가해주면 간단하게 사용할 수 있습니다.

implementation("org.springframework.boot:spring-boot-starter-validation")

JavaBean 기반으로 간편하게 개별 데이터를 검증할 수 있으며, JavaBean내에 어노테이션으로 검증방법을 명시하면 됩니다. 

Validation의 주요 어노테이션

회원가입을 위해 유저 정보를 담는 간단한 JavaBean을 생성하고 Validation을 적용하는 예시를 작성 해보겠습니다.

public class MemberCreationRequest {
	@NotBlank(message="이름을 입력해주세요.")
	@Size(max=50, message="이름의 최대 길이는 50자 입니다.")
    	private String name;
	@Min(0, "나이는 0보다 커야 합니다.")
    	private int age;
	@Email("이메일 형식이 잘못되었습니다.")
    	private int email;
   // getter와 setter 생략
}

위처럼 DTO에 어노테이션으로 명시한 후 RequestBody에 @Valid 어노테이션을 달면 유효성 검증을 수행한 후 검증이 통과되었을 때에만 메서드 내부로 진입할 수 있습니다. 검증이 실패한다면 MethodArgumentNotValidException을 Throw합니다.

@PostMapping(value = "/member")
public MemeberCreationResponse createMember(
	@Valid @RequestBody MemeberCreationRequest memeberCreationRequest) {
	// 맴버 생성 로직 생략
}

1차적으로는 Java Bean Validation을 사용해서 DTO단에서 데이터를 간단하게 검증 하고나서, 로직으로 넘어왔을 때 2차적으로 권한, 서비스 정책, 경우에 따라서는 외부 API호출이나 DB 조회를 통한 데이터 검증을 실시하고 검증 실패시에는 Custom Exception으로 예외를 던지고 이를 처리하는 방식으로 검증을 진행하면 좀 더 확실한 Validation이 가능합니다.

Spring Validator 인터페이스 구현

유효성 검사를 수행하는 또다른 방법은 Validator 인터페이스를 구현하는 클래스를 생성하고 이를 스프링 빈으로 등록하는 방법입니다.

이 방법을 사용하면 Java Bean Validation에 비해서 조금 더 복잡한 로직을 갖는 유효성 검증이 가능하지만, Validation을 수행하는 클래스를 따로 정의하기 때문에 상대적으로 코드를 찾기 어렵고, 여러 군데 흩어져 있으면 테스트 및 유지보수가 어렵다는 단점이 있습니다.

@Component
public class PersonValidator implements Validator {
    public boolean supports(Class clazz) { // Validator를 동작시킬 조건
        return Person.class.equals(clazz);
    }
public void validate(Object obj, Errors e) { // 조건이 맞을 때 동작하게 될 Validation의 내용
        ValidationUtils.rejectIfEmpty(e, "name", "name.empty");
        Person p = (Person) obj;
        if (p.getAge() < 0) {
            e.rejectValue("age", "negativevalue");
        } else if (p.getAge() > 110) {
            e.rejectValue("age", "too.darn.old");
        }
    }
}

위에 정의된 Validator는 Person이라는 javaBean이 등록되어 있을 때, 해당 인스턴스에서만 활용되는 Validator입니다.

supports 메서드는 이 validator가 동작할 조건을 정의하며(주로 class 타입을 비교합니다.)

validate 메서드에서 원하는 검증을 진행하면 됩니다.