예외처리와 오류 페이지
스프링이 아닌 순수 서블릿 예외처리는 2가지이다.
Exeption
response.sendError(HTTP 상태코드, 오류 메시지)
Exception
자바 직접 실행
- 자바의 메인 메서드를 실행 할 경우 main이라는 이름의 쓰레드가 실행되는데 이때 예외가 발생하면 (예외처리 하지 않았을 경우) 예외 정보를 남기고 해당 쓰레드가 종료된다.
웹 애플리케이션
웹 애플리케이션은 사용자 요청별로 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다. 애플리케이션에서 예외가 발생했는데 try-catch로 예외를 잡아서 처리하면 문제가 없지만, 예외를 잡지 못하고, 서블릿 밖으로 예외가 전달되면 어떻게 동작 할까?
WAS <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외 시작)
이렇게 되면 톰켓까지 예외가 던져진다.
@Slf4j
@Controller
public class ServletExceptionController {
@GetMapping("/error-ex")
public void errorEx() {
throw new RuntimeException("예외 발생!");
}
}
예외를 만들어서 요청했다.
이때 응답헤더를 보면 상태코드가 500이다. (Internal Server error)
Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP상태코드
500을 반환한다.
response.sendError(http상테코드, 오류메시지)
@GetMapping("/error-404")
public void error404(HttpServletResponse response) throws IOException {
response.sendError(404, "404 오류!");
}
@GetMapping("/error-500")
public void error500(HttpServletResponse response) throws IOException {
response.sendError(500);
}
오류가 발생했을 때 HttpServletResponse가 제공하는 sendError는 메서드를 사용할 수 있다.
서블릿 컨테이너에게 오류가 발생했다는 점을 전달 할 수 있다. 이 메서드에는 상태코드와 오류메시지를 추가한다.
상태코드만 추가할 수 있다. response.sendError를 호출하면 response에 오류 상태를 저장했다가
서블릿 컨테이너가 고객에게 응답하기 전에 respnse.sendError가 호출되었는지 확인하고 호출되었다면 설정한 오류코드에 맞추어서 기본 오류 페이지를 보여준다.
서블릿 컨테이너가 제공하는 기본 예외처리 화면은 별로이다.
서블릿은 Exception이 발생해서 서블릿 밖으로 전달되거나 또는 response.Error가 호출 되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다.
WAS(sendError 호출 기록 확인) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(response.sendError())
과거에는 web.xml에 오류 화면을 등록했다.
package hello.exception.serlvet;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Slf4j
@Controller
public class ServletExceptionController {
@GetMapping("/error-ex")
public void errorEx() {
throw new RuntimeException("예외 발생!");
}
@GetMapping("/error-404")
public void error404(HttpServletResponse response) throws IOException {
response.sendError(404, "404 오류!");
}
@GetMapping("/error-500")
public void error500(HttpServletResponse response) throws IOException {
response.sendError(500);
}
}
localhost:8080/error-500을 요청
package hello.exception;
import org.springframework.boot.web.server.ConfigurableWebServerFactory;
import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
//기본 오류페이지 커스터마이즈
@Override
public void customize(ConfigurableWebServerFactory factory) {
ErrorPage errorPage400 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");//404일때 path 를 호출해라.
ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");//500일때 path 를 호출해라.
ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");
factory.addErrorPages(errorPage400, errorPage500, errorPageEx);
}
}
상태코드가 500일때 /error-page/500 요청
package hello.exception.serlvet;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Slf4j
@Controller
public class ErrorPageController {
@RequestMapping("/error-page/404")
public String errorPage404(HttpServletRequest request, HttpServletResponse response) {
log.info("errorPage 404");
return "error-page/404";
}
@RequestMapping("/error-page/500")
public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
log.info("errorPage 500");
return "error-page/500";
}
}
오류 페이지는 예외를 다룰때 그 자식의 예외까지 함께 처리한다.
RuntimeExeption의 자식까지 함께 처리한다.
만약 RuntimeExeption이 발생할 경우 errorPageEx에서 지정한 /error-page/500컨트롤러가 호출된다.
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="utf-8">
</head>
<body>
<div class="container" style="max-width: 600px">
<div class="py-5 text-center">
<h2>500 오류 화면</h2>
</div>
<div>
<p>오류 화면 입니다.</p>
</div>
<hr class="my-4">
</div> <!-- /container -->
</body>
</html>
서블릿 예외처리 - 오류 페이지 작동원리
서블릿은 예외가 발생해서 서블릿 밖으로 전달되거나, response.Error가 호출되면
설정된 오류 페이지를 찾는다.
예외발생 흐름
WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
sendError 흐름
WAS(sendError 호출 기록 확인) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(response.senderError())
ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");만약 RuntimeExeption예외가 WAS까지 전달되면 WAS는 오류 페이지 정보를 확인한다.
확인해보니 "/error-page/500"이 지정되어있다. WAS는 "/error-page/500"를 다시 요청해 오류페이지를 출력한다.
이때 중요한것은 사용자는 이 요청을 모른다는것이다. 이것은 서버 내부에서 추가 적으로 일어나는 일임.
@RequestMapping("/error-page/500")
public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
log.info("errorPage 500");
return "error-page/500";
}
WAS가 '/error-page/500' 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View
예외 발생시 오류 페이지 요청 흐름
WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
WAS가 '/error-page/500' 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러 -> View
오류 페이지를 나타내기 위해 서버 내부에서 다시 한번 호출을 하는데 이때 서블릿, 인터셉터 모두 다시 호출된다.
그런데 로그인 인증체크 같은 경우 이미 필터나 인터셉터에서 인증체크를 했는데 오류 페이지를 호출한다고 해서 이 인증과정을 다시 거치는 것은 매우 비효율적이다.
그래서 클라이언트러부터 받은 요청인지, 오류 페이지를 출력하기 위한 내부 요청인지 구분 하기 위해
DispatcherType이라는 정보를 제공한다.
필터와 DispatcherType
package hello.exception.filter;
import lombok.extern.slf4j.Slf4j;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.UUID;
@Slf4j
public class LogFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
log.info("log filter init");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
HttpServletRequest httpRequest = (HttpServletRequest) request;
String requestURI = httpRequest.getRequestURI();
String uuid = UUID.randomUUID().toString();
try {
log.info("REQUEST [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
chain.doFilter(request, response);
} catch (Exception e) {
throw e;
} finally {
log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
}
}
@Override
public void destroy() {
log.info("log filter destroy");
}
}
log를 출력할때 request.getDispatcherType()을 출력한다.
public class WebConfig implements WebMvcConfigurer {
@Bean
public FilterRegistrationBean logFilter() {
FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
filterRegistrationBean.setFilter(new LogFilter());
filterRegistrationBean.setOrder(1);
filterRegistrationBean.addUrlPatterns("/*");
filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);
return filterRegistrationBean;
}
}
filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);이렇게 두가지 reqest, error를 넣어두면 클라이언트 요청과 오류페이지 요청 둘다 필터가 호출된다.
기본값은 Dispatcher.REQUEST이다.
서블릿 예외처리 - 인터셉터
필터의 경우 DispatcherType에 따라 필터가 적용될지 안될지 선택할 수 있었다.
그런데 인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이므로 DispatcherType과는 무관하게 항상 호출된다.
@Slf4j
public class LogInterceptor 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);
}
}
}
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LogInterceptor())
.order(1)
.addPathPatterns("/**")
.excludePathPatterns("/css/**", "/*.ico", "/error", "/error-page/**"); //오류 페이지 경로
}그래서 인터셉터는 excludePathPattenrs를 통해 오류 페이지 경로를 제외시킨다.
/error-page/500이 서버 내부에서 호출되면 인터셉터가 호출되지 않는다. 왜냐하면 경로를 제외 시켰기 때문에.
정리
필터는 DispatcherType.ERROR로 중복 호출제거, 인터셉터는 excludePathPattenrs로 경로 정보로 중복 호출 제거
1. WAS(/error-ex, dispatchType=REQUEST) -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러
2. WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
3. WAS 오류 페이지 확인
4. WAS(/error-page/500, dispatchType=ERROR) -> 필터(x) -> 서블릿 -> 인터셉터(x) ->
컨트롤러(/error-page/500) -> View
스프링 부트 - 오류페이지
지금까지 예외처리 페이지를 만들려면 WebServerCustomizer를 만들어서 예외 종류에 따라 ErrorPage를 추가하고
예외 처리용 컨트롤러 ErrorPageController를 만들었다.
스프링부트는 이런 과정을 모두 기본으로 제공한다.(위에 과정이 필요없이 html화면만 만들면 됨.)
ErrorPage를 자동으로 등록해서 /error 라는 경로로 기본 오류 페이지 등록한다.
상태코드와 예외를 설정하지 않으면 기본 오류페이지로 사용.
서블릿 밖으로 예외 발생하거나 response.sendError 호출하면 /error가 호출된다.
BasicErrorController라는 스프링 컨트롤러를 자동으로 등록한다.(Errorpage에서 등록한 /error를 매핑하는 컨트롤러)
오류 페이지 등록!!
BasicController는 기본적인 로직이 개발되어있음.
우리는 오류 페이지 화면만 BasicController가 제공하는 룰과 우선순위에 따라 등록하면 됨.
뷰 선택 우선순위는
1. 뷰 템플릿
2. 정적리소스
3. 적용 대상 없을 때 뷰 이름(resources/templates.error.html)
해당 경로 위치에 상태코드 이름의 뷰파일을 넣으면 되는데
404가 4xx보다 우선순위가 높음. 구체적인것이 우선순위가 높다.