스프링 부트에서 API예외처리 하는법

스프링 부트에서 API예외 처리하는 3가지 방법을 사용해보겠습니다.

먼저 스프링에서 exception을 처리해주는 HandlerExceptionResolver을 알아보겠습니다.

HandlerExceptionResolver 란?

일반적으로 오류 view에 대한 핸들러 매핑 또는 실행 중에 발생한 예외를 해결할 수 있는 개체에 의해 구현되는 인터페이스입니다. (예외가 던져졌을 때 어떤 핸들러를 실행할 것인지에 대한 정보를 제공)

 

 스프링 부트가 기본으로 제공하는 3가지 ExceptionResolver을 알아보겠습니다. (우선순위 순을 정렬)

• ExceptionHandlerExceptionResolver
• ResponseStatusExceptionResolver
• DefaultHandlerExceptionResolver

 우선 순위  반대로 하나씩 살펴보겠습니다. 

 

1. DefaultHandlerExceptionResolver

DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결합니다.

supported Exceptions

대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException 이
발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로
500 오류가 발생합니다.
그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이고
위 빨간 박스를 보시다 시피, HTTP에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있습니다.
DefaultHandlerExceptionResolver는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로
변경합니다.(위 그림참고)

이를 토대로 내부 코드를 가볍게 한번 살펴보겠습니다.(handleTypeMismatch일 경우)

DefaultHandlerExceptionResolver 내부코드1

DefaultHandlerExceptionResolver 내부코드2

DefaultHandlerExceptionResolver.handleTypeMismatch를 보면 다음과 같은 코드를 확인할 수
있습니다. (500 Error ->400 Error)
response.sendError(HttpServletResponse.SC_BAD_REQUEST)

 

2. ResponseStatusExceptionResolver

ResponseStatusExceptionResolver는 다음 두 가지 경우를 처리합니다.

1. @ResponseStatus 가 달려있는 예외
2. ResponseStatusException 예외

 

먼저 @ResponseStatus를 사용해 보겠습니다.

@ResponseStatus

BadRequestException 예외가 컨트롤러 밖으로 넘어가면 ResponseStatusExceptionResolver 예외가
해당 애노테이션을 확인해서 오류 코드를 HttpStatus.BAD_REQUEST (400)으로 변경하고, 메시지도
담도록 해보았습니다.

어떻게 statusCode가 400으로 변경하고 메시지도 담을까?  간단하게 내부 코드를 캡처해 보겠습니다.

ResponseStatusExceptionResolver 내부코드1

ResponseStatusExceptionResolver 내부코드2

esponseStatusExceptionResolver 내부코드3

코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason)를 호출하는 것을 확인할 수 있습니다.

 

자 이제,

컨트롤러 호출에서 방금 만든 BadRequestException() 에러를 thorw 해보겠습니다.

mapping 정보

/api/response-status-ex1

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "badError")
 -> "status" : 400 , "message" : "badError" 확인 할 수 있습니다.

 

다음으로 ResponseStatusException의 두 번째인 ResponseStatusException 예외를 알아보겠습니다.

 ResponseStatusException 은 Spring 5에 등장하였고, @ResponseStatus의 대체제로 HTTP 응답에 대한 HTTP 상태 코드의 적용을 지원합니다.

그럼 왜? ResponseStatusException는  등장하였을까?

앞서 본@ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. (애노테이션을 직접 넣어야
하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.)
추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경 하기가 어렵다.
이때는, ResponseStatusException를 사용하시면 됩니다.

바로 적용해 보겠습니다.

ResponseStatusException

/api/response-status-ex2

"status" : 400 , "message" : "ResponseStatusException Error" 확인 할 수 있습니다.

 

 

3. ExceptionHandlerExceptionResolver(★★★★★)

만약 HandlerExceptionResolver를 직접 구현하려면 API 오류 응답의 경우 response에
직접 데이터를 넣어야 해서 매우 불편하고 번거롭고. ModelAndView를 반환해야 하는 것도 API에는 잘
맞지 않습니다.
스프링은 이 문제를 해결하기 위해 @ExceptionHandler라는 매우 혁신적인 예외 처리 기능을 제공합니다.
그것이  ExceptionHandlerExceptionResolver입니다.
(@ExceptionHandler가 붙은 메서드를 통해 예외 처리를 할 수 있도록 설정하는 클래스)

스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler라는 애노테이션을 사용하는 매우
편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver입니다.
스프링은 ExceptionHandlerExceptionResolver를 기본으로 제공하고, 기본으로 제공하는
ExceptionResolver 중에 우선순위도 가장 높습니다. [ 실무에서 API 예외 처리에서 가장 많이 사용됨]

코드로 바로 알아보겠습니다.

 

예외가 발생했을 때 API 응답 객체 정의

ErrorResult 객체

ExceptionController

@ExceptionHandler 사용법 ↓

@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다.해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식클래스는 모두 잡을 수 있다.

@ExceptionHandler에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다그런데 둘 중 더 자세한 것이 우선권을가지므로 자식 예외처리 가 호출된다. 물론 부모 예외 가 호출되면 부모 예외처리()만 호출 대상이 되므로부모 예외처리()가 호출된다.

@ExceptionHandler에 예외를 생략할 수 있다. 생략하면 메서드 파라미터의 예외가 지정된다.(@ExceptionHandler Controller 사진에서  15 Line,  21 Line을 잘 비교해 보시면 차이점을 찾을 수 있을 것입니다.)

 

api2/members/bad(예시1)

위 그림의 실행 흐름

api2/members/bad 호출 -> IllegalArgumentException 예외가 컨트롤러 밖으로 던져진다 -> 예외가 발생했으므로 ExceptionHandlerExceptionResolver가 실행됨(우선순위가 가장 높은 ExceptionResolverd 이기 때문) -> ExceptionHandlerExceptionResolver는 해당 컨트롤러에 IllegalArgumentException을 처리할
수 있는 @ExceptionHandler 가 있는지 확인 -> illegalExHandle()를 실행(그림 17 Line)

 

 

api2/members/ex(예시2)

실행 흐름은 위와 같고 주의해서 봐야 할 점은 컨트롤러에서 RuntimeExceptionr 가 던져진다 -> RuntimeException 은 Exception의 자식 클래스 이므로 exHandler메서드가 호출된다(그림 24 Line)

 

다음 시간에는 글로벌 설정 API 예외 처리 - @ControllerAdvice를 알아보겠습니다.

 

 

참고 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2  (김영한님 스프링2편)