스프링 MVC 2 - 정리(API 예외 처리)

정리(API 예외 처리)

 

• 시작
  • HTML 페이지의 경우 지금까지 설명했던 것 처럼 4xx, 5xx와 같은 오류 페이지만 있으면 대부분의 문제를 해결할 수 있다.
  • 그러나 API의 경우에는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.
• 스프링 부트 기본 오류 처리
  • BasicErrorController 에서 MediaType이 TEXT_HTML_VALUE인 경우에는 HTML을 내려주지만,
    그게 아닌 경우에는 ResponseEntity로 JSON API 데이터를 내려준다.
  • HTML 페이지의 경우 4xx, 5xx 등만 하면 되기 때문에 BasicErrorController를 이용하면 되는데
    API 오류는 굉장히 디테일하게 해결해야하기 때문에 BasicErrorController만 가지고 해결하기 굉장히 어렵다.
• HandlerExceptionResolver 시작
  • 스프링이 예외를 처리하기위한 매커니즘을 제공한다.
  • 컨트롤러 밖으로 던져진 예외를 해결하고 동작방식을 변경하고 싶으면 HandlerExceptionResolver를 사용하면 된다.
  • HandlerExceptionResolver는 ModelAndView를 반환해야 한다. null 기준으로 작동된다.
  • HandlerExceptionResolver 활용
    • 예외 상태 코드 변환
      • response.sendError(xxx) 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임
      • 이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 예를 들어서 스프링 부트가 기본으로 설정한 '/error'가 호출됨
    • 뷰 템플릿 처리
      • ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 랜더링 해서 고객에게 제공
    • API 응답 처리
      • response.getWriter().println("hello"); 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다.
        여기에 JSON으로 응답하면 API 응답 처리를 할 수 있다.
• HandlerExceptionResolver 활용
  • UserException을 만들어보았는데, 목적은, 예외를 서블릿까지 던지는게 아니고(sendError) 이곳에서 다끝내자는 것이 목적이었다.
    상태코드도 setStatus로 지정하고, response의 JSON도 ObjectMapper로 바꾸고, reponse.getWriter()로 적어주는 등의 처리를 해서 이곳에서 다 끝을 내버렸다.
  • 코드는 깔끔하지 않지만, 처리 자체는 깔끔하게 할 수 있긴하다.
• 스프링이 제공하는 ExceptionResolver1
  • 스프링은 기본적으로 API 예외처리를 제공하는데 
    • ExceptionHandlerExceptionResolver
    • ResponseStatusExceptionResolver
    • DefaultHandlerExceptionResolver 를 제공하고,  → 우선순위가 가장 낫다.
  • ResponseStatusExceptionResolver는 @ResponseStatus가 달려있는 예외를 읽어서 sendError를 호출해서 처리해주는 것이고, @ResponseStatus를 사용하기 어려운 곳에는 ResponseStatusException을 사용할 수 있는데, ResponseStatusException 예외를 처리해준다.
  • ResponseStatusException의 파라미터에는 (HTTP Status, HTTP response Message, ResponseStatusException을 발생시킨 Exception) 을 넣어줄 수 있다. 
• 스프링이 제공하는 ExceptionResolver2
  • DefaultHandlerException은,  TypeMismatchExceptionr같이 스프링 내부에서 발생한 오류이나, 클라이언트가 잘못 보냈을 확률이 높은 오류들을 그대로 서블릿까지 보내버리면 서블릿 컨테이너는 서버내부에 문제가 있다고 생각하고 상태코드를 500으로 가져간다. 이러한 경우 스프링이 제공하는 DefaultHandlerException을 이용하면, 이러한 예외를 다 잡아서 우리가 지정한 상태코드로 sendError를 이용해서 바꿔서 처리해준다.
• @ExceptionHandler
  • HTML화면 오류 vs API 오류
    • 웹 브라우저에 HTML 화면을 제공할 때는 오류가 발생하면 BasicErrorController를 사용하는게 편하다. 이때는 단순히 5xx, 4xx 관련된 오류 화면을 보여주면 된다. BasicErrorController는 이런 매커니즘을 모두 구현해두었다.
    • 그러나, API는 각 시스템 마다 응답의 모양도 다르고, 스펙도 모두 다르다. 예외 상황에 단순히 오류 화면을 보여주는 것이 아니라, 예외에 따라서 각각 다른 데이터를 출력해야 할 수도 있고, 그리고 같은 예외라고 해도 어떤 컨트롤러에서 발생했는가에 따라서 다른 예외 응답을 내려주어야 할 수 있다. 즉, 매우 세밀한 제어가 필요하다. 상품API와 주문API는 오류가 발생했을 때 응답의 모양이 완전히 다를 수 있다. 
    • 결국 지금까지 살펴본 BasicErrorController 를 사용하거나 HandlerExceptionResolver를 직접 구현하는 방식으로 API예외를 다루기는 쉽지 않다.
  • 그래서 궁극의 @ExceptionHandler 라는 것이 개발되었다. 
  • 컨트롤러 안에서 @ExceptionHandler 를 사용하면 이 컨트롤러에서 발생하는 예외는 ExceptionHandlerExceptionResovler가 잡아서 해결해준다. 참고로, 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다. 우선순위는 항상 자세한 것이 우선권을 가진다.
  • 다양한 예외도 한번에 처리할 수 있다. 파라미터에 추가하면 된다.
  • @ExceptionHandler에 지정하는 예외도 생략할 수 있는데, 생략하면 메서드 파라미터의 예외가 지정된다.
  • @ExceptionHandler에는 마치 스프링 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.
  • 자세한 파라미터와 응답은 공식 메뉴얼 참고(https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-exceptionhandler-args)
• @ControllerAdvice
  • @ExceptionHandler를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있다. 
  • @ControllerAdvice 또는 @RestControllerAdvice를 사용하면 둘을 분리할 수 있다.
  • @ControllerAdvice는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler, @InitBinder 기능을 부여해주는 역할을 한다.
  • @ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다. (글로벌 적용)
  • @RestControllerAdvice는 @ControllerAdvice와 같고, @ResponseBody가 추가되어 있다.
    @Controller, @RestController의 차이와 같다.
  • 대상 컨트롤러 지정 방법
    • @ControllerAdvice(annotations = RestController.class) - 애노테이션에 따라 지정하는 방법
    • @ControllerAdvice(org.example.controllers) - 패키지로 지정하는 방법
    • @ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class}) - 특정 컨트롤러 이름을 직접 지정하거나, 컨트롤러의 부모클래스로 지정하는 방법
• 정리(API 예외 처리)