스프링 부트가 기본으로 제공하는 ExceptionResolver
는 다음과 같다. HandlerExceptionResolverComposite
에 다음 순서로 등록.
ExceptionHandlerExceptionResolver
:@ExceptionHandler
을 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다.ResponseStatusExceptionResolver
: HTTP 상태 코드를 지정해준다.DefaultHandlerExceptionResolver
: 스프링 내부 기본 예외를 처리한다. 우선 순위가 가장 낮다.일단 가장 중요한 ExceptionHandlerExceptionResolver
를 제외한 두번째 순위부터 알아보자.
ResponseStatusExceptionResolver
는 앞서 언급했듯 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.
ResponseStatusExceptionResolver
는 다음 두 가지 경우를 처리한다.
1. @ResponseStatus
가 달려있는 예외
2. ResponseStatusException
예외
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException {}
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 {}
error.bad=잘못된 요청 오류입니다. 메시지 사용
@GetMapping("/response-status-ex2")
public String responseStatusEx2() {
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new IllegalArgumentException());
}
doResolveException()
이 실행해주는 것이다.DefaultHandlerExceptionResolver
는 스프링 내부에서 발생하는 스프링 예외를 해결한다.
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException
이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너
까지 오류가 올라가고, 결과적으로 500 오류
가 발생한다.
그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다.
DefaultHandlerExceptionResolver
는 이것을 500 오류
가 아니라 HTTP 상태 코드 400 오류
로 변경하도록 해준다. 스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.
@GetMapping("/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
return "ok";
}
ExceptionResolver
중 DefaultHandlerExceptionResolver
가 걸려서 아래 코드처럼 typeMismatch()
를 통하여 400에러로 바꿔준다. HandlerExceptionResolver
를 떠올려 보면 ModelAndView
를 반환해야 했다. 이것은 API 응답에는 필요하지 않다.HttpServletResponse
에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다. 스프링 컨트롤러에 비유하면 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같다.스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler
라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver
이다. 스프링은 ExceptionHandlerExceptionResolver
를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver
중에 우선순위도 가장 높다.
@Data
@AllArgsConstructor
public class ErrorResult {
private String code;
private String message;
}
@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으로 응답한다.@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 를 조합하면 예외를 깔끔하게 해결할 수 있다