서블릿 예외 처리 - 인터셉터
인터셉터 중복 호출 제거
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor())
.order(1)
.addPathPatterns("/**")
.excludePathPatterns("/css/**", "*.ico", "/error", "/error-page/**"); //오류 페이지 경로
}인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이다. 따라서 DispatcherType 과 무관하게 항상 호출된다. 대신 인터셉터는 요청 경로를 추가하거나 제외하기 쉽게 되어 있기 때문에, excludePathPatterns 를 사용하여 오류 페이지 경로를 제외한다.
여기에서 /error-page/** 를 제거하면 error-page/500 같은 내부 호출의 경우에도 인터셉터가 호출된다
참고: 예외 발생시 인터셉터의 postHandle는 호출되지 않는다. 따라서 예외 관련 로직은 afterCompletion 에 포함하자. 오류 페이지를 띄우는 내부 호출의 경우는 정상 작동이기 때문에 postHandle 호출된다.
전체 흐름 정리
/hello 정상 요청
WAS(/hello, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View
/error-ex 오류 요청
필터는 DispatchType 으로 중복 호출 제거 ( dispatchType=REQUEST )
인터셉터는 경로 정보로 중복 호출 제거( excludePathPatterns("/error-page/**") )
1. WAS(/error-ex, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러
2. WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
3. WAS 오류 페이지 확인
4. WAS(/error-page/500, dispatchType=ERROR) -> 서블릿 -> 컨트롤러(/error-page/500) -> View
스프링 부트 - 오류 페이지1
지금까지 예외 처리 페이지를 만들기 위해서 다음과 같은 복잡한 과정을 거쳤다.
WebServerCustomizer 를 만들고
예외 종류에 따라서 ErrorPage 를 추가하고
예외 처리용 컨트롤러 ErrorPageController 를 만듬
스프링 부트는 이런 과정을 모두 기본으로 제공한다.
ErrorPage 자동 등록. 이때 /error 라는 경로로 기본 오류 페이지를 설정한다.
-new ErrorPage("/error") 상태코드와 예외를 설정하지 않으면 기본 오류 페이지로 사용
-서블릿 밖으로 예외가 발생하거나, response.sendError(...) 가 호출되면 모든 오류는 /error 를 호출
BasicErrorController 라는 스프링 컨트롤러 자동 등록: ErrorPage 에서 등록한 /error 를 매핑하여 처리
참고: ErrorMvcAutoConfiguration 이라는 클래스가 오류 페이지를 자동으로 등록하는 역할을 한다.
이제 오류가 발생했을 때 오류 페이지로 /error 를 기본 요청한다.
스프링 부트가 자동 등록한 BasicErrorController 는 이 경로를 기본으로 받는다.
개발자는 오류 페이지만 등록
개발자는 오류 페이지 화면(HTML)만 BasicErrorController 가 제공하는 룰과 우선순위에 따라서 등록하면 된다.
뷰 선택 우선순위
BasicErrorController 의 처리 순서
1. 뷰 템플릿
resources/templates/error/500.html
resources/templates/error/5xx.html
2. 정적 리소스( static , public )
resources/static/error/400.html
resources/static/error/404.html
resources/static/error/4xx.html
3. 적용 대상이 없을 때 뷰 이름( error )
resources/templates/error.html
해당 경로 위치에 HTTP 상태 코드 이름의 뷰 파일을 넣어두면 된다.
404, 500처럼 구체적인 것이 5xx처럼 덜 구체적인 것 보다 우선순위가 높다.
스프링 부트 - 오류 페이지2
BasicErrorController가 제공하는 기본 정보들
BasicErrorController 컨트롤러는 다음 정보를 model에 담아서 뷰에 전달한다.
뷰 템플릿은 이 값을 활용해서 출력할 수 있다.
* timestamp: Fri Feb 05 00:00:00 KST 2021
* status: 400
* error: Bad Request
* exception: org.springframework.validation.BindException
* trace: 예외 trace
* message: Validation failed for object='data'. Error count: 1
* errors: Errors(BindingResult)
* path: 클라이언트 요청 경로 (`/hello`)
그러나 오류 관련 내부 정보들을 고객에게 노출하는 것은 좋지 않다. 그래서 BasicErrorController 오류 컨트롤러에서 다음 오류 정보를 model 에 포함할지 여부 선택할 수 있다.
> application.properties
server.error.include-exception=false : exception 포함 여부( true , false )
server.error.include-message=never : message 포함 여부
server.error.include-stacktrace=never : trace 포함 여부
server.error.include-binding-errors=never : errors 포함 여부
기본 값이 never 인 부분은 다음 3가지 옵션을 사용할 수 있다
never : 사용하지 않음
always :항상 사용
on_param : 파라미터가 있을 때 사용
on_param 으로 설정하고 다음과 같이 HTTP 요청시 파라미터를 전달하면 해당 정보들이 model 에 담겨서 뷰 템플릿에서 출력된다.
message=&errors=&trace=
그런데 이 부분도 개발 서버에서 사용할 수 있지만, 운영 서버에서는 권장하지 않는다. 로그를 사용하여 확인하자.
스프링 부트 오류 관련 옵션
server.error.whitelabel.enabled=true : 오류 처리 화면을 못 찾을 시, 스프링 whitelabel 오류 페이지 적용
server.error.path=/error : 오류 페이지 경로, 스프링이 자동 등록하는 서블릿 글로벌 오류 페이지 경로와 BasicErrorController 오류 컨트롤러 경로에 함께 사용된다.
참고: 에러 공통 처리 컨트롤러의 기능을 변경하고 싶으면 ErrorController 인터페이스를 상속 받아서 구현하거나 BasicErrorController 상속 받아서 기능을 추가하면 된다.
9. API 예외 처리
API 예외 처리 - 시작
HTML 페이지의 경우 지금까지 설명했던 것 처럼 4xx, 5xx와 같은 오류 페이지만 있으면 대부분의 문제를 해결할 수 있다. 오류 페이지는 단순히 고객에게 오류 화면을 보여주고 끝이지만, API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다.
@RestController 에 API를 요청했는데, 정상의 경우 API로 JSON 형식으로 데이터가 정상 반환된다. 그런데 오류가 발생하면 미리 만들어둔 오류 페이지 HTML이 반환된다. 클라이언트는 정상 요청이든, 오류 요청이든 JSON이 반환되기를 기대한다. 웹 브라우저가 아닌 이상 HTML을 직접 받아서 할 수 있는 것은 별로 없다.
문제를 해결하려면 오류 페이지 컨트롤러도 JSON 응답을 할 수 있도록 수정해야 한다.
클라이언트 요청 HTTP 메세지 헤더
accept: application/json
@RequestMapping(value = "/error-page/500", produces = MediaType.APPLICATION_JSON_VALUE)
컨트롤러의 produces 옵션에 MediaType.ALLICATION_JSON_VALUE 지정
HTTP Header에 Accept 가 application/json 이 아니면, 기존 오류 응답인 HTML 응답이 출력될 것이다.
API 예외 처리 - 스프링 부트 기본 오류 처리
BasicErrorController의 코드
/error 동일한 경로를 처리하는 errorHtml() , error() 두 메서드
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {}
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}
errorHtml() (produces = MediaType.TEXT_HTML_VALUE) : 클라이언트 요청의 Accept 헤더 값이 text/html 인 경우 호출되어 ModelAndView 를 제공한다.
error() : 그 외 경우 호출되고 ResponseEntity 로 HTTP Body에 JSON 데이터를 반환한다.
스프링 부트의 예외 처리
1. 스프링 부트의 기본 설정은 오류 발생시 /error 를 오류 페이지로 요청한다.
2. BasicErrorController 는 이 경로를 기본으로 받는다. Accept 헤더 값에 따라 메서드 실행한다.
스프링 부트는 BasicErrorController 가 제공하는 기본 정보들을 활용해서 오류 API를 생성해준다.
예외 발생 시 서버 응답 예시
accept: application/json
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 ( Internal server error ) 으로 처리된다. 이것을 발생하는 예외에 따라서 400, 404 등등 다른 상태코드로 처리하기
오류 메시지, 형식등을 API마다 다르게 처리하기
상태 코드 변환
결국 예외가 발생한 것은 서버이기 때문에 Internal server error 가 발생한다.
HandlerExceptionResolver
스프링 MVC는 컨트롤러(핸들러) 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다. 컨트롤러 밖으로 던져진 예외를 해결하고, 동작 방식을 변경하고 싶으면 HandlerExceptionResolver 를 사용하면 된다.
WAS 까지 예외가 전달
서블릿까지 예외가 전달되면 ExceptionResolver 가 호출 -> 예외 해결
WAS 까지 예외가 전달되지 않음
참고: ExceptionResolver 로 예외를 해결해도 postHandle() 은 호출되지 않는다.
public interface HandlerExceptionResolver {
ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex);
}handler : 핸들러(컨트롤러) 정보
ex : 핸들러(컨트롤러)에서 발생한 발생한 예외
ExceptionResolver 가 ModelAndView 를 반환하는 이유는 마치 try, catch를 하듯이, Exception 을 처리해서 정상 흐름 처럼 변경하는 것이 목적이다.
@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 (Exception e){
log.error("resolver ex", e);
}
return null;
}
ExceptionResolver 에 IllegalArgumentException 이 들어오면 response.sendError(400) 를 호출해서 HTTP 상태 코드를 400으로 지정하고 빈 ModelAndView 를 반환한다. 그러면 정상 흐름으로 WAS 까지 반환되고 sendError(400) 을 인식하고 상태 코드 400 에 대한 오류 페이지를 다시 호출한다.
반환 값에 따른 동작 방식
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 응답 처리를 할 수 있다.
ExceptionResolver 등록
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
resolvers.add(new MyHandlerExceptionResolver());
}
...
주의 configureHandlerExceptionResolvers(..) 를 사용하면 스프링이 기본으로 등록하는 ExceptionResolver 가 제거된다. extendHandlerExceptionResolvers 를 사용하자.
API 예외 처리 - HandlerExceptionResolver 활용
예외가 발생하면 WAS까지 예외가 던져지고, WAS에서 오류 페이지 정보를 찾아서 다시 /error 를 호출하는 과정은 생각해보면 너무 복잡하다. ExceptionResolver 를 활용하면 예외가 발생했을 때 이런 복잡한 과정 없이 여기에서 문제를 해결할 수 있다.
@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/404");
}
}
} catch (IOException e){
log.error("resolver ex", e);
}
return null;
}
sendError() 으로 예외를 WAS 에서 처리하게 하는 대신, ExceptionResolver 내에서 직접 response.setStatus() 을 통해 HTTP 상태 코드를 지정하고 적절한 응답( ModelAndView )을 반환하여 예외 처리를 끝낸다.
정리
ExceptionResolver 를 사용하면 예외가 발생해도 서블릿 컨테이너까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리를 끝낼 수 있다. 결과적으로 WAS 입장에서는 정상 처리가 된 것이다.
그런데 직접 ExceptionResolver 를 구현하려고 하니 상당히 복잡하다. 지금부터 스프링이 제공하는 ExceptionResolver 들을 알아보자.
