API 예외 처리 - HandlerExceptionResolver

API 예외처리

예외가 발생해서 Servlet을 넘어 WAS까지 예외가 전달되면 HTTP 상태코드가 500으로 처리되도록 설계 했다고 가정해보자. 이 때 발생하는 예외에 따라서 400, 404등등 다른 상태코드도 처리하고 싶다.

예제)
예를 들어 IllegalArgumentException을 처리하지 못해서 컨트롤러 밖으러 넘어가는 일이 발생하면 HTTP 상태 코드를 400으로 처리하고 싶다. 어떻게 해야 할까?

@RestController
public class ApiExceptionController {
    @GetMapping("/api/members/{id}")
    public MemberDto getMember(@PathVariable("id") String id) {
        if ("ex".equals(id)) {
            throw new RuntimeException("잘못된 사용자");
        }
        if ("bad".equals(id)) {
            throw new IllegalArgumentException("잘못된 입력값");
        }
        return new MemberDto(id, "hello " + id);
    }
}

HandlerExceptionResolver

스프링 MVC는 컨트롤러 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다. 컨트롤러 밖으로 던져진 예외를 해결하고, 동작 방식을 변경하고 싶으면 HandlerExceptionResolver를 사용하면 된다.
줄여서 ExceptionResolver라 한다.

ExceptionHandler가 적용되기 전에는 WAS에서 DispatcherServlet을 호출하면 DispatcherSevlet은 preHandle을 호출하고 그 다음 handle에서 핸들러 어댑터를 호출하고 Controller를 호출했는데 여기서 예외가 발생하면 DispatcherServlet에게 발생한 예외를 전달하고 postHandle은 호출이 되지 않고 afterCompletion 호출 후 WAS에게 그 예외를 전달하는 방식이였다.
이 때 WAS는 예외를 받고 서버에서 일어난 예외로 생각하기 때문에 500에러를 던져준다.

ExceptionHandler가 적용된 후에는 WAS에서 DispatcherServlet을 호출하면 DispatcherSevlet은 preHandle을 호출하고 그 다음 handle에서 핸들러 어댑터를 호출하고 Controller를 호출했는데 여기서 예외가 발생하면 DispatcherServlet에게 발생한 예외를 전달한다.
이 때 DispatcherServlet은 ExceptionResolver를 호출한다. ExceptionHandler는 발생한 예외를 해결할려고 하는데 이 때 해결이 된다면 render(model)을 호출하고 정상 응답으로 WAS에게 보낼 수 있다.
즉 쉽게 말해 ExceptionResolver는 예외를 해결해주는 해결사라고 생각하면 좋다.
cf) ExceptionHandler가 적용되도 postHandler은 마찬가지로 호출되지 않는다.

HandlerExceptionResolver - 인터페이스

public interface HandlerExceptionResolver {

	@Nullable
	ModelAndView resolveException(
			HttpServletRequest request, HttpServletResponse response,
            		@Nullable Object handler, Exception ex);

}

handler : 핸들러 정보
Exception ex : 핸들러(Controller)에서 발생한 예외

HandlerExceptionResolver - 구현

@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);
            e.printStackTrace();
        }
        return null;
    }
}

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        resolvers.add(new MyHandlerExceptionResolver());
    }
    

ExceptionHandler을 구현해서 IllegalArgumentException이 발생하면 response.sendError()에 400에러를 넣어주고
return new ModelAndView(); 새로운 ModelAndView 객체를 빈값으로 반환해주면 정상적인 흐름으로 응답되기 때문에 WAS까지 정상 응답으로 전달된다.
즉 Controller에서 발생한 예외를 ExceptionHandler에서 받아서 이 예외를 해결하고 정상 응답으로 리턴해준다.

ExceptionHandler가 ModelAndView를 반환하는 이유는 마치 try,catch 하듯이, Exception을 처리해서 정상 흐름 처럼 변경하는 것이 목적이다. 이름 그대로 Exception을 Resolver(해결)하는 것이 목적이다.
위의 코드는 IllegalArgumentException이 발생하면 response.sendError(400)을 호출해서 HTTP 상태 코드를 400으로 지정하고 빈 ModelAndView를 반환한다.

반환 값에 따른 동작 방식

HandlerExceptionResolver의 반환 값에 따른 DispatcherSevlet의 동작 방식은 다음과 같다.

• 빈 ModelAndView : new ModelAndView()처럼 빈 ModelAndView를 반환하면 뷰를 렌더링 하지 않고, 정상 흐름으로 Servlet이 리턴된다.
• ModelAndView 지정 : ModelAndViewㅇ에 View,Model 등의 정보를 지정해서 반환하면 뷰를 렌더링 한다.
• null : null을 반환하면 다음 ExceptionResolver를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResolver가 없으면 예외 처리가 안되고, 기존에 발생한 예외를 Servlet 밖으로 던진다. --> WAS에 정상 응답이 아닌 예외 발생이 전달된다.

ExceptionResolver 활용

1. 예외 상태 코드 변환
   • 예외를 response.sendError(xxx) 호출로 변경해서 Servlet에서 상태 코드에 따른 오류를 처리하도록 위임
   • 이후 WAS는 Servelt 오류 페이지를 찾아서 내부 호출, 예를 들어서 스프링 부트가 기본으로 설정한 /error가 호출됨
2. 뷰 템플릿 처리
   • ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면을 뷰 렌더링해서 클라이언트에게 제공
3. API 응답 처리
   • response.getWriter().print("hello");
   • 위의 코드 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다. 여기에 JSON으로 응답하면 API 응답 처리를 할 수 있다.