지난 포스팅에 이어, 이번 포스팅에서는 5) ~ 9)
까지의 내용을 정리한다.
👉 목차는 다음과 같다.
1) API 예외 처리 - 시작
2) API 예외 처리 - 스프링 부트 기본 오류 처리
3) API 예외 처리 - HandlerExceptionResolver 시작
4) API 예외 처리 - HandlerExceptionResolver 활용
5) API 예외 처리 - 스프링이 제공하는 ExceptionResolver1
6) API 예외 처리 - 스프링이 제공하는 ExceptionResolver2
7) API 예외 처리 - @ExceptionHandler
8) API 예외 처리 - @ControllerAdvice
9) API 예외 처리 - 정리
스프링 부트가 기본으로 제공하는 ExceptionResolver
는 다음과 같다.
HandlerExceptionResolverComposite
에 다음 순서로 등록ExceptionHandlerExceptionResolver
@ExceptionHandler
을 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다. 조금 뒤에 자세히 설명한다.ResponseStatusExceptionResolver
@ResponseStatus(value = HttpStatus.NOT_FOUND)
)DefaultHandlerExceptionResolver
-> 우선 순위가 가장 낮다.먼저 가장 쉬운 ResponseStatusExceptionResolver
부터 알아보자.
ResponseStatusExceptionResolver
ResponseStatusExceptionResolver
는 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.
다음 두 가지 경우를 처리한다.
@ResponseStatus
가 달려있는 예외ResponseStatusException
예외
하나씩 확인해보자.
👉 @ResponseStatus
가 달려있는 예외
BadRequestException
예외가 컨트롤러 밖으로 넘어가면 ResponseStatusExceptionResolver
가 해당 예외의 애노테이션을 확인해서 오류 코드를 HttpStatus.BAD_REQUEST(400)
으로 변경하고, 메시지도 담는다.ResponseStatusExceptionResolver
코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason)
를 호출하는 것을 확인할 수 있다. (이후 빈 ModelAndView 리턴)sendError(400)
를 호출했기 때문에 WAS에서 다시 오류 페이지( /error
)를 내부 요청한다.application.properties
파일에 server.error.include-message=always
로 설정하였다.BadRequestException
에서, 애노테이션에 적용한 코드(400)와 메시지가 적용됨을 확인할 수 있다.
메시지 기능
reason
을 MessageSource
에서 찾는 기능도 제공한다. ex) reason = "error.bad"
ResponseStatusExceptionResolver
내부 코드를 확인해보자. )
👉 ResponseStatusException
예외
@ResponseStatus
는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. (애노테이션을 직접 넣어야 하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.) 추가로, 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다.
이때는 ResponseStatusException
예외를 사용하면 된다.
ResponseStatusException
도 ResponseStatusExceptionResolver
가 처리한다. (학습시 내부 코드를 확인해보자.)지금까지 ResponseStatusExceptionResolver
에 대해서 알아보았다.
다음 내용에서는 DefaultHandlerExceptionResolver
에 대해서 알아보자.
이번에는 DefaultHandlerExceptionResolver
에 대해서 알아보자.
DefaultHandlerExceptionResolver
는 스프링 내부에서 발생하는 스프링 예외를 해결한다.
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException
이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다.
그런데, 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. (HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어있다.)
DefaultHandlerExceptionResolver
는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경한다. 그리고 그 외에도 스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.
👉 코드로 적용해보자.
Integer data
에 문자를 입력하면 내부에서 TypeMismatchException
이 발생한다.DefaultHandlerExceptionResolver
가 동작됨을 확인할 수 있다.
DefaultHandlerExceptionResolver 코드 확인
DefaultHandlerExceptionResolver.handleTypeMismatch
를 보면 다음과 같은 코드를 확인할 수 있다.
response.sendError(HttpServletResponse.SC_BAD_REQUEST)
response.sendError()
를 통해서 문제를 해결한다. ( sendError(400)
를 호출했기 때문에 WAS에서 다시 오류 페이지( /error
)를 내부 요청한다. )TypeMismatchException
외 수많은 예외가 처리된다. ( 스프링은, 내부에서 발생하는 예외를 최대한 HTTP 스펙에 맞는 상태코드로 바꿔서 처리를 해준다. )
지금까지 HTTP 상태 코드를 변경하고, 스프링 내부 예외의 상태코드를 변경하는 기능도 알아보았다.
그런데, 이전에 직접 만들어봤듯이, HandlerExceptionResolver
를 직접 사용하기는 복잡하다. API 오류 응답의 경우 response
에 직접 데이터를 넣어야 해서 매우 불편하고 번거롭다. 그리고 ModelAndView
를 반환해야 하는 것도 API에는 잘 맞지 않는다.
스프링은 이 문제를 해결하기 위해 @ExceptionHandler
라는 매우 혁신적인 예외 처리 기능을 제공한다. 그것이 아직 소개하지 않은 ExceptionHandlerExceptionResolver
이다.
다음 내용을 통해 알아보자.
HTML 화면 오류 vs API 오류
웹 브라우저에 HTML 화면을 제공할 때는 오류가 발생하면 BasicErrorController
를 사용하는게 편하다. 이때는 단순히 5xx, 4xx 관련된 오류 화면을 보여주면 된다. BasicErrorController
는 이런 메커니즘을 모두 구현해두었다.
그런데 API는 각 시스템마다 응답의 모양도 다르고, 스펙도 모두 다르다. 예외 상황에 단순히 오류 화면을 보여주는 것이 아니라, 예외에 따라서 각각 다른 데이터를 출력해야 할 수도 있다. 그리고 같은 예외라고 해도 어떤 컨트롤러에서 발생했는가에 따라서 다른 예외 응답을 내려주어야 할 수 있다. 한마디로 매우 세밀한 제어가 필요하다. 앞서 이야기했지만, 예를 들어서 상품 API와 주문 API는 오류가 발생했을 때 응답의 모양이 완전히 다를 수 있다.
결국 지금까지 살펴본 BasicErrorController
를 사용하거나 HandlerExceptionResolver
를 직접 구현하는 방식으로 API 예외를 다루기는 쉽지 않다.
API 예외처리의 어려운 점
HandlerExceptionResolver
를 떠올려 보면 ModelAndView
를 반환해야 했다. 이것은 API 응답에는 필요하지 않다. (리턴을 ModelAndView로 반환해야 했기 때문에, API 응답을 위해서 JSON 데이터를 내려줘야 할 때, response에 직접 JSON 데이터를 만들고 변환해서 넣어주고 하는 작업을 했어야 했다. (UserHandlerExceptionResolver 참고))
API 응답을 위해서 HttpServletResponse
에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다. 스프링 컨트롤러에 비유하면 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같다.
특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어서 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException
예외와 상품을 관리하는 컨트롤러에서 발생하는 동일한 RuntimeException
예외를 서로 다른 방식으로 처리하고 싶다면 어떻게 해야할까?
@ExceptionHandler
스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler
라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver
이다.
스프링은 ExceptionHandlerExceptionResolver
를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver
중에 우선순위도 가장 높다. 실무에서 API 예외 처리는 대부분 이 기능을 사용한다.
👉 코드로 확인해보자.
api2
로 변경했다.http://localhost:8080/api2/members/ex
)ErrorResult
)이 아니다. 이건 BasicErrorController
에서 만들어준 모양이다.
✔️ @ExceptionHandler 예외 처리를 적용해보자.
👉 IllegalArgumentException 처리 예시
IllegalArgumentException
또는 그 하위 자식 클래스를 모두 처리할 수 있다.http://localhost:8080/api2/members/ex
)ErrorResult
)으로 응답되었다. (정상 흐름으로 처리하기 때문에, 상태코드가 200으로 응답된다.)400(BAD_REQUEST)
으로 응답되도록 적용해보자.@ResponseStatus(HttpStatus.BAD_REQUEST)
애노테이션 정보를 추가하였다.http://localhost:8080/api2/members/ex
)
실행 흐름
IllegalArgumentException
예외가 컨트롤러 밖으로 던져진다.ExceptionResolver
가 작동한다. 가장 우선순위가 높은 ExceptionHandlerExceptionResolver
가 실행된다.ExceptionHandlerExceptionResolver
는 해당 컨트롤러에 IllegalArgumentException
을 처리할 수 있는 @ExceptionHandler
가 있는지 확인한다.illegalExceptionHandler()
를 실행한다. @RestController
이므로 illegalExceptionHandler()
에도 @ResponseBody
가 적용된다. 따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같은 JSON으로 반환된다.{"code": "BAD","message": "잘못된 입력 값"}
@ResponseStatus(HttpStatus.BAD_REQUEST)
를 지정했으므로 HTTP 상태 코드 400으로 응답한다.
👉 UserException 처리 예시
실행 흐름
@ExceptionHandler
에 예외를 지정하지 않으면 해당 메서드 파라미터 예외를 사용한다. 여기서는 UserException
을 사용한다.ResponseEntity
를 사용해서 HTTP 메시지 바디에 직접 응답한다. 물론 HTTP 컨버터가 사용된다.ResponseEntity
를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다. 앞서 살펴본 @ResponseStatus
는 애노테이션이므로 HTTP 응답 코드를 동적으로 변경할 수 없다.
👉 Exception 처리 예시
Exception
이다. 이렇게 적용하면, 현재 이미 적용되어있는 IllegalArgumentException(IllegalArgumentException을 상속받은 자식 예외 포함)
과 UserException(UserException을 상속받은 자식 예외 포함)
에서 처리되지 못하는 모든 예외들은 이게 다 적용된다.@ExceptionHandler
는 해당 컨트롤러에 안에서만 적용된다. 다른 컨트롤러와는 상관없다. (해당 컨트롤러에서 발생한 예외만 처리)http://localhost:8080/api2/members/ex
는 RuntimeException
이 발생하므로, 위 @ExceptionHandler
가 동작한다.
실행 흐름
throw new RuntimeException("잘못된 사용자")
이 코드가 실행되면서, 컨트롤러 밖으로 RuntimeException
이 던져진다.RuntimeException
은 Exception
의 자식 클래스이다. 따라서 이 메서드가 호출된다.@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
로 HTTP 상태 코드를 500으로 응답한다.
👉 (참고) 기타 - HTML 오류 화면
ModelAndView
를 사용해서 오류 화면(HTML)을 응답하는데 사용할 수도 있다.
✔️ @ExceptionHandler 정리
@ExceptionHandler
애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.IllegalArgumentException
또는 그 하위 자식 클래스를 모두 처리할 수 있다.@ExceptionHandler
에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다. 따라서 자식예외
가 발생하면 부모예외처리()
, 자식예외처리()
둘다 호출 대상이 된다. 그런데 둘 중 더 자세한 것이 우선권을 가지므로 자식예외처리()
가 호출된다. 물론 부모예외
가 호출되면 부모예외처리()
만 호출 대상이 되므로 부모예외처리()
가 호출된다.@ExceptionHandler
에 예외를 생략할 수 있다. 생략하면 메서드 파라미터의 예외가 지정된다.@ExceptionHandler
를 적용할 때, 어떤 파라미터를 넣을 수 있고, 어떤 응답을 할 수 있을까?@ExceptionHandler
에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다. 자세한 파라미터와 응답은 다음 공식 메뉴얼을 참고하자.
지금까지 @ExceptionHandler
에 대해서 알아보았다.
그런데 한가지 의문점이 있다. 만약, A 컨트롤러에 @ExceptionHandler
가 적용된 코드를, B 컨트롤러에서도 거의 똑같이 적용하고자 한다면 어떻게 할까? 현재 구조로 보았을 때는, B 컨트롤러에도 똑같은 코드를 복사해서 붙여넣어야 할 것 같다.
다음 내용에서는, 이러한 불편함을 해결할 수 있는 @ControllerAdvice
에 대해서 알아보자.
@ExceptionHandler
를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있다.
@ControllerAdvice
또는 @RestControllerAdvice
를 사용하면 둘을 분리할 수 있다.
👉 코드로 바로 적용해보자.
ApiExceptionV2Controller
에 있는 @ExceptionHandler
코드를 모두 ExControllerAdvice
로 이동시키자. (ApiExceptionV2Controller
에서는 제거)http://localhost:8080/api2/members/bad
)@RestControllerAdvice
적용 전)과 동일한 결과가 나온다.
@ControllerAdvice
@ControllerAdvice
는, 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler
, @InitBinder
기능을 부여해주는 역할을 한다. (여러 컨트롤러에서 발생하는 예외를 잡아 처리해주는 애노테이션)@ControllerAdvice
에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다. (글로벌 적용)@RestControllerAdvice
는 @ControllerAdvice
와 같고, @ResponseBody
가 추가되어 있다. @Controller
, @RestController
의 차이와 같다.대상 컨트롤러 지정 방법
✔️ 정리
@ExceptionHandler
와 @ControllerAdvice
를 조합하면 예외를 깔끔하게 해결할 수 있다.강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.