[Spring] @Valid, @ControllerAdvice, @Exception을 이용한 데이터 검증 및 처리

서론

보통 @ControllerAdvice와 @ExceptionHandler를 이용하여 예외처리를 분리 및 통합하여 처리합니다. 이때 @Valid 어노테이션을 이용하여 데이터를 검증하고, 해당 데이터에 에러가 있을 경우 필드에 적용했던 예외 메시지만 깔끔하게 가져오는 방법이 궁금했습니다. 다시 말해

public class User {

    private String name;
    @Min(value = 19, message = "나이는 19살 이상이어야 합니다.")
    private int age;
    
}

위와 같은 Entitiy일 때 나이를 10살로 하고 Post를 하였을 때 아래 이미지의 첫 번째 결과가 아니라 두 번째 결과처럼 details 부분에서 default message인 "나이는 19살 이상이어야 합니다."만 반환하고 싶었습니다.

첫 번째 결과

두 번째 결과

즉, MethodArgumentNotValidException ex 에서 default message를 가져오는 방법이 궁금했습니다.
해당 방법에 대해 결론부터 말씀드리자면 현재 ex.getMessage()를 통해 error 메시지를 가져오는데 아래와 같은 방법으로 defaultMessage만 파싱 할 수 있습니다.
ex.getBindingResult().getAllErrors().get(0).getDefaultMessage()
하지만 내용이 부실할 것 같아 위 내용을 포함하여 @Valid를 이용한 간단한 검증 방법과 @ControllerAdvice와 @ExceptionHandler를 이용하여 통합된 json 반환 방법에 대해 작성해 보겠습니다.
 

본론

public class User {

    private String name;
    @Min(value = 19, message = "나이는 19살 이상이어야 합니다.")
    private int age;
    
}

먼저 Entity 클래스는 위와 같습니다. 검증할 필드에 Annotation을 추가하면 되는데, 현재 위 코드는 나이가 19살 이상이어야만 한다는 조건을 주었습니다.

@RestController
public class UserController {

    @PostMapping("/users")
    public ResponseEntity<User> createUsers(@Valid @RequestBody User user) {
        return ResponseEntity.ok(user);
    }

    @GetMapping("/users/{id}")
    public ResponseEntity<Integer> getUsers(@PathVariable int id) {
        if (id != 1) {
            throw new UserNotFoundException(String.format("아이디 %d을 가진 유저가 존재하지 않습니다.", id));
        }
        return ResponseEntity.ok(id);
        
    }

Controller 클래스는 위와 같습니다. POST 메서드에서 User의 필드를 검증하기 위해 매개변수에 @Valid 어노테이션을 붙여주었습니다. 
또한 간단하게 GET 메서드에서는  id의 값이 1이 아닐 경우에 예외를 던지도록 만들었습니다.

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ExceptionResponse {
    private LocalDateTime time;
    private Boolean isSuccess;
    private String message;
    private String details;
}

예외가 발생했을 경우의 통합적으로  json형태로 만들어 Response는 위와 같습니다.

@ResponseStatus(HttpStatus.NOT_FOUND)
public class UserNotFoundException extends RuntimeException{
    public UserNotFoundException() {
        super();
    }

    public UserNotFoundException(String message) {
        super(message);
    }

    public UserNotFoundException(String message, Throwable cause) {
        super(message, cause);
    }

    public UserNotFoundException(Throwable cause) {
        super(cause);
    }

    protected UserNotFoundException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
        super(message, cause, enableSuppression, writableStackTrace);
    }
}

해당 유저를 찾을 수 없는 경우 에러를 예외를 발생시키기로 하였기에, UserNotFoundException.class는 위와 같이 기초적인 메서드를 overide 했습니다.

@RestControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        ExceptionResponse exceptionResponse = new ExceptionResponse(LocalDateTime.now(), false, "유효성 검증에 실패했습니다.", ex.getBindingResult().getAllErrors().get(0).getDefaultMessage());
        
        return new ResponseEntity<>(exceptionResponse, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(UserNotFoundException.class)
    public final ResponseEntity<Object> handlerNotFoundUserException(Exception ex) {
        ExceptionResponse exceptionResponse = new ExceptionResponse(LocalDateTime.now(), false, "유저를 찾을 수 없습니다.", ex.getMessage());
        
        return new ResponseEntity<>(exceptionResponse, HttpStatus.NOT_FOUND);
    }

}

@ControllerAdvice입니다. 

• 첫 번째 메서드는 @Valid 검증에서 에러가 발생했을 시 데이터를 처리하는 메서드입니다.
• 두 번째 메서드는UserNotFoundException를 발생시켰을 때 처리되는 메서드입니다.

 

결과

POST 메서드

GET 메서드

 

참고

• https://medium.com/chequer/spring-methodargumentnotvalidexception-valid-%EC%98%88%EC%99%B8%EC%B2%98%EB%A6%AC-2f63e8087759