김영한 스프링 MVC 2편 - 예외 처리와 오류 페이지
스프링이 아닌 순수 서블리 컨테이너에서 예외를 어떻게 처리하는 알아본다.
자바에서 메인 메소드가 실행되면 main이라는 이름의 쓰레드가 실행된다.
실행 도중에 예외를 잡지 못하고 처음 실행한 main 메소드로 넘어와서 예외가 던져지면 쓰레드가 종료된다.
반면 웹 애플리케이션은 사용자 요청별로 쓰레드가 할당되고 서블릿 컨테이너 안에서 실행된다.
만약 애플리케이션이 예외를 못 잡고, 서블릿까지 예외가 전달되면 WAS까지 결국 전달되어 500에러 발생한다.
(WAS - 필터 - 서블릿 - 인터셉터 - 컨트롤러)
스프링 부트를 통해서 서블릿 컨테이너를 사용하기 때문에 스프링 부트가 제공하는 기능을 이용해 서블릿 오류페이지를 등록해보겠다.
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
@Override
public void customize(ConfigurableWebServerFactory factory) {
ErrorPage errorPage400 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/400");
ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
//런타임 예외 또는 그 자식 타입의 예외
ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");
factory.addErrorPages(errorPage400, errorPage500, errorPageEx);
}
}
해당 오류를 처리할 컨트롤러 작성
@Slf4j
public class ErrorPageController {
@RequestMapping("/error-page/404")
public String errorPage404(HttpServletRequest request, HttpServletResponse response) {
log.info("errorPage 404");
return "error/error-page/404";
}
@RequestMapping("/error-page/500")
public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
log.info("errorPage 500");
return "error/error-page/500";
}
}
서블릿은 예외가 발생하면 서블릿 밖으로 전달하거나 response.sendError()가 호출될 때 설정된 페이지로 이동한다.
WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러 예외발생!
WAS(sendError 호출 기록 확인) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러
전달된 후 WAS는 오류페이지를 출력하기 위해 /error-page/500 또 다시 요청한다.
WAS '/error-page/500' -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> view
이때 단순히 다시 요청하기는 것이 아닌 오류 정보를 request의 attribute에 추가해서 넘겨준다.
그래서 필요하다면 오류 페이지에서 전달된 오류 정보도 확인할 수 있다.
//예외
public static final String ERROR_EXCEPTION = "javax.servlet.error.exception";
//예외타입
public static final String ERROR_EXCEPTION_TYPE = "javax.servlet.error.exception_type";
//오류 메시지
public static final String ERROR_MESSAGE = "javax.servlet.error.message";
//클라이언트 요청 URI
public static final String ERROR_REQUEST_URI = "javax.servlet.error.request_uri";
//오류가 발생한 서블릿 이름
public static final String ERROR_SERVLET_NAME = "javax.servlet.error.servlet_name";
//HTTP 상태코드
public static final String ERROR_STATUS_CODE = "javax.servlet.error.status_code";
private void printErrorInfo(HttpServletRequest request) {
log.info("ERROR_EXCEPTION: ex=", request.getAttribute(ERROR_EXCEPTION));
log.info("ERROR_EXCEPTION_TYPE: {}", request.getAttribute(ERROR_EXCEPTION_TYPE));
log.info("ERROR_MESSAGE: {}", request.getAttribute(ERROR_MESSAGE)); //ex의 경우 NestedServletException 스프링이 한번 감싸서 반환
log.info("ERROR_REQUEST_URI: {}", request.getAttribute(ERROR_REQUEST_URI));
log.info("ERROR_SERVLET_NAME: {}", request.getAttribute(ERROR_SERVLET_NAME));
log.info("ERROR_STATUS_CODE: {}", request.getAttribute(ERROR_STATUS_CODE));
log.info("dispatchType={}", request.getDispatcherType());
}
@RequestMapping("/error-page/404")
public String errorPage404(HttpServletRequest request, HttpServletResponse response) {
printErrorInfo(request);
log.info("errorPage 404");
return "error/error-page/404";
}
근데 다시 생각해보자...😎
오류가 발생해서 WAS에서 다시 호출한다면 필터, 서블릿, 인터셉터 호출 됐던 구간이 또 호출된다. 매우 비효율적!
사용자로부터 발생한 정상요청인지, 오류페이지를 위한 요청인지 구분하면 편하다.
서블릿은 이러한 문제를 해결하기 위해 DispatcherType 정보를 제공한다.
//오류페이지면 ERROR, 사용자 요청이면 REQUEST
request.getDispatcherType();
public enum DispatcherType {
//JSP
FORWARD,
INCLUDE,
//사용자 정상 요청
REQUEST,
//서블릿 비동기 호출
ASYNC,
//오류 요청
ERROR
}
필터에서 DispatcherType을 알아보자
@Slf4j
public class ExceptionLogFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
HttpServletRequest httpServletRequest = (HttpServletRequest) request;
String requestURI = httpServletRequest.getRequestURI();
String uuid = UUID.randomUUID().toString();
try {
log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
chain.doFilter(request, response);
} catch (Exception e) {
throw e;
} finally {
log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
}
}
}@Configuration
public class ExceptionConfig implements WebMvcConfigurer {
@Bean
public FilterRegistrationBean logFilter() {
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new ExceptionLogFilter());
filterRegistrationBean.setOrder(1);
filterRegistrationBean.addUrlPatterns("/*");
//클라이언트 요청과 오류 페이지 요청에 필터가 호출됨
filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);
return filterRegistrationBean;
}
}
이번엔 인터셉터에서 중복 호출 제거해본다.
@Slf4j
public class ExceptionLogInterceptor implements HandlerInterceptor {
public static final String LOG_ID = "logId";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String requestURI = request.getRequestURI();
String uuid = UUID.randomUUID().toString();
request.setAttribute(LOG_ID, uuid);
log.info("REQUEST [{}][{}][{}][{}]", uuid, request.getDispatcherType(), requestURI, handler);
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
log.info("postHandle [{}]", modelAndView);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
String requestURI = request.getRequestURI();
String logId = (String)request.getAttribute(LOG_ID);
log.info("RESPONSE [{}][{}][{}]", logId, request.getDispatcherType(), requestURI);
if (ex != null) {
log.error("afterCompletion error!!", ex);
}
}
}
필터는 DisPatcherType으로 적용했다면 인터셉터는 설정할 때 오류 페이지 경로를 빼면 된다.
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new ExceptionLogInterceptor())
.order(1)
.addPathPatterns("/**")
//제외 경로
.excludePathPatterns(
"/css/**", "/*.ico",
"/error", "/error-page/**" //오류 페이지 경로
);
}
흐름을 정리해본다.
WAS (REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 (예외 발생!) -> 인터셉터 -> 서블릿 -> 필터 -> WAS
WAS에서 오류 페이지 확인 -> 필터(X) -> 서블릿 -> 인터섭테(X) -> 컨트롤러 -> view
지금까지 예외 처리 페이지를 힘겹게 만들었다.
WebServerCustomizer 만들고, 오류 종류마다 페이지 작성하고, 예외 처리용 컨트롤러도 만듬
스프링 부트는 이런 과정을 기본적으로 제공한다. (BasicErrorController)
1. 뷰 템플릿
resources/templates/error/500.html
2. 정적 리소스(static, public)
resources/static/error/400.html
resources/static/error/404.html
resources/static/error/4xx.html
3. 적용 대상이 없을 때 뷰이름
resources/templates/error.html
컨트롤러는 오류 정보를 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`)<li th:text="|path: ${path}|"></li>
<li th:text="|status: ${status}|"></li>
<li th:text="|message: ${message}|"></li>
<li th:text="|error: ${error}|"></li>
<li th:text="|exception: ${exception}|"></li>
<li th:text="|errors: ${errors}|"></li>
<li th:text="|trace: ${trace}|"></li>
사용자에게 오류 메시지를 구체적으로 보여주는건 옳지 못하다.
application.properties에서 설정하면 된다.
naver 사용하지 않음 / always 항상 사용 / on_param 파라미터가 있을 때만(개발서버에만 사용할 것)
#exception 포함 여부
server.error.include-exception=true
#message 포함 여부
server.error.include-message=on_param
#trace 포함 여부
server.error.include-stacktrace=on_param
#errors
server.error.include-binding-errors=on_param
#오류 화면 못 찾을 때 화이트라벨 오류페이지 적용여부
server.error.whitelabel.enabled=true
#오류 페이지 경로
server.error.path=/error
김영한, 스프링 MVC 2편