스프링이 제공하는 ExceptionResolver
스프링 부트가 기본으로 제공하는 ExceptionResolver 는 다음과 같다. HandlerExceptionResolverComposite 에 다음 순서로 등록.
ExceptionHandlerExceptionResolver:@ExceptionHandler을 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다.ResponseStatusExceptionResolver: HTTP 상태 코드를 지정해준다.
예) @ResponseStatus(value = HttpStatus.NOT_FOUND)DefaultHandlerExceptionResolver: 스프링 내부 기본 예외를 처리한다. 우선 순위가 가장 낮다.
ResponseStatusExceptionResolver
일단 가장 중요한 ExceptionHandlerExceptionResolver를 제외한 두번째 순위부터 알아보자.
ResponseStatusExceptionResolver는 앞서 언급했듯 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.
ResponseStatusExceptionResolver는 다음 두 가지 경우를 처리한다.
1. @ResponseStatus 가 달려있는 예외
2. ResponseStatusException 예외
@ResponseStatus 가 달려있는 경우
BadRequestException.java
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException {}
찾아보면 ResponseStatus를 뒤져서 찾아서 갖고오게끔 되어있다. 
그리고 applyStatusAndReason()를 보면 앞서 우리가 작성한 코드와 굉장히 유사한 것을 볼 수 있다. (예외를 먹어버리고 정상작동하는 것 처럼 눈속임함.)
컨트롤러에서 작성한 예외가 터지도록 설정
@GetMapping("/api/response-status-ex1")
public String responseStatusEx1() {
throw new BadRequestException();
}메시지 기능
reason 을 MessageSource 에서 찾는 기능도 제공한다. reason = "error.bad"
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "error.bad")
public class BadRequestException extends RuntimeException {}messages.properties
error.bad=잘못된 요청 오류입니다. 메시지 사용ResponseStatusException로 예외처리하는 경우
- 이땐 라이브러리에 어노테이션을 붙일 수 없을 때 사용된다.
또한 특정 조건일 때 유동적으로 사용할 수 없다.
컨트롤러에서 ResponseStatusException 발생
@GetMapping("/response-status-ex2")
public String responseStatusEx2() {
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new IllegalArgumentException());
}- 얘도 위에 사진을 보면
doResolveException()이 실행해주는 것이다.
DefaultHandlerExceptionResolver
DefaultHandlerExceptionResolver 는 스프링 내부에서 발생하는 스프링 예외를 해결한다.
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException 이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다.
그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다.
DefaultHandlerExceptionResolver 는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경하도록 해준다. 스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.
컨트롤러에서 TypeMismatchException 발생시키기
@GetMapping("/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
return "ok";
}- 여기서 data의 값을 Int값이 아닌 문자열을 주면 TypeMismatch로 500 에러가 서블릿 컨테이너까지 올라가는데
앞서 이 사진처럼 중간에 ExceptionResolver중DefaultHandlerExceptionResolver가 걸려서 아래 코드처럼typeMismatch()를 통하여 400에러로 바꿔준다.
ExceptionHandlerExceptionResolver
API 예외처리의 어려운 점
HandlerExceptionResolver를 떠올려 보면ModelAndView를 반환해야 했다. 이것은 API 응답에는 필요하지 않다.- API 응답을 위해서
HttpServletResponse에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다. 스프링 컨트롤러에 비유하면 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같다. - 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어서 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException 예외와 상품을 관리하는 컨트롤러에서 발생하는 동일한 RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면 쉽지 않다.
@ExceptionHandler
스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler 라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver 이다. 스프링은 ExceptionHandlerExceptionResolver 를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver
중에 우선순위도 가장 높다.
ErrorResult.java
@Data
@AllArgsConstructor
public class ErrorResult {
private String code;
private String message;
}- 메시지를 표출하기 위한 객체를 생성한다.
컨트롤러에서 ExceptionHandler를 작성
@Slf4j
@RestController
@RequestMapping("/api2")
public class ApiExceptionV2Controller {
// 여기 아래부분
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandler(UserException e) {
log.error("[exceptionHandler] ex", e);
ErrorResult errorResult = new ErrorResult("USER_EX", e.getMessage());
return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandler(Exception e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("EX", "내부 오류");
}
@GetMapping("/members/{id}")
public MemberDto getMember(@PathVariable("id") String id) {
if (id.equals("ex")) {
throw new RuntimeException("잘못된 사용자");
}
if (id.equals("bad")) {
throw new IllegalArgumentException("잘못된 입력 값");
}
if (id.equals("user-ex")) {
throw new UserException("사용자 오류");
}
return new MemberDto(id, "hello " + id);
}
@Data
@AllArgsConstructor
static class MemberDto {
private String memberId;
private String name;
}
}-
@ExceptionHandler를 컨트롤러에 등록을 해두면 알아서ErrorResult객체가 json으로 변환되어 response 된다. -
ExceptionHandlerExceptionResolver는 컨트롤러에@ExceptionHandler가 있는지 먼저 찾아본다. 그래서 있다면 해당 메서드를 대신 호출한다. -
다만
@ResponseStatus(HttpStatus.BAD_REQUEST)를 안 한다면 객체도 바꾸고 에러코드도 먹어버리기 때문에 response가 200 상태 코드가 나가게된다.
따라서 반드시@ResponseStatus어노테이션을 추가해줘야한다. -
또한 매개변수의 타입과
ExceptionHandler의 매개변수의 타입이 같다면ExceptionHandler의 매개변수를 생략할 수 있다.
정확히 말하자면@ResponseStatus이렇게 매개변수를 생략하면 해당 메서드의 매개변수의 타입이 들어간다. -
또한 반환타입이
ResponseEntity를 사용해서 HTTP 메시지 바디에 직접 응답한다. 물론 HTTP 컨버터가 사용된다.
ResponseEntity를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다. 앞서 살펴본@ResponseStatus는 애노테이션이므로 HTTP 응답 코드를 동적으로 변경할 수 없다. -
만약 매개변수의 타입이
Exception이라면 위코드에서는IllegalArgumentException혹은UserException혹은 이 두 Exception을 상속받은 다른 Exception이 아닌 모든Exception은exHandler()함수로 들어가게 된다.
다양한 예외
참고로 다음과 같이 다양한 예외를 한번에 처리할 수 있다.
@ExceptionHandler({AException.class, BException.class})
public String ex(Exception e) {
log.info("exception e", e);
}파리미터와 응답
공식문서를 보면 @ExceptionHandler 에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.
그래서 사실 view를 반환할 수도 있고 그렇다. (그런데 그땐 @RestController가 아니라 @Controller여야겠지?)
그런데 아마 API 처리할때만 쓸 것이다.
실행 흐름
- 컨트롤러를 호출한 결과
IllegalArgumentException 예외가 컨트롤러 밖으로 던져진다. - 예외가 발생했으로
ExceptionResolver가 작동한다. 가장 우선순위가 높은ExceptionHandlerExceptionResolver가 실행된다. ExceptionHandlerExceptionResolver는 해당 컨트롤러에IllegalArgumentException을 처리 할 수 있는@ExceptionHandler가 있는지 확인한다.- 있다면 해당 메서드를 실행한다.
@RestController이므로 해당 메서드 에도@ResponseBody가 적용된다. 따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같은 JSON으로 반환된다.
이때@ResponseStatus(HttpStatus.BAD_REQUEST)를 지정했으므로 HTTP 상태 코드 400으로 응답한다.
@ControllerAdvice
문제점
- 그런데 문제점이 앞서 언급했듯 해당 컨트롤러에서만 적용된다는 것이다. 그럼 얘를 ctrl+C ctrl+V 해야하는데 굉장히 비효율적이다. 그래서 나온 개념이 바로 @ControllerAdvice이다.
@ControllerAdvice
@RestControllerAdvice 어노테이션을 추가해줘야하는데 얘를 들어가서 자세히 살펴보면 
@ControllerAdvice 에 @ResponseBody가 붙어있는 것이다.
즉,@RestControllerAdvice 는 @ControllerAdvice 와 같고, @ResponseBody 가 추가되어 있다.
@Controller , @RestController 의 차이와 같다.
@Slf4j
@RestControllerAdvice
public class ExControllerAdvice {
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandler(UserException e) {
log.error("[exceptionHandler] ex", e);
ErrorResult errorResult = new ErrorResult("USER_EX", e.getMessage());
return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
}
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandler(Exception e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("EX", "내부 오류");
}
}@ControllerAdvice는 대상으로 지정한 여러 컨트롤러에@ExceptionHandler,@InitBinder기능을 부여해주는 역할을 한다.
@ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다. (글로벌 적용)
대상 컨트롤러 지정 방법
해당 어노테이션이 붙어있는 애들만
// 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 {
...
}스프링 공식 문서 예제에서 보는 것 처럼 특정 애노테이션이 있는 컨트롤러를 지정할 수 있고, 특정 패키지를 직접 지정할 수도 있다. 패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대상이 된다. 그리고 특정 클래스를 지정할 수도 있다.
대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다.
@ExceptionHandler 와 @ControllerAdvice 를 조합하면 예외를 깔끔하게 해결할 수 있다
