API 예외 처리 - 스프링이 제공하는 ExceptionResolver
스프링 부트가 기본으로 제공하는 ExceptionResolver
HandlerExceptionResolverComposite 에 다음 순서로 등록 (우선순위)
1. ExceptionHandlerExceptionResolver
: @ExceptionHandler 를 처리. API 예외 처리는 대부분 이 기능으로 해결
2. ResponseStatusExceptionResolver
: HTTP 상태 코드 지정. 예) @ResponseStatus(value = HttpStatus.NOT_FOUND)
3. DefaultHandlerExceptionResolver
: 스프링 내부 기본 예외 처리
이미 등록이 되어서 따로 세팅하지 않아도 동작한다.
첫번째 ExceptionResolver 에서 예외가 처리되지 않고 null을 반환하면 두번째 ExceptionResolver 실행 ...
ResponseStatusExceptionResolver
ResponseStatusExceptionResolver 는 예외에 따라서 HTTP 상태 코드를 지정한다.
다음 두 가지 경우를 처리
- @ResponseStatus 가 달려있는 예외
- ResponseStatusException 예외
@ResponseStatus
예외 클래스에 해당 애노테이션을 붙인다.
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException {}ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason) 를 호출하고 빈 ModelAndView 를 반환하는 것을 알 수 있다.
sendError(400) 를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청한다.
메세지 기능
reason 을 MessageSource 에서 찾는 기능도 제공한다.
@ResponseStatus(code = ... , reason = "error.bad")
==messages.properties
error.bad=잘못된 요청 오류입니다.reason을 받아 우선 MessageSource 를 뒤져보고 없으면 reason을 그대로 사용
ResponseStatusException
@ResponseStatus 는 사용자 정의 예외에만 적용할 수 있다. (애노테이션을 직접 넣어야 하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용 불가)
추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다.
이때는 ResponseStatusException 예외를 사용하자.
@GetMapping("/api/response-status-ex2")
public String responseStatusEx2(){
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new IllegalArgumentException());
}
실제 예외 클래스이고 HTTP 상태 코드, 에러 메세지 뿐만 아니라 실제 발생하는 예외도 지정할 수 있다.
참고: 메세지를 HTTP 응답 메세지로 확인하고 싶다면 server.error.include-message=always
DefaultHandlerExceptionResolver
DefaultHandlerExceptionResolver 는 스프링 내부에서 발생하는 스프링 예외를 해결한다. 스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException 이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다. 그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다. DefaultHandlerExceptionResolver 는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경한다.
코드 확인
DefaultHandlerExceptionResolver.handleTypeMismatch()
protected ModelAndView handleTypeMismatch(TypeMismatchException ex,
HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException {
response.sendError(HttpServletResponse.SC_BAD_REQUEST);
return new ModelAndView();
}
sendError(400) 를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청
지금까지 HTTP 상태 코드를 변경하고, 스프링 내부 예외의 상태코드를 변경하는 기능을 알아보았다. 그런데 HandlerExceptionResolver 를 직접 사용하기는 복잡하다. API 오류 응답의 경우 response 에 직접 데이터를 넣어야 하고 ModelAndView 를 반환해야 하는 것도 API에는 잘 맞지 않는다.
=> @ExceptionHandler, ExceptionHandlerExceptionResolver
ExceptionHandlerExceptionResolver
HTML 화면 오류 vs API 오류
웹 브라우저에 HTML 화면을 제공할 때는 오류가 발생하면 BasicErrorController 를 사용하는게 편하다. 이때는 단순히 5xx, 4xx 관련된 오류 화면만 만들면 된다.
API는 각 시스템 마다 응답의 모양도 다르고, 스펙도 모두 다르다. 예외 상황에 단순히 오류 화면을 보여주는 것이 아니라, 예외에 따라서 각각 다른 데이터를 출력해야 할 수도 있다. 그리고 같은 예외라고 해도 어떤 컨트롤러에서 발생했는가에 따라서 다른 예외 응답을 내려주어야 할 수 있다. -> 매우 세밀한 제어가 필요
결국 BasicErrorController 를 사용하거나 HandlerExceptionResolver 를 직접 구현하는 방식으로 API 예외를 다루기는 쉽지 않다.
API 예외처리의 어려운 점
- HandlerExceptionResolver 는 ModelAndView 를 반환해야 한다. 이것은 API 응답에는 필요하지 않다.
- API 응답을 위해서 HttpServletResponse 에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다. 스프링 컨트롤러에 비유하면 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같다.
- 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어, 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException 예외와 상품을 관리하는 컨트롤러에서 발생하는 RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면 어떻게 해야할까? 컨트롤러에 따라 다른 API 예외 응답 (각 컨트롤러에 예외 처리기 따로 정의)
@ExceptionHandler
스프링이 기본으로 제공하는 ExceptionResolver 중에 우선순위가 가장 높다.
실무에서 API 예외 처리는 대부분 이 기능을 사용한다.
1. 예외가 발생했을 때 API 응답 클래스 정의 (이후 json 으로 변환되어 반환)
2. 컨트롤러에 @ExceptionHandler 예외 처리 메서드 정의
3. 완전히 정상 흐름으로 바꾸어 반환 (상태 코드 기본값: 200)
@ResponseStatus 로 변경 가능
@ExceptionHandler 예외 처리 방법
@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.
우선순위
스프링의 우선순위는 항상 자세한 것이 우선권을 가진다.
@ExceptionHandler(부모예외.class)
public String 부모예외처리()(부모예외 e) {}
@ExceptionHandler(자식예외.class)
public String 자식예외처리()(자식예외 e) {}
@ExceptionHandler 에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다. 따라서 자식예외 가 발생하면 둘 중 더 자세한 것이 우선권을 가지므로 자식예외처리() 가 호출된다. 물론 부모예외 가 호출되면 부모예외처리() 만 호출 대상이 되므로 부모예외처리() 가 호출된다.
즉, Exception.class 에 대한 예외 처리기는 다른 자식 예외 처리기에서 처리하지 못한 모든 예외를 잡는다.
다양한 예외
@ExceptionHandler 에는 예외를 리스트로 지정할 수 있다. 다양한 예외를 한번에 처리할 수 있다.
@ExceptionHandler({AException.class, BException.class})
예외 생략
@ExceptionHandler 에 예외를 생략할 수 있다. 생략하면 메서드 파라미터의 예외가 지정된다.
@ExceptionHandler
public ResponseEntity userExHandle(UserException e) {}
파리미터와 응답
@ExceptionHandler 에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.
@ExceptionHandler - MethodArgument, ReturnValue
API 최적화 기능이긴 하지만 뷰를 반환하는 것도 가능하다.
참고: 응답 값으로 ResponseEntity 를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다. @ResponseStatus 는 애노테이션이므로 HTTP 응답 코드를 동적으로 변경할 수 없다.
컨트롤러마다 정의해야 하기 때문에 코드 중복 가능성 O
-> @ControllerAdvice
API 예외 처리 - @ControllerAdvice
@ExceptionHandler 를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있다. @ControllerAdvice 또는 @RestControllerAdvice 를 사용하면 둘을 분리할 수 있다.
@ControllerAdvice
- @ControllerAdvice 는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler @InitBinder 기능을 부여해주는 역할을 한다.
- @ControllerAdvice 에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다. (글로벌 적용)
- @RestControllerAdvice 는 @ControllerAdvice + @ResponseBody. @Controller , @RestController 의 차이와 같다.
대상 컨트롤러 지정 방법
// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}
// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}
// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = {ControllerInterface.class,AbstractController.class})
public class ExampleAdvice3 {}애노테이션 단위 ( annotations ) 특정 애노테이션이 있는 컨트롤러가 대상
패키지 단위 ( value : default ) 해당 패키지와 그 하위에 있는 컨트롤러가 대상
클래스 단위 ( assignableTypes ) 해당 클래스와 그 자식 클래스가 대상
정리
@ExceptionHandler 와 @ControllerAdvice 를 조합하면 예외를 깔끔하게 해결할 수 있다.
10. 스프링 타입 컨버터
문자를 숫자로 변환하거나, 반대로 숫자를 문자로 변환해야 하는 것 처럼 애플리케이션을 개발하다 보면 타입을 변환해야 하는 경우가 상당히 많다.
@RequestParam, @ModelAttribute , @PathVariable 등은 스프링이 자동으로 원하는 타입으로 변환해준다.
이러한 애노테이션도 결국 내부적으로는 HTTP 요청 메세지( HttpServletRequest ) 를 받아와서 직접 타입을 변환하는 과정을 거친다. 이러한 변환기를 스프링이 자동으로 호출할 뿐이다.
스프링의 타입 변환 적용 예
- 스프링 MVC 요청 파라미터: @RequestParam , @ModelAttribute , @PathVariable
- @Value 등으로 YML 정보 읽기
- XML에 넣은 스프링 빈 정보를 변환
- 뷰를 렌더링 할 때
컨버터 인터페이스
스프링은 확장 가능한 컨버터 인터페이스를 제공한다.
package org.springframework.core.convert.converter;
public interface Converter<S, T> {
T convert(S source);
}
개발자는 스프링에 추가적인 타입 변환이 필요하면 이 컨버터 인터페이스를 구현해서 등록하면 된다. 이 컨버터 인터페이스는 모든 타입에 적용할 수 있다.
예를 들어서 문자로 "true" 가 오면 Boolean 타입으로 받고 싶으면 String -> Boolean 타입으로 변환되도록 컨버터 인터페이스를 만들어서 등록하고, 반대로 적용하고 싶으면 Boolean -> String 타입으로 변환되도록 컨버터를 추가로 만들어서 등록하면 된다.
참고: 과거에는 PropertyEditor 라는 것으로 타입을 변환했다. PropertyEditor 는 동시성 문제가 있어서 타입을 변환할 때 마다 객체를 계속 생성해야 하는 단점이 있다. 지금은 Converter 의 등장으로 해당 문제들이 해결되었고, 기능 확장이 필요하면 Converter 를 사용하면 된다.
