API 예외 처리를 어떻게 해야할까?
HTML 페이지의 경우 지금까지 설명했던 것처럼, 4xx, 5xx와 같은 오류 페이지만 있으면 대부분의 문제를 해결할 수 있었다.
그런데 API의 경우에는 생각할 내용이 더 많다. 오류 페이지는 단순히 고객에게 오류 화면을 보여주고 끝이지만, API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.
API의 경우 어떻게 예외처리를 하면 좋은지 알아보자.
우선 처음으로 돌아가서 서블릿 오류 페이지 방식을 사용해보자.
@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
@Override
public void customize(ConfigurableWebServerFactory factory) {
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");
factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
}
}
WebServerCustomizer가 다시 사용되도록한다.
이제 WAS에 예외가 전달되거나, response.sendError()가 호출되면, 위에 등록한 예외 페이지 경로가 호출된다.
@Slf4j
@RestController
public class ApiExceptionController {
@GetMapping("/api/members/{id}")
public MemberDto getMember(@PathVariable("id") String id) {
if (id.equals("ex")) {
throw new RuntimeException("잘못된 사용자");
}
return new MemberDto(id, "hello " + id);
}
@Data
@AllArgsConstructor
static class MemberDto {
private String memberId;
private String name;
}
}
회원을 조회하는 기능을 하나 만들었다. 예외 테스트를 위해 URL에 전달된 id의 값이 ex면 예외가 발생하도록 코드를 심어두었다.
Postman으로 찔러보자.
** HTTP Header의 Accept가 application/json인것을 꼭 확인하자.
http://localhost:8080/api/members/spring
JSON으로 잘 나오는 것을 확인할 수 있다.
만약 id가 ex이여서 if 분기문을 타게 되어 런타임 에러를 만나게 되면 어떻게 될까?
http://localhost:8080/api/members/ex
API를 요청했는데 우리가 만들어 놓은 오류 페이지 HTML이 반환되었다. 이것은 우리가 기대하던 바가 아니다. 클라이언트는 정상 요청이든, 오류 요청이든 JSON이 반환되기를 기대한다.(서버끼리의 통신인데 웹 브라우저를 받을 이유가 없음)
웹 브라우저가 아닌 이상 HTML을 직접 받아서 할 수 있는 것은 별로 없다.
문제를 해결하려면 오류 페이지 컨트롤러도 JSON 응답을 할 수 있도록 수정해야 한다.
ErrorPageController에 API응답을 추가해준다.
@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");
Map<String, Object> result = new HashMap<>();
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));
}produces = MediaType.APPLICATION_JSON_VALUE의 뜻은 클라이언트가 요청하는 HTTP Header의 Accept 값이 application/json일 때 해당 메서드가 호출된다는 것이다. 결국 클라이언트가 받고 싶은 미디어 타입이 json이면 이 컨트롤러의 메서드가 호출된다.
응답 데이터를 위해 Map을 만들고, status, message키에 값을 할당했다. Jackson 라이브러리는 Map을 JSON 구조로 변환할 수 있다.
ResponseEntity를 사용해서 응답하기 때문에 메시지 컨버터가 동작하면서 클라이언트에 JSON이 반환된다.
포스트맨을 통해 다시 테스트해보자.
HTTP Header에 Accept가 application/json인 것을 꼭 확인하자.
http://localhost:8080/api/members/ex
HTTP Header에 Accept가 application/json이 아니면, 기존 오류 응답인 HTML 응답이 출력되는 것을 확인할 수 있다.
API 예외 처리 - 스프링 부트 기본 오류 처리
API 예외 처리도 스프링 부트가 제공하는 기본 오류 방식을 사용할 수 있다.
스프링 부트가 제공하는 BasicErrorController 코드를 보자.
@RequestMapping(
produces = {"text/html"}
)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
HttpStatus status = this.getStatus(request);
Map<String, Object> model = Collections.unmodifiableMap(this.getErrorAttributes(request, this.getErrorAttributeOptions(request, MediaType.TEXT_HTML)));
response.setStatus(status.value());
ModelAndView modelAndView = this.resolveErrorView(request, response, status, model);
return modelAndView != null ? modelAndView : new ModelAndView("error", model);
}
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
HttpStatus status = this.getStatus(request);
if (status == HttpStatus.NO_CONTENT) {
return new ResponseEntity(status);
} else {
Map<String, Object> body = this.getErrorAttributes(request, this.getErrorAttributeOptions(request, MediaType.ALL));
return new ResponseEntity(body, status);
}
}
/error 동일한 경로를 처리하는 errorHtml(), error() 두 메서드를 확인할 수 있다.
- errorHtml() : produces = MediaType.TEXT_HTML_VALUE : 클라이언트 요청의 Accept 헤더 값이 text/html인 경우에는 errorHtml()을 호출해서 view를 제공한다.
- error() : 그 외의 경우 호출되고, ResponseEntity로 HTTP Body에 JSON 데이터를 반환한다.
스프링 부트의 예외 처리
앞서 학습했듯이 스프링 부트의 기본 설정은 오류 발생시 /error를 오류 페이지로 요청한다.
BasicErrorController는 이 경로를 기본으로 받는다. (server.error.path로 수정 가능, 기본 경로 /error)
Postman으로 실행해보자.(기존 WebServerCustomizer의 @Component는 주석처리 하자)
http://localhost:8080/api/members/ex
스프링 부트는 BasicErrorController가 제공하는 기본 정보들을 활용해서 오류 API를 생성해준다.
Html 페이지 vs API 오류
BasicErrorController를 확장하면 JSON 메시지도 변경할 수 있다. 그런데 API 오류는 조금 뒤에 설명할 @ExceptionHandler가 제공하는 기능을 사용하는 것이 더 나은 방법이므로 지금은 BasicErrorController를 확장해서 JSON 오류 메시지를 변경할 수 있다는 정도만 알아두자.
스프링 부트가 제공하는 BasicErrorController는 HTML 페이지를 제공하는 경우에는 매우 편리하다. 4xx, 5xx등등 모두 잘 처리해준다. 그런데 API 오류 처리는 다른 차원의 이야기이다. API 마다, 각각의 컨트롤러나 예외마다 서로 다른 응답 결과를 출력해야 할 수도 있다. 예를 들어 회원과 관련된 API에서 예외가 발생할 떄 응답과, 상품과 관련된 API에서 발생하는 예외에 따라 그 결과가 달라질 수 있다. 결과적으로 매우 세밀하고 복잡하다. 따라서 이 방법은 HTML 화면을 처리할 떄 사용하고, API 오류 처리는 @ExceptionHandler를 사용하자.
API 예외 처리 - HandlerExceptionResolver
예외가 발생해서 서블릿을 넘어 WAS까지 예외가 전달되면, HTTP 상태 코드가 500으로 처리된다. 발생하는 예외에 따라서 400, 404 등등 다른 상태 코드로 처리하고 싶다.
오류 메시지, 형식 등을 API마다 다르게 처리하고 싶다.
상태코드 변환
예를 들어 IllegalArgumentException을 처리하지 못해서 컨트롤러 밖으로 넘어가는 일이 발생하면 HTTP 상태 코드를 400으로 처리하고 싶다. 어떻게 해야할까?
@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);
}
Postman으로 찔러보도록 하자. IllegalArgumentException이 발생하도록 했다.(400번대 에러는 클라이언트 에러)
localhost:8080/api/members/bad
의도한 것과 달리 상태 코드가 500인 것을 확인할 수 있다.
이유 : WAS에서는 어찌되었던 서버쪽에서 오류가 던져저서 온 것이기 때문에 서버쪽 오류라 생각하고 500 에러가 발생하게 된다.
**예외를 명확히 클라이언트 잘못(400)으로 처리하려면, 개발자가 직접 처리해주어야 한다. 안그러면 스프링은 서버 문제로 보고 500을 내보내게 된다.**
HandlerExceptionResolver
스프링 MVC는 컨트롤러(핸들러) 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다. 컨트롤러 밖으로 던져진 예외를 해결하고, 동작 방식을 변경하고 싶으면, HandlerExceptionResolver를 사용하면 된다. 줄여서 ExceptionResolver라 한다.
참고 : ExceptionResolver로 예외를 해결해도 postHandle()은 호출되지 않는다.
@Slf4j
public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
try {
if (ex instanceof IllegalArgumentException) {
log.info("IllegalArgumentException resolver to 400");
response.sendError(HttpServletResponse.SC_BAD_REQUEST, ex.getMessage());
return new ModelAndView();
}
} catch (IOException e) {
log.error("resolver ex", e);
}
return null;
}
}
- ExceptionResolver가 ModelAndView를 반환하는 이유는 마치 try, catch를 하듯이, Exception을 처리해서 정상 흐름처럼 변경하는 것이 목적이다. 이름 그대로 Exception을 Resolver(해결)하는 것이 목적이다.
여기서는 IllegalArgument가 발생하면 response.sendError(400)을 호출해서 HTTP 상태 코드를 400으로 지정하고, 빈 ModelAndView를 반환한다.
HandlerExceptionResolver의 반환 값에 따른 DispatcherServlet의 동작 방식은 다음과 같다.
동작 방식
- 빈 ModelAndView : new ModelAndView()처럼 빈 ModelAndView를 반환하면 뷰를 렌더링하지 않고, 정상 흐름으로 서블릿이 리턴된다.
- ModelAndView 지정 : ModelAndView에 View, Model등의 정보를 지정해서 반환하면, 뷰를 렌더링한다.
- null : null을 반환하면, 다음 ExceptionResolver를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResolver가 없으면 예외처리가 안되고, 기존에 발생한 예외를 서블릿 밖으로 던진다.
ExceptionResolver 활용
- 예외 상태 코드 변환
- 예외를 response.sendError(xxx)호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임
- 이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 예를 들어 스프링 부트가 기본으로 설정한 /error가 호출됨
- 뷰 템플릿 처리
- ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 렌더링해서 고객에게 제공
- API 응답 처리
- response.getWriter().println("hello");처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다. 여기에 JSON으로 응답하면 API 응답처리를 할 수 있다.
WebConfig에 등록을 해보도록 하자.
@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
resolvers.add(new MyHandlerExceptionResolver());
}
postman을 실행하면 이제 400 에러가 나오는 것을 확인할 수 있다.
API 예외 처리 - HandlerExceptionResolver 활용
예외가 발생하면 WAS까지 예외가 던져지고, WAS에서 오류 페이지 정보를 찾아서 다시 /error를 호출하는 과정은 너무 복잡하다. ExceptionResolver를 활용하면 예외가 발생했을 때 이런 복잡한 과정 없이 여기서 문제를 해결할 수 있다.
우선 사용자 정의 예외를 하나 추가해보자.
public class UserException extends RuntimeException {
public UserException() {
super();
}
public UserException(String message) {
super(message);
}
public UserException(String message, Throwable cause) {
super(message, cause);
}
public UserException(Throwable cause) {
super(cause);
}
protected UserException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
super(message, cause, enableSuppression, writableStackTrace);
}
}
ApiExceptionController에 예외를 추가하자.
@Slf4j
@RestController
public class ApiExceptionController {
@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("잘못된 입력 값");
}
if (id.equals("user-ex")) {
throw new UserException("사용자 오류");
}
return new MemberDto(id, "hello " + id);
}
localhost:8080/api/members/user-ex 호출시 UserException이 발생하도록 해두었다.
이에 이 예외를 철기하는 UserHandlerExceptionResolver를 만들어보자.
@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");
String acceptHeader = request.getHeader("accept");
response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
if ("application/json".equals(acceptHeader)) {
Map<String, Object> errorResult = new HashMap<>();
errorResult.put("ex", ex.getClass());
errorResult.put("message", ex.getMessage());
String result = objectMapper.writeValueAsString(errorResult);
response.setContentType("application/json");
response.setCharacterEncoding("utf-8");
response.getWriter().write(result);
return new ModelAndView();
} else {
// TEXT/HTML
return new ModelAndView("error/500");
}
}
} catch (IOException e) {
log.error("resolver ex", e);
}
return null;
}
}
HTTP 요청 헤더의 ACCEPT 값이 application/json이면 JSON으로 오류를 내려주고 그 외의 경우 error/500에 있는 HTML 오류 페이지를 보여주도록 개발하였다.
이제 Config클래스에 만들어놓은 UserHandlerExceptionResolver를 추가하고 Postman으로 값을 찔러보도록 하자.
@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
resolvers.add(new MyHandlerExceptionResolver());
resolvers.add(new UserHandlerExceptionResolver());
}
정리
ExceptionResolver를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver에서 예외를 처리해버린다.
따라서 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리가 끝이 난다.
결과적으로 WAS입장에서는 정상 처리가 된 것이다. 이렇게 예외를 이곳에서 모두 처리할 수 있다는 것이 핵심이다.
서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 추가 프로세스가 실행된다. 반면에 ExceptionResolver를 사용하면 예외처리가 상당히 깔끔해진다.
그런데 직접 ExceptionResolver를 구현하려고 하니 상당히 복잡하다. 지금부터 스프링이 제공하는 ExceptionResolver를 알아보자.
API 예외 처리 - 스프링이 제공하는 ExceptionResolver1
스프링 부트가 기본으로 제공하는 ExceptionResolver는 다음과 같다.
HandlerExceptionResolverComposite에 다음 순서로 등록
1. ExceptionHandlerExceptionResolver
2. ResponseStatusExceptionResolver
3. DefaultHandlerExceptionResolver --> 우선 순위가 가장 낮음
ExceptionHandlerExceptionResolver
@ExceptionHandler를 처리한다. API 예외 처리는 대부분 이 기능으로 해결한다.
ResponseStatusExceptionResolver
HTTP 상태 코드를 지정해준다
예) @ResponseStatus(value = HttpStatus.NOT_FOUND)
DefaultHandlerExceptionResolver
스프링 내부 기본 예외를 처리한다.
먼저 가장 쉬운 ResponseStatusExceptionResolver부터 알아보자.
ResponseStatusExceptionResolver
ResponseStatusExceptionResolver는 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.
다음 두가지 경우를 처리한다.
1. @ResponseStatus가 달려있는 예외
2. ResponseStatusException 예외
하나씩 확인해보자.
예외에 다음과 같이 @ResponseStatus 애노테이션을 적용하면 HTTP 상태 코드를 변경해준다.
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException{
}
BadRequestException 예외가 컨트롤러 밖으로 넘어가면 ResponseStatusExceptionResolver예외가 해당 애노테이션을 확인해서 오류 코드를 HttpStatus.BAD_REQUEST(400)으로 변경하고, 메시지도 담는다.
ResponseStatusExceptionResolver코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason)를 호출하는 것을 확인할 수 있다.
sendError(400)를 호출했기 때문에 WAS에서 다시 오류 페이지(/error)를 내부 요청한다.
@GetMapping("/api/response-status-ex1")
public String responseStatusEx1() {
throw new BadRequestException();
}
postman으로 찔러보면 다음과 같은 결과가 나온다.
reason을 MessageSource에서 찾는 기능도 제공한다. reason = "error.bad"
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException{
}
application.properties에 있는
server.error.include-message=on_param위 코드를 always로 변경해주던가, postman으로 찌를때 요청파라미터를 넣어주도록 하자.
ResponseStatusException의 한계
@ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다.(애노테이션을 직접 넣어야 하는데, 내가 코드를 수정할 수 없는 라이브러리의 예외 코드 같은 곳에는 적용할 수 없다.)
추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다 . 이때는 ResponseStatusException 예외를 사용하도록 하자.
@GetMapping("/api/response-status-ex2")
public String responseStatusEx2() {
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new IllegalArgumentException());
}
API 예외 처리 - 스프링이 제공하는 ExceptionResolver2
이번에는 DefaultHandlerExceptionResolver를 살펴보자
DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결한다.
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데, 이 경우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다.
그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어있다.
DefaultHandlerExceptionResolver는 이것을 500오류가 아니라, HTTP 상태 코드 400 오류로 변경한다.
스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.
코드 확인
DefaultHandlerExceptionResolver.handleTypeMismatch를 보면 다음과 같은 코드를 확인할 수 있다.
response.sendError(HttpServletResponse.SC_BAD_REQUEST) --> 400
결국 response.sendError()를 통해 문제를 해결한다.
sendError(400)를 호출했기 떄문에 WAS에서 다시 오류페이지(/error)를 내부 요청한다.
ApiExceptionController에 코드를 추가해보자.
@GetMapping("/api/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
return "ok";
}
요청파라미터가 숫자일땐 정상적으로 ok가 리턴되지만
숫자가 아닌 문자열이 들어가게 되면, TypeMismatchException이 발생하게 된다.
정리
지금까지 다음 ExceptionResolver들에 대해 알아보았다.
1. ExceptionHandlerExceptionResolver -- 아직 안알아봄
2. ResponseStatusExceptionResolver -- HTTP 응답 코드 변경
3. DefaultHandlerExceptionResolver -- 스프링 내부 예외 처리
지금까지 HTTP 상태 코드를 변경하고, 스프링 내부 예외의 상태 코드를 변경하는 기능도 알아보았다. 그런데 HandlerExceptionResolver를 직접 사용하기는 복잡하다. API 오류 응답의 경우, response에 직접 데이터를 넣어야해서 매우 불편하고 번거롭다. ModelAndView를 반환해야 하는것도 API에는 잘 맞지 않는다.
스프링은 이 문제를 해결하기 위해 @ExceptionHandler라는 매우 혁신적인 예외 처리 기능을 제공한다.
---> 이것이 ExceptionHandlerExceptionResolver이다.
API 예외 처리 - @ExceptionHandler
웹 브라우저에 HTML 화면을 제공할 때는 오류가 발생하면 BasicErrorController를 사용하는게 편하다.
이때는 단순히 5xx, 4xx 관련된 오류 화면을 보여주면 된다. BasicErrorController는 이런 메커니즘을 모두 구현해두었다.
그런데 API는 각 시스템마다 응답의 모양도 다르고, 스펙도 모두 다르다. 예외 상황에 단순히 오류 화면을 보여주는 것이 아니라, 예외에 따라서 각각 다른 데이터를 출력해야 할 수도 있다. 그리고 같은 예외라고 해도, 어떤 컨트롤러에서 발생했는가에 따라서 다른 예외 응답을 내려주어야 할 수 있다.
--> 매우 세밀한 제어가 필요하다.
앞서 보았지만, 상품 API와 주문 API는 오류가 발생했을 때 응답의 모양이 완전히 다를 수 있다.
결국 지금까지 살펴본 BasicErrorController를 사용하거나, HandlerExceptionResolver를 직접 구현하는 방식으로 API 예외를 다루기는 쉽지 않다.
API 예외처리의 어려운 점
- HandlerExceptionResolver를 떠올려보면 ModelAndView를 반환해야 했었다. 이것은 API 응답에는 필요하지 않다.
- API 응답을 위해 HttpServletResponse에 직접 응답 데이터를 넣어주었다. 이것은 매우 불편하다. 스프링 컨트롤러에 비유하자면 마치 과거 서블릿을 사용하던 시절로 돌아간 것 같다.
- 특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어 회원을 처리하는 컨트롤러에서 발생하는 RuntimeException예외와 상품을 관리하는 컨트롤러에서 발생하는 동일한 RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면 어떻게 해야할까??
@ExceptionHandler
스프링은 API 예외 처리 문제를 해결하기 위해 @ExceptionHandler라는 애노테이션을 사용하는 매우 편리한 예외 처리 기능을 제공한다. 이것이 바로 ExceptionHandlerExceptionResolver 이다.
스프링은 ExceptionHandlerExceptionResolver를 기본으로 제공하고, 기본으로 제공하는 ExceptionResolver중에 우선순위도 가장 높다. 실무에서 API 예외 처리는 대부분 이 기능을 사용한다.
예외가 발생했을떄 API 응답으로 사용할 객체를 정의해보자.
@Data
@AllArgsConstructor
public class ErrorResult {
private String code;
protected String message;
}
위 객체와 @ExceptionHandler를 사용하는 Controller를 만들어보자
@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;
}
}
@ExceptionHandler 예외 처리 방법
@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 해당 컨트롤러에서 예외가 발생하면, 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있다.
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("BAD", e.getMessage());
}
우선 순위
스프링의 우선 순위는 항상 자세한 것이 우선권을 가진다.
자식 예외를 처리하는 @ExceptionHandler가 있을 시엔 자식 예외를 처리하는 @ExceptionHanler가 동작하고, 없으면 부모 예외를 한번에 처리하는 @ExceptionHandler가 동작하게 된다.
@ExceptionHandler에 지정한 부모 클래스는 자식 클래스까지 다 처리할 수 있다. 따라서 자식 예외가 발생하면 부모 예외처리(), 자식예외처리() 모두 호출 대상이 된다. 그런데 둘 중 더 자세한 것이 우선권을 가지므로 자식예외처리()가 호출된다. 물론 부모예외가 호출되면 부모예외처리()만 호출 대상이 되므로 부모예외처리()가 호출된다.
IllegalArgumentException 처리 흐름
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
log.error("[exceptionHandler] ex", e);
return new ErrorResult("BAD", e.getMessage());
}1. 컨트롤러를 호출한 결과(http://localhost:8080/api2/members/bad) 예외가 컨트롤러 밖으로 던져진다.
2. 예외가 발생했으므로 ExceptionResolver가 작동한다. 가장 우선순위가 높은 ExceptionHandlerExceptionResolver가 실행된다.
3. ExceptionHandlerExceptionResolver는 해당 컨트롤러에 IllegalArgumentException을 처리할 수 있는 @ExceptionHandler가 있는지 확인한다.
4. illegalExHandle()을 실행한다. @RestController이므로 illegalExHandle()에도 @ResponseBody가 적용된다. 따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같든 JSON으로 반환된다.
5. @ResponseStatus(HttpStatus.BAS_REQUEST)를 지정했으므로 HTTP 상태 코드 400으로 응답한다.
** 이전엔 오류가 발생하면 WAS까지 올라갔다 다시 내려오는 흐름이였지만, @ExceptionHandler를 사용하면 정상흐름으로 처리가 된다. 따라서 상태 코드가 200이 되지만 @ResponseStatus를 통해 상태 코드를 조율해주어야 한다.
API 예외 처리 - @ControllerAdvice
@ExceptionHandler를 사용해서 예외를 깔끔하게 처리할 수 있게 되었지만, 정상 코드와 예외 처리 코드가 하나의 컨트롤러에 섞여있다. @ControllerAdvice 또는 @RestControllerAdvice를 사용하면 둘을 분리할 수 있다.
기존 컨트롤러에 있던 예외 처리 코드를 따로 떼네어 ExControllerAdvice 클래스를 만들자.
@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", "내부 오류");
}
}
postman을 사용해보면 기존과 동일하게 동작하는 것을 확인할 수 있다.
@ControllerAdvice
- @ControllerAdvice는 대상으로 지정한 여러 컨트롤러에 @ExceptionHandler, @InitBinder 기능을 부여해주는 역할을 한다.
- @ControllerAdvice에 대상을 지정하지 않으면 모든 컨트롤러에 적용된다.(글로벌 적용)
- @RestControllerAdvice는 @ControllerAdvice와 같고, @ResponseBody가 추가되어있다. --> @Controller와 @RestController의 차이 같은 느낌이다.
@ControllerAdvice는 대상 컨트롤러를 지정할 수도 있다.
1. 특정 애노테이션이 있는 컨트롤러를 지정
2. 특정 패키지를 직접 지정
3. 특정 클래스를 지정
자세한 사항은 스프링 공식 문서를 참고하자.
https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-advice.html
--> 만약 대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다.
정리
@ExceptionHandler와 @ControllerAdvice를 조합하면 예외를 깔끔하게 해결할 수 있다.
'공부 > Spring' 카테고리의 다른 글
| 스프링 타입 컨버터 (1) | 2025.04.15 |
|---|---|
| 예외 처리와 오류 페이지 (0) | 2025.04.10 |
| 로그인 처리2 - 필터, 인터셉터 (1) | 2025.04.08 |
| 로그인 처리1 - 쿠키, 세션 (1) | 2025.04.07 |
| 검증2 - Bean Validation (1) | 2025.04.03 |