🎯 목표 : Spring MVC에서의 예외 처리 학습

📒 Spring MVC 예외 처리

• Controller 레벨에서의 처리 = @ExceptionHandler
• Global 예외 처리 = @ControllerAdvice & @RestControllerAdvice
• REST API에 대한 예외처리만 다룰 예정이며, view에 관련되거나 Json 맵핑에 관련된 내용은 나중에 따로 정리하겠다.

---

📌 Controller 단 에서의 예외처리

• Controller의 메소드에서 던져진 예외에 대한 공통적인 처리를 할수있도록 지원해주는 @ExceptionHandler 어노테이션이 있다.

예제 코드

@RestController
@RequestMapping("/members")
public class MemberController {
    private final MemberService memberService;
    private final MemberMapper mapper;

    public MemberController(MemberService memberService, MemberMapper mapper) {
        this.memberService = memberService;
        this.mapper = mapper;
    }

    @PostMapping
    public ResponseEntity postMember(@Valid @RequestBody MemberPostDto memberDto) {
      Member member = mapper.memberPostDtoToMember(memberDto);

      Member response = memberService.createMember(member);

      return new ResponseEntity<>(mapper.memberToMemberResponseDto(response),
        HttpStatus.CREATED);
    }

    @ExceptionHandler
    public ResponseEntity handlerException(MethodArgumentNotValidException e) {
      final List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
      List<ErrorResponse.FieldError> errors =
                        fieldErrors.stream()
                              .map(error -> ErrorResponse.FieldError.builder()
                                            .field(error.getField())
                                            .rejectedValue(error.getRejectedValue())
                                            .reason(error.getDefaultMessage())
                                            .build())
                              .collect(Collectors.toList());

      return new ResponseEntity<>(ErrorResponse.of(errors), HttpStatus.BAD_REQUEST);
    }

}

• 위 예제에서 Member 데이터 수집 과정에서 유효성 검증에 실패 했을때의 예외처리 상황을 예시로 들었다.
  • RequestBody에 유효하지 않은 요청 데이터가 포함 되어 있을때 유효성 검증에 실패하게 되면 MethodArgumentNotValidException이 발생한다.
  • 해당 예외가 발생 했을때 FieldError 객체들을 받아 별도 클래스로 정의한 응답 객체로 필요한 데이터만 뽑아 Response Body로 전달하고 있다.
  • @ExceptionHandler는 속해있는 클래스 내부의 예외에 대해서만 처리할수 있는 Local 범위를 가지고 있다.
  • 만약, 다른 컨트롤러에서 동일한 예외를 처리해야 한다면, 컨트롤러 마다 중복 코드가 발생하고 유지 보수도 어려워 질 것이다.

---

📌 전역 예외 처리

• @ExceptionHandler Local 예외 처리의 단점을 극복하기 위해 Spring 에서는 어플리케이션 전역으로 @ExceptionHandler를 사용할수 있게 지원해준다.
  • @ControllerAdvice 와 @RestControllerAdvice가 전역 예외 처리를 지원해주는 어노테이션이다.
  • @ControllerAdvice는 예외 처리후 에러 View 등을 통하여 처리 할수 있게 해준다.
  • @RestControllerAdvice는 REST API에 대한 예외 처리를 편리하게 지원해주며, @ResponseBody를 내장하고 있어 응답 데이터 포맷에 용이하다.
  • @RestControllerAdvice = @ControllerAdvice + @ResponseBody
  • @ControllerAdvice의 예외 처리 범위는 Dispatcher Servlet 내부에서 이루어 진다.

예제 코드

// MemberController.java
@RestController
@RequestMapping("/members")
public class MemberController {
    private final MemberService memberService;
    private final MemberMapper mapper;

    public MemberController(MemberService memberService, MemberMapper mapper) {
        this.memberService = memberService;
        this.mapper = mapper;
    }

    @PostMapping
    public ResponseEntity postMember(@Valid @RequestBody MemberPostDto memberDto) {
      Member member = mapper.memberPostDtoToMember(memberDto);

      Member response = memberService.createMember(member);

      return new ResponseEntity<>(mapper.memberToMemberResponseDto(response),
        HttpStatus.CREATED);
    }
}

// GlobalExceptionAdvice.java
@RestControllerAdvice
public class GlobalExceptionAdvice {

    @ExceptionHandler
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ErrorResponse handleMethodArgumentNotValidException(
            MethodArgumentNotValidException e
    ) {
        ErrorResponse response = ErrorResponse.of(e.getBindingResult());
        return response;
    }
}

// ErrorResponse.java
@Getter
public class ErrorResponse {

    private List<FieldError> fieldErrors;

    private List<ConstraintViolationError> violationErrors;

    private ErrorResponse(final List<FieldError> fieldErrors,
                          final List<ConstraintViolationError> violationErrors) {
      this.fieldErrors = fieldErrors;
      this.violationErrors = violationErrors;
    }
    public static ErrorResponse of(BindingResult bindingResult) {
      return new ErrorResponse(FieldError.of(bindingResult), null);
    }

    @Getter
    @Builder
    public static class FieldError {
      private String field;
      private Object rejectedValue;
      private String reason;

      private FieldError(String field, Object rejectedValue, String reason) {
        this.field = field;
        this.rejectedValue = rejectedValue;
        this.reason = reason;
      }

        public static List<FieldError> of(BindingResult bindingResult) {
            final List<org.springframework.validation.FieldError> fieldErrors =
                                          bindingResult.getFieldErrors();
            return fieldErrors.stream()
                        .map(error -> ErrorResponse.FieldError.builder()
                                .field(error.getField())
                                .rejectedValue(error.getRejectedValue())
                                .reason(error.getDefaultMessage())
                                .build())
                        .collect(Collectors.toList());
        }
      }
}

• GlobalExceptionAdvice.java를 정의하여 모든 Controller 에서 발생하는 예외를 공통적으로 처리할수 있도록 하였다.
• GlobalExceptionAdvice.java에서 handleMethodArgumentNotValidException메소드에 ErrorResponse를 반환하게 하여 코드를 조금더 간결해졌다.
  • @RestControllerAdvice에서 지원해주는 @ResponseBody기능으로 특별한 맵핑 없이 JSON 타입의 데이터로 응답을 할수 있게 하였다.
  • @ResponseStatus(HttpStatus.BAD_REQUEST)를 지정 해 줌으로서 HTTP 상태코드까지 응답 메세지에 보내 줄 수 있다.
• GlobalExceptionAdvice.java에서 에러 데이터를 가지고 필요한 데이터를 추출하고 가공하는 역할을 ErrorResponse.java에 위임 하였으며 생성자를 private처리 함으로서 of 메소드를 통해서만 응답 객체를 생성할수 있게 하였다.
• ErrorResponse.java 내부에서는 파라미터로 전달 받은 BindingResult 데이터에서 필요한 데이터만 추출하고 가공하는 역할을 내부 static 클래스 FieldError에 위임하여 모든 클래스 들의 역할과 책임을 명확히 해 주었다.

---

Reference

https://www.digitalocean.com/community/tutorials/spring-mvc-exception-handling-controlleradvice-exceptionhandler-handlerexceptionresolver

https://spring.io/blog/2013/11/01/exception-handling-in-spring-mvc

https://jaehun2841.github.io/2018/08/30/2018-08-25-spring-mvc-handle-exception/#HandlerExceptionResolver%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%9C-%EC%B2%98%EB%A6%AC