이전의 예외 처리에선 html에 고객에게 보여줄 오류 내용만 적어 응답하면 되었다.
하지만 API에선 다르다. 기업간의 데이터 전달이나, 안드로이드 등 여러 데이터를 전달해야는 상황이므로, 정확한 오류 정보가 전달되어야 한다.
따라서 API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고(정해진 스펙이 없기 때문에), JSON으로 데이터를 내려줘야한다.
이전에 했던 것 처럼 컨트롤러를 통해 오류 화면을 처리해보자.
@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
@Override
public void customize(ConfigurableWebServerFactory factory) {
//404 error가 발생하면 path인 /error-page/400 페이지를 호출해라, 정확히 얘기하면 컨트롤러를 호출
ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");
ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");//runtime예외들의 자식예외들도 모두 /error-page/500"로 보내줌
factory.addErrorPages(errorPage404,errorPageEx,errorPage500);//등록
}
} @RequestMapping(value = "/error-page/500", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Map<String, Object>> errorPage500Api(HttpServletRequest request, HttpServletResponse response) {
log.info("API errorPage 500");
HashMap<String, Object> result = new HashMap<>();// 순서 보장하지 않음 따라서 message가 status보다 먼저 출력될 수 있음
Exception ex = (Exception)request.getAttribute(ERROR_EXCEPTION);
result.put("status", request.getAttribute(ERROR_STATUS_CODE));
result.put("message", ex.getMessage());
Integer statusCode = (Integer)request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
return new ResponseEntity<>(result, HttpStatus.valueOf(statusCode));
}우리는 JSON형식으로 데이터를 전달해야하지만, 위의 컨트롤러를 통해 오류 화면을 처리할 경우 이전에 만들어놓은 html파일이 전송된다. 이는 클라이언트가 웹 브라우저가 아닌 이상 html 파일을 받아 활용할 수 없다.
따라서 JSON형식으로 데이터를 응답할 수 있도록 변경해야한다.
스프링 부트 기본 오류 처리
스프링 부트가 제공하는 기본 오류 방식을 사용할 수 있다. errorPage를 처리하는 BasicErrorController의 코드를 확인해보자.
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {}
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}/error 동일한 경로를 처리하는 errorHtml() , error() 두 메서드를 확인할 수 있다. 두 메서드의 리턴 타입을 보더라도 각각의 메서드가 어떤 타입의 데이터를 다루는지 알 수 있을 것이다.
- errorHtml() : produces = MediaType.TEXT_HTML_VALUE : 클라이언트 요청의 Accept 해더 값이 text/html 인 경우에는 errorHtml() 을 호출해서 view를 제공한다.
- error() : 그외 경우에 호출되고 ResponseEntity 로 HTTP Body에 JSON 데이터를 반환한다.
스프링 부트의 기본 설정은 오류 발생시 /error 를 오류 페이지로 요청하기 때문에 BasicErrorController 는 이 경로를 기본으로 받는다. 따라서 요청을 JSON 형식으로 하면 BasicErrorController는 자동으로 JSON 형식으로 오류 정보를 응답에 담아 전달한다.
{
"timestamp": "2021-04-28T00:00:00.000+00:00",
"status": 500,
"error": "Internal Server Error",
"exception": "java.lang.RuntimeException",
"trace": "java.lang.RuntimeException: 잘못된 사용자\n\tat
hello.exception.web.api.ApiExceptionController.getMember(ApiExceptionController
.java:19...,
"message": "잘못된 사용자",
"path": "/api/members/ex"
}스프링 부트는 BasicErrorController 가 제공하는 기본 정보들을 활용해서 오류 API를 생성해준다.
다음 옵션들을 설정하면 더 자세한 오류 정보를 추가할 수 있다.
- server.error.include-binding-errors=always
- server.error.include-exception=true
- server.error.include-message=always
- server.error.include-stacktrace=always
물론 오류 메시지는 이렇게 막 추가하면 보안상 위험할 수 있다. 간결한 메시지만 노출하고, 로그를 통해서 확인하자.
BasicErrorController 를 확장하면 JSON 메시지도 변경할 수 있다. 스프링 부트가 제공하는 BasicErrorController 는 HTML 페이지를 제공하는 경우에는 매우 편리하다.
4xx, 5xx 등등 모두 잘 처리해준다. 그런데 API 오류 처리는 다른 차원의 이야기이다. API 마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있다. 예를 들어서 회원과 관련된 API에서 예외가 발생할 때 응답과, 상품과 관련된 API에서 발생하는 예외에 따라 그 결과가 달라질 수 있다.
즉, API마다 문제가 발생했을 때 나가는 JSON 스타일이 다르다. 클라이언트와 정하는 스펙이 다양하기 때문이다.
결과적으로 매우 세밀하고 복잡하다. 따라서 이 방법은 HTML 화면을 처리할 때 사용하고, API 오류 처리는 아래에서 설명할 @ExceptionHandler 를 사용하자.
HandlerExceptionResolver
예외가 발생해서 서블릿을 넘어 WAS까지 예외가 전달되면 HTTP 상태코드가 500으로 처리된다. 하지만 우리는 발생하는 예외에 따라 400, 404 처럼 다른 상태코드들로 처리하려고 한다. 또한 오류 메시지나, 형식들을 API마다 다르게 처리해보자.
예를 들어서 IllegalArgumentException 을 처리하지 못해서 컨트롤러 밖으로 넘어가는 일이 발생했을 경우를 생각해보자. IllegalArgumentException은 argument가 잘못넘어와서 생긴 오류이므로 클라이언트의 잘못이다. 따라서 서버오류인 5XX 코드가 아닌 400 상태코드로 처리하려고 한다. 아래에서 방법을 알아보자.
APIExceptionController에서 api/members/bad가 넘어오면 IllegalArgumentException이 터지도록 수정해보자.
@GetMapping("/api/members/{id}")
public MemberDto getMember(@PathVariable("id") String id) {
if (id.equals("ex")) {
throw new RuntimeException("잘못된 사용자");
}
if (id.equals("bad")) {
throw new IllegalArgumentException("잘못된 입력 값");
}
return new MemberDto(id, "hello" + id);
}이 상태에서 IllegalArgumentException이 터지도록 요청하면 상태코드는 500으로 반환된다. 스프링 입장에선 Exceptrion이 터지면 모두 500을 반환하기 때문이다.
따라서 이 500을 400으로 바꿔보자. 이런 기능을 사용하려면 HandlerExceptionResolver를 사용해야한다.
스프링 MVC는 컨트롤러(핸들러) 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다. 컨트롤러 밖으로 던져진 예외를 해결하고, 동작 방식을 변경하고 싶으면
HandlerExceptionResolver 를 사용하면 된다. 줄여서 ExceptionResolver 라 한다
HandlerExceptionResolver 적용전
컨트롤러에서 예외가 발생되는데, 이 예외가 끝까지 전달되어 WAS까지 도달한다.
HandlerExceptionResolver 적용 후
HandlerExceptionResolver를 적용하면 이는 예외가 발생하면 예외를 해결하려고 시도 한다. 만약 예외가 해결되면 6,7번이 차례로 실행된다.
HandlerExceptionResolver는 컨트롤러에서 발생한 예외를 잡아서 정상적으로 돌아가도록 해결하려는 해결사의 역할을 한다.
HandlerExceptionResolver를 사용하는 경우에도 PostHandler는 실행되지 않는다.
이제 HandlerExceptionResolver를 사용해보자.
@Slf4j
public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
log.info("call resolver", ex);
try {
if (ex instanceof IllegalArgumentException) {
log.info("IllegalArgumentException resolver to 400");
//IllegalArgumentException 터지면 400으로 보낸다.
response.sendError(HttpServletResponse.SC_BAD_REQUEST, ex.getMessage());
return new ModelAndView();// 빈 값으로 넘기면 WAS까지 정상적인 흐름으로 return된다.
}
} catch (IOException e) {
log.error("resolver ex", e);
}
return null; //null로 리턴되면 예외가 다시 터져서 계속 날아간다 ?
}
}ExceptionResolver 가 ModelAndView 를 반환하는 이유는 마치 try, catch를 하듯이, Exception 을 처리해서 정상 흐름 처럼 변경하는 것이 목적이다.
만약 IllegalArgumentException이 터지면 상태코드를 400으로 지정하고, 빈 ModelAndView를 반환한다. ModelAndView에 아무값도 넣지 않고 반환하게 되면 WAS까지 정상적인 흐름으로 반환되고 WAS에서 response를 보았을 때 예외를 발견한다.
HandlerExceptionResolver는 반환값에 따라 DispatcherServlet의 동작방식이 다르다.
각각의 경우에 대해 알아보자.
- 빈 ModelAndView: new ModelAndView() 처럼 빈 ModelAndView 를 반환하면 뷰를 렌더링 하지 않고, 정상 흐름으로 서블릿이 리턴된다.
- ModelAndView 지정: ModelAndView 에 View , Model 등의 정보를 지정해서 반환하면 뷰를 렌더링한다. 보통 오류 페이지를 렌더링 한다.
- null: null 을 반환하면, 다음 ExceptionResolver 를 찾아서 실행한다. 만약 처리할 수 있는
ExceptionResolver 가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다. 즉 500으로 반환된다. 위의 코드에서는 IllegalArgumentException이 아닌 예외가 터질 경우 return null이 된다.
ExceptionResolver 활용
- 예외 상태 코드 변환
예외를 response.sendError(xxx) 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를
처리하도록 위임
이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 예를 들어서 스프링 부트가 기본으로 설정한 /error 가 호출됨 - 뷰 템플릿 처리
ModelAndView 에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 렌더링 해서 고객에게 제공 - API 응답 처리
response.getWriter().println("hello"); 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는
것도 가능하다. 여기에 JSON 으로 응답하면 API 응답 처리를 할 수 있다.
HandlerExceptionResolver는 아래와 같이 등록해서 사용하면된다.
@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver>
resolvers) {
resolvers.add(new MyHandlerExceptionResolver());
}configureHandlerExceptionResolvers(..)를 사용할 수도 있는데, 이를 사용하게 되면 스프링이 기본으로 등록하는 ExceptionResolver가 제거되므로 위에서 사용한 extendHandlerExceptionResolver를 사용하자.
활용
이제까지는 예외가 발생하면 WAS까지 예외가 던져지고 WAS에서 오류페이지 정보를 찾아 다시 /error를 호출해 다시 요청되는 과정이었다. 하지만 이러한 과정은 매우 복잡하고 어찌보면 비효율적으로 보인다. 따라서 ExceptionResolver를 활용하면 예외가 발생했을 때 이 복잡한 과정없이 ,즉 WAS까지 가서 다시 내부적으로 요청하고 하는 과정 없이, HandlerExceptionResolver에서 다 끝내는 것이다. (WAS까지 안가는 거임)
@Slf4j
public class UserHandlerExceptionResolver implements HandlerExceptionResolver {
private final ObjectMapper objectMapper = new ObjectMapper();
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
try {
if (ex instanceof UserException) {
log.info("UserException resolver to 400");
//JSON인 경우와 아닌 경우로 나눠서 처리해야한다.
String acceptHeader = request.getHeader("accept"); //accept 헤더 정보가져오기
response.setStatus(HttpServletResponse.SC_BAD_REQUEST); //상태 코드 변경
if ("application/json".equals(acceptHeader)) { //application/json일 경우
Map<String, Object> errorResult = new HashMap<>(); //json형식으로, 즉 key, value 형태로 error 정보를 담기 위해 map생성
errorResult.put("ex", ex.getClass());
errorResult.put("message", ex.getMessage());
String result = objectMapper.writeValueAsString(errorResult);//객체를 문자로 바꿔줌 -> JSON을 문자로 바꿔줌
response.setContentType("application/json");
response.setCharacterEncoding("utf-8");
response.getWriter().write(result); //HTTP 응답 BODY에 JSON이 들어감
return new ModelAndView();
} else {
//TEXT/HTML
return new ModelAndView("error/500");//html 호출
}
}
} catch (IOException e) {
log.error("resolver ex", e);
}
return null;
}
}ExceptionResolver 를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver 에서 예외를 처리해버린다. 따라서 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이난다.
ModelAndView를 보내 WAS에서는 이것을 보고 고객에게 보낸다. (다시 오류 페이지를 찾기 위해 내부적으로 호출하는 과정이 필요없다. )
결과적으로 WAS 입장에서는 정상 처리가 된 것이다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다. 서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 추가 프로세스가 실행된다. 반면에 ExceptionResolver 를 사용하면 예외처리가 상당히 깔끔해진다.
그런데 직접 ExceptionResolver 를 구현하려고 하니 상당히 복잡하다. 지금부터 스프링이 제공하는 ExceptionResolver 들을 알아보자.
스프링이 제공하는 ExceptionResolver
스프링 부트가 기본으로 제공하는 ExceptionResolver 는 다음과 같다.
HandlerExceptionResolverComposite 에 다음 순서로 등록
1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver 우선 순위가 가장 낮다.
1번에서 처리되면 2,3번이 동작하지 않고, 1번에서 처리되지 못하고 null이 나오면 2번이 동작한다. 2번이 처리되면 3번이 동작하지 않는다.
ExceptionHandlerExceptionResolver
@ExceptionHandler 을 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다.
ResponseStatusExceptionResolver
HTTP 상태 코드를 지정해준다.
예) @ResponseStatus(value = HttpStatus.NOT_FOUND)
우리가 위에서 response.sendError를 통해 상태코드를 지정해줬던 것과 동일한 기능이다.
DefaultHandlerExceptionResolver
스프링 내부 기본 예외를 처리한다.
ResponseStatusExceptionResolver
ResponseStatusExceptionResolver 는 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.
다음 두 가지 경우를 처리한다.
- @ResponseStatus 가 달려있는 예외
- ResponseStatusException 예외
@ResponseStatus 가 달려있는 예외
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류") //400 상태코드 지정
public class BadRequestException extends RuntimeException{
}위와 같이 BadRequestException을 만들어 status를 지정해주면 실행을 했을 때 400 오류가 나는 것을 확인할 수 있다.
BadRequestException 예외가 컨트롤러 밖으로 넘어가면 ResponseStatusExceptionResolver 예외가 해당 애노테이션을 확인해서 오류 코드를 HttpStatus.BAD_REQUEST (400)으로 변경하고, 메시지도 담는다.
ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason) 를 호출하는 것을 확인할 수 있다.
sendError(400) 를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청한다
여기서 의문인 점은 분명 ModelAndView를 사용함으로써 WAS까지 정상흐름을 가지게 되고, 결국엔 WAS가 다시 내부적인 요청을 하지 않게 된다고 앞에서 배운 바 있다. 하지만 위에선 SendError를 호출했기 때문에 WAS가 또다시 오류 페이지를 내부에 요청한다고 되어있다. 이는 SendError와 ModelAndView의 의미가 상충되는 것이 아닌가.
답은 아래와 같다.
ExceptionResolver는 Error를 해결할 '기회'가 주어집니다.
Resolver에서 HttpServletResponse.sendError()를 사용하지 않고 ModelAndView를 정상적으로 리턴한다면, WAS 내부적인 호출 없이 바로 Http 응답을 리턴합니다.
하지만 Resolver에서 sendError를 발생시키게 된다면, WAS가 dispatcherType == ERROR 형식으로 다시 내부적인 요청을 하게 됩니다. (이것을 BasicErrorController가 처리)reason 을 MessageSource 에서 찾는 기능도 제공한다. reason = "error.bad"
ResponseStatusException
@ResponseStatus 는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. 시스템이 제공하는 거나, 라이브러리가 제공하는 곳엔 적용할 수 없다.(애노테이션을 직접 넣어야 하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.)
추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다. 특정 조건시에 상태코드가 바뀔 때 등. 이때는 ResponseStatusException 예외를 사용하면 된다.
@GetMapping("/api/response-status-ex2")
public String responseStatusEx2(){
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new IllegalAccessError());
}실행해보면 404 코드가 반환된다.
DefaultHandlerExceptionResolver
DefaultHandlerExceptionResolver 는 스프링 내부에서 발생하는 스프링 예외를 해결한다.
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException 이
발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다.
그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP 에서는 이런 경우 클라이언트가 데이터를 잘못 보낸 것이기 때문에 HTTP 상태 코드 400을 사용하도록 되어 있다.
DefaultHandlerExceptionResolver 는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로변경한다. 스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.
@GetMapping("/api/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
return "ok";
}위와 같이 코드가 작성되었다고 하자. 그렇다면 "/api/default-handler-ex?data=10"을 실행하면 ok가 응답된다. 하지만 "/api/default-handler-ex?data=qqq"를 실행한다면 Integer 타입이 들어와야하는 data에 qqq인 문자가 들어왔으므로 bindingError가 난다.
그렇다면 이는 400 오류가 나야하지만, 아무런 처리도 해주지 않았으니 500오류가 날 것으로 예상했다. 하지만 응답을 보자.
{
"status": 400,
"error": "Bad Request",
"exception":
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException"
,
"message": "Failed to convert value of type 'java.lang.String' to required
type 'java.lang.Integer'; nested exception is java.lang.NumberFormatException:
For input string: \"hello\"",
"path": "/api/default-handler-ex"
}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();
}DefaultHandlerExceptionResolver.handleTypeMismatch 를 보면 다음과 같은 코드를 확인할 수 있다.
response.sendError(HttpServletResponse.SC_BAD_REQUEST) (400)
결국 response.sendError() 를 통해서 문제를 해결한다.
sendError(400) 를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청한다.
ExceptionHandlerExceptionResolver
API 예외처리의 어려운 점
- HandlerExceptionResolver 를 떠올려 보면 ModelAndView 를 반환해야 했다. 이것은 API 응답에는 필요하지 않다.
- API 응답을 위해서 HttpServletResponse 에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다. 스프링 컨트롤러에 비유하면 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같다.
- 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어서 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException 예외와 상품을 관리하는 컨트롤러에서 발생하는 동일한
RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면 어떻게 해야할까?
스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler 라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공하는데, 이것이 바로 ExceptionHandlerExceptionResolver 이다.
스프링은 ExceptionHandlerExceptionResolver 를 기본으로 제공하고, 기본으로 제공하는
ExceptionResolver 중에 우선순위도 가장 높다. 실무에서 API 예외 처리는 대부분 이 기능을 사용한다.
아래의 코드를 살펴보자.
@Slf4j
@RestController
public class ApiExceptionV2Controller {
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandelr] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
@GetMapping("/api2/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을 사용했더니 WAS는 내부적인 요청을 하지 않고 예외에 대한 정보를 바로 전달했다.
IllegalArgumentException이 터지면 바로 어노테이션으로 가 처리를 하는 것 같지만, 실상은 그게 아니다. 위의 그림에서도 봤듯이 컨트롤러에서 예외가 터지면 Dispatcher Servlet에서 ExceptionResolver를 통해 예외 해결 시도를 한다.
이 때 사용되는 ExceptionResolver가 우선순위가 제일 높은 ExceptionHandlerExceptionResolver이다. ExceptionHandlerExceptionResolver는 먼저 @ExceptionHandler이 있는지 확인하고 이 어노테이션이 있다면 해당 메서드를 실행해준다. 그러면 정상흐름으로 진행된다.
하지만 위의 예외가 처리되면 정상 흐름으로 처리되기 때문에 상태코드가 200으로 반환된다. 하지만 우리가 원하는것은 400이기 때문에 @ResponseStatus를 통해 상태코드를 지정해주면 된다.
@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 따라서 컨트롤러 마다 예외 처리 방식을 다르게 할 수 있다.
실행 흐름
- 컨트롤러를 호출한 결과 IllegalArgumentException 예외가 컨트롤러 밖으로 던져진다.
- 예외가 발생했으로 ExceptionResolver 가 작동한다. 가장 우선순위가 높은 ExceptionHandlerExceptionResolver 가 실행된다.
- ExceptionHandlerExceptionResolver 는 해당 컨트롤러에 IllegalArgumentException 을 처리할 수 있는 @ExceptionHandler 가 있는지 확인한다.
- illegalExHandle() 를 실행한다. @RestController 이므로 illegalExHandle() 에도 @ResponseBody 가 적용된다. 따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같은 JSON으로 반환된다.
- @ResponseStatus(HttpStatus.BAD_REQUEST) 를 지정했으므로 HTTP 상태 코드 400으로 응답한다.
@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);
}- @ExceptionHandler 에 예외를 지정하지 않으면 해당 메서드 파라미터 예외를 사용한다. 여기서는 UserException 을 사용한다.
- ResponseEntity 를 사용해서 HTTP 메시지 바디에 직접 응답한다. 물론 HTTP 컨버터가 사용된다.
- ResponseEntity 를 사용하면 HTTP 응답 코드를 프로그래밍해서 동적으로 변경할 수 있다. 앞서 살펴본 @ResponseStatus 는 애노테이션이므로 HTTP 응답 코드를 동적으로 변경할 수 없다.
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandler(Exception e) {//위에서 처리하지 못하는 예외들을 처리함, 실수로 놓친 예외들이나, 공동으로 처리하고 싶은 예외들
log.error("[exceptionHandler] ex", e);
return new ErrorResult("EX", "내부 오류");
}- throw new RuntimeException("잘못된 사용자") 이 코드가 실행되면서, 컨트롤러 밖으로
RuntimeException 이 던져진다. - RuntimeException 은 Exception 의 자식 클래스이다. 따라서 이 메서드가 호출된다.
- @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) 로 HTTP 상태 코드를 500으로 응답한다.
부모와 자식 예외
참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다. 따라서 Exception 예외를 처리하고 싶다고 지정하면 모든 예외를 다 처리할 수 있다.
@ExceptionHandler(부모예외.class)
public String 부모예외처리()(부모예외 e) {}
@ExceptionHandler(자식예외.class)
public String 자식예외처리()(자식예외 e) {}@ExceptionHandler 에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다. 따라서 자식예외 가발생하면 부모예외처리() , 자식예외처리() 둘다 호출 대상이 된다. 그런데 둘 중 더 자세한 것이 우선권을 가지므로 자식예외처리() 가 호출된다. 물론 부모예외 가 호출되면 부모예외처리() 만 호출 대상이 되므로 부모예외처리() 가 호출된다.
다양한 예외 처리
@ExceptionHandler({AException.class, BException.class})
public String ex(Exception e) {
log.info("exception e", e);
}AException.class, BException.class 둘 다 처리 가능하다.
예외 생략
@ExceptionHandler 에 예외를 생략할 수 있다. 생략하면 메서드 파라미터의 예외가 지정된다.
@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandle(UserException e) {}파리미터와 응답
@ExceptionHandler 에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.
자세한 파라미터와 응답은 다음 공식 메뉴얼을 참고하자.
HTML 오류 화면
다음과 같이 ModelAndView 를 사용해서 오류 화면(HTML)을 응답하는데 사용할 수도 있다.
@ExceptionHandler(ViewException.class)
public ModelAndView ex(ViewException e) {
log.info("exception e", e);
return new ModelAndView("error");
}하지만 잘 사용하지 않는다.
@ControllerAdvice
@ExceptionHandler 를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여 있다. @ControllerAdvice 또는 @RestControllerAdvice 를 사용하면 둘을 분리할 수 있다.
@Slf4j
@RestControllerAdvice //@ControllerAdvice + @ResponseBody
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", "내부 오류");
}
}여러 컨트롤러에서 발생하는 오류들을 한곳에 모아 처리한다.
따라서 기존의 예외 코드가 있던 곳에선 예외 코드들 없이 깔끔하게 관리할 수 있다.
예를 들어 아래와 같다.
변경 전
@Slf4j
@RestController
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("/api2/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;
}
}변경 후
@Slf4j
@RestController
public class ApiExceptionV2Controller {
@GetMapping("/api2/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;
}
}마치 AOP를 컨트롤러에 적용한 듯한 모습이다.
- @ControllerAdvice 는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler , @InitBinder(해당 컨트롤러에만 영향을 준다) 기능을 부여해주는 역할을 한다.
- @ControllerAdvice 에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다. (글로벌 적용) 따라서 위의 코드에선 대상 컨트롤러를 따로 지정하지 않았으므로 모든 컨트롤러에 적용되어 실행해도 이전과 같은 결과를 얻을 수 있다.
- @RestControllerAdvice 는 @ControllerAdvice 와 같고, @ResponseBody 가 추가되어 있다.
- @Controller , @RestController 의 차이와 같다.
대상 컨트롤러 지정 방법
// Target all Controllers annotated with @RestController - annotation 단위
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}
// Target all Controllers within specific packages - package 단위
@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 를 조합하면 예외를 깔끔하게 해결할 수 있다.
