[Spring] 제약 조건, @Valid로 간단하게 검증해보자.

 

 

요청 데이터가 도착하면
무결성을 검증해야한다.
이때 @Valid를 사용해서
간단하게 검증해보자.

 

 

 

1. @Valid

• 객체의 데이터가 유효한지 검사할 때 사용하는 어노테이션이다.
• 클라이언트로부터 받은 요청 데이터(DTO)의 무결성을 검증할때 필수적으로 사용한다.
• 컨트롤러의 메서드 파라미터에 붙이면 해당 객체의 필드에 설정된 제약 조건을 검증한다.
• @NotNull, @Size 등의 제약 어노테이션과 함께 사용하며 서비스 계층까지 잘못된 데이터가 전달되는 것을 사전에 차단하여 계층적 방어를 구현한다.

 

 

---

 

 

 

2. @Valid 예시 코드

• @Valid X
  이름은 필수, 나이는 0보다 커야한다.

@PostMapping("/user")
public void createUser(@RequestBody UserDto user) {

    // if문으로 각 데이터가 들어왔는지
    // 데이터가 잘 맞게 들어왔는지 직접 확인해야한다.
    
    if (user.getName() == null || user.getName().isEmpty()) {
        throw new IllegalArgumentException("이름은 필수입니다.");
    }
    if (user.getAge() <= 0) {
        throw new IllegalArgumentException("나이는 0보다 커야 합니다.");
    }
    userService.save(user);
}

이렇게 작성하면 안좋은 점이 다른 메서드에서 이름과 나이가 필요하다면 그 안에 또 검증 로직을 작성해야한다. 이렇게되면 검증 로직이 비즈니스 로직가 섞이고 나중에 코드를 수정할때 무척 힘들어진다.

 

• @Valid O
  이름은 필수, 나이는 0보다 커야한다
  

public class UserDto {

    @NotEmpty(message = "이름은 필수입니다.")
    private String name;

    @Min(value = 1, message = "나이는 1보다 커야 합니다.")
    private int age;
    
}

바로 @Valid를 컨트롤러에 붙이는게 아니다. 먼저 DTO 파일에 내가 제약해야할 조건을 어노테이션을 붙인다. name에 @NotEmpty로 공백이 들어오지 못하도록 했다. 그리고 age는 @Min을 1로 설정해서 최소값을 1, 그니까 0이 들어올 수 없도록 했다.

 

@PostMapping("/user")
public void createUser(@Valid @RequestBody UserDto user) {
    // 검증 통과 시에만 여기까지 코드가 실행됨
    userService.save(user);
}

컨트롤러 클래스다. 간단하게 파라미터에 @Valid를 붙이면 끝난다. 해당 메서드가 호출될 때 Spring이 요청으로 들어온 DTO 내부 필드들을 자동으로 검증한다. 만약 DTO에 정의된 제약 조건을 어기면 예외를 발생시켜 비즈니스 로직이 실행되지 않도록 차단한다.