Spring / BindException 예외 처리 및 사용법 (@RestControllerAdvice, @Valid)

@RestControllerAdvice
@Log4j2
public class CustomRestAdvice {
    
    @ExceptionHandler(BindException.class) // BindException이 발생했을때 이 메서드를 호출시켜준다.
    @ResponseStatus(HttpStatus.EXPECTATION_FAILED) //417 실패 페이지를 반환해준다.
    public ResponseEntity<Map<String, String>> handleBindException(BindException e){
        
        log.error(e);
 
        Map<String, String> errorMap = new HashMap<>();
 
        if(e.hasErrors()){
            BindingResult bindingResult = e.getBindingResult();
 
            bindingResult.getFieldErrors().forEach(fieldError -> {
                errorMap.put(fieldError.getField(), fieldError.getCode());
            });
        }
 
        return ResponseEntity.badRequest().body(errorMap);
    }
 
}
 
// 전체적인 설명은 예외처리 클래스를 선언하는 부분이다.
// DTO 매핑이 실패했을때 발생하고, 이 메서드에서 예외에 대한 JSON 응답 메시지를 생성해서 반환해준다.
 
 
// DTO 선언부 !!!
 
@Data
public class ReplyDTO {
 
    @NotBlank
    private String text;
 
    @Size(min = 3, max = 10)
    private String writer;
}
 
// 컨트롤러 선언부 !!!
 
 
@RestController
@RequestMapping("/replies")
public class ReplyController {
    
    // /경로로 진입시 실행, 받는 데이터는 JSON으로 수동 설정
    // 매개변수에 있는 bindingResult가 폼 데이터 검증 오류를 담음
    @PostMapping(value = "/", consumes = MediaType.APPLICATION_JSON_VALUE) 
    public ResponseEntity<String> register(@Valid @RequestBody ReplyDTO replyDTO,
                                           BindingResult bindingResult)throw BindException{
        if(bindingResult.hasErrors()){
            throw new BindingException(bindingResult);
        }
 
        return ResponseEntity.ok("등록 성공: " + replyDTO);
    }
}
 
 
 

 

 

@Valid의 역할

 

- DTO나 폼 객체에 붙인 검증 애노테이션(@NotNull, @NotEmpty, @Size 등)을 실제로 검사하게 한다.

 

- 검증 결과가 실패하면 BindingResult 또는 예외(MethodArgumentNotValidException, BindException) 등

  오류를 반환한다.

 

- 컨트롤러에서 검증하려고 하는 DTO 앞에 @Valid가 없으면 DTO의 애노테이션 검증이 무시되고,

  빈값이나 잘못된 값이 그대로 넘어간다.

 

@RestControllerAdvice의 역할

 

- 특정 컨트롤러가 아닌 모든 컨트롤러에서 발생한 예외를 잡을 수 있다.

 

- JSON 반환이 기본이므로 REST API 응답에 적합하다.

 

- 주로 @ExceptionHandler와 함께 사용된다.

 

- 전역 예외 클래스 만드는데 사용된다.

 

@ExceptionHandler의 역할

 

- 특정 예외 타입을 지정하면, 그 예외가 발생했을 때만 실행된다.