API 예외 처리 (+HandlerExceptionResolver)

HTML 페이지의 경우는 4xx, 5xx와 같은 에러 페이지만 존재하면 해결할 수 있었다.

에러 페이지는 클라이언트에게 화면만 보여주면 되지만, API는 상황에 맞는 에러 응답 스펙을 클라이언트와 정하고 JSON과 같은 형식으로 데이터를 전달해야 한다.

서블릿 처리 - 에러 페이지를 JSON으로

// [수정 전]
@Component
public class WebServerCustomizer 
		implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {

   @Override
   public void customize(ConfigurableWebServerFactory factory) {
	ErrorPage errorpage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/custom-page");
	...
	...
	factory.addErrorPages(errorpage404, ...);
   } 
}

@RequestMapping("/error/page")
public String errorPage() {
	...
	return "error-page";
}

// [수정 후]
@RequestMapping("/error/page", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<?> errorApi() {
	...
	return ResponseEntity<>(....);
}

수정 전 상황이면, 클라이언트-서버가 JSON 통신을 하는 경우에도 error page를 반환해버린다. 약속했던 데이터 형식이 아니다.

클라이언트에서 Accpet 요청 헤더가 applicaiton/json 이라면, produces를 가진 것이 우선순위를 가지기 때문에 errorApi()를 호출한다.

• Accept가 “/”과 같은 아무거나 들어오면, html을 반환해주는 것이 우선순위가 된다.

컨트롤러 ~ WAS까지 동작은 변함이 없지만, 동일한 requestMapping이 2개가 존재한다면, Accept로 어떤 것을 호출할지 제어할 수 있다.

HandlerExceptionResolver

예외가 서블릿을 지나서 서블릿 컨테이너 WAS까지 예외가 전달되면 상태 코드가 500으로 처리된다.

발생하는 예외에 따라서 400, 404등 다른 상태 코드들도 처리하면서 메시지 등을 API마다 처리하고 싶다.

@PostMapping()
public String result(...) {
   // 예외 발생
   throw new ..Exception()
}

클라이언트가 잘못된 요청을 보내서 4xx 상태 코드를 전달하고 싶지만 500 상태 코드로 발생하게 된다.

바꾸려면 어떻게 해야 할까?

스프링 MVC는 컨트롤러 밖으로 예외가 전파되면 이를 해결하고 동작을 새로 정의할 수 있는 방법을 제공한다.

HandlerExceptionResolver를 사용하면 된다. ExceptionResolver 라고 한다.

ExceptionResolver를 적용하기 전, 예외가 발생하면 다음과 같이 동작한다.

1. WAS에서 DispatcherServlet을 호출한다.

   a. 인터셉터의 preHandle() 호출

   b. 핸들러 어댑터 호출

   c. 컨트롤러 호출 → Exception 발생

2. 컨트롤러에서 예외가 전달되고 postHandle()이 호출되지 않는다.

3. afterCompletion() 호출

4. WAS에 예외가 전달되고 500 상태 코드 반환

ExceptionResolver를 적용하면 적용하기 전의 2번 단계까지는 동일하다.

DispatcherServlet에 예외가 전달되고 ExceptionResolver를 호출해서 예외를 해결하려고 시도한다.

• ExceptionResolver를 통해 예외를 해결해도 postHandle()은 호출되지 않는다.

HandlerExceptionResolver 인터페이스

public interface HandlerExceptionResolver {
	
   ModelAndView resolveException(
	HttpServletRequest request, HttpServletResponse response,
	Object handler, Exception ex
   );
}

• handler : 컨트롤러 정보

• Exception : 컨트롤러에서 발생한 예외

// HandlerExceptionResolver 구현
public class CustomHandlerExceptionResolver implements HandlerExceptionResolver {

   @Override
   public ModelAndView resolveException(...) {
	try {
		if (ex instanceof IllegalArgumentException) {
			response.sendError(HttpServletResponse.SC_BAD_REQUEST, ext.getMessage());
			return new ModelAndView();
		}
	} catch (IOException ex) {
		...
	}
	
	return null;
   }
}

// WebMvcConfigurer 수정 - resolver 등록
@Configuration
public class WebConfig implements WebMvcConfigurer {
   ...

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

구현체를 만들고 등록하게 되면 response.sedError()를 호출하면서 WAS는 400 상태 코드로 인식하게 된다.

• DispatcherServlet은 등록된 ExceptionResolver를 호출하게 된다.

• exception을 sendError()로 변환 한 것이다.

[WebMvcConfigurer 수정 - resolver 등록] WebMvcConfigurer에는 extendHandlerExceptionResolvers()와configureHandlerExceptionResolvers()가 존재하는데, 후자를 사용하게 되면 스프링이 기본으로 제공하는 ExceptionResolver가 제거되므로 정말로 잘 커스텀 해서 사용하지 않는 것이라면, 전자를 택하는 것이 좋을 것 같다.

또, HandlerExceptionResolver의 반환 값에 따라 다르게 동작한다. (resolveException의 반환 값)

1. 빈 ModelAndView

   • return new ModelAndView();

   • 이렇게 반환하면 뷰를 렌더링 하지 않고 정상 흐름으로 서블릿이 리턴된다.

2. ModelAndView 지정

   • View, Model의 정보를 지정해서 반환하고, 뷰를 렌더링 한다.

3. null

   • 지정된 다음 ExceptionResolver를 찾아서 실행한다. 만약 없다면 예외 처리가 되지 않고, 기존에 발생한 예외를 서블릿 밖으로 전달하게 된다.

HandlerExceptionResolver 활용

1. 예외 상태 코드 변환

   • response.sendError()를 호출하여 상태 코드를 변경해서 서블릿에 전달 가능

2. 뷰 템플릿 처리

   • ModelAndView에 값을 채워서 예외에 따른 뷰를 렌더링 할 수 있다.

3. API 응답 처리

   • response.getWriter().println(”hello”)처럼 HTTP response body에 직접 데이터를 넣어서 JSON과 같은 형식으로 응답할 수 있다.

🤔 WebMvcConfigurer에서 resolver를 등록할 때, 호출 순서는?

@Configuration
public class WebConfig implements WebMvcConfigurer {

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

DispatcherServlet은 예외 처리기(resolver)를 등록할 때, 등록된 순서를 유지하고 기본 순서에 따라 정렬하므로, 먼저 등록된 순서대로 호출한다.

호출 순서를 변경하고 싶다면?

DispatcherServlet은 OrderComparator를 사용해서 resolver의 순서를 정렬한다.

HandlerExceptionResolver 인터페이스는 Ordered 인터페이스를 구현할 수 있으며 이를 통해 우선순위를 지정할 수 있다. 구현하지 않으면 기본 우선순위가 적용된다.

public class CustomExceptionResolver1 implements HandlerExceptionResolver, Ordered {
    @Override
    public int getOrder() {
        return 1;
    }

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        // 예외 처리 로직
        return null;
    }
}

public class CustomExceptionResolver2 implements HandlerExceptionResolver, Ordered {
    @Override
    public int getOrder() {
        return 2;
    }

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        // 예외 처리 로직
        return null;
    }
}

Summary

ExceptionResolver를 사용하면 컨트롤러에서 발생한 예외를 resolver에서 처리한다.

그래서 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고 Spring MVC에서 예외 처리가 끝난다.

WAS 입장에서는 예외가 정상 처리된 것이다. resolver를 사용하지 않고 서블릿 컨테이너까지 예외가 전달되면 복잡해지고 추가적인 로직이 실행된다.

직접 ExceptionResolver들을 구현하려고 하면 많이 복잡해지기 때문에, 스프링이 제공하는 ExceptionResolver들을 잘 활용해야 한다.