[Spring MVC]예외 처리와 오류 페이지

1. 서블릿 예외 처리 - 시작

스프링이 아닌 순수 서블릿 컨테이너는 예외를 다음 2가지 방식으로 처리한다.

1. Exception(예외)
2. response.sendError(HTTP 상태 코드, 오류 메시지)

웹 어플리케이션에서는 사용자 요청별로 thread가 할당된다. 해당 thread에서 에외가 발생했는데, try-catch로 예외를 처리하지 못한다면 톰캣 같은 WAS까지 예외가 전달된다.

 

WAS는 Exception이 발생하면 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각하고 HTTP 상태 코드 500을 반환한다.

WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)

이를 확인해보기 위해 기존의 whitelabel.enableds는  false로 변경하고 컨트롤러를 만든다. (스프링 부트가 제공하는 기본 예외 페이지 꺼두기)

 

[ServletExController.java] - 서블릿 예외 컨트롤러

@Slf4j
@Controller
public class ServletExController {

    @GetMapping("/error-ex")
    public void errorEx() {
        throw new RuntimeException("예외 발생!");
    }
}

실행해보면 다음처럼 tomcat이 기본으로 제공하는 오류 화면을 볼 수가 있다. 에러코드는 500을 보여준다.

Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각을 해서 HTTP 상태 코드 500을 반환한다.

 

또한 리소스가 없는 아무 페이지나 호출하면, 톰캣이 기본적으로 제공하는 404 - Not Found를 확인할 수 있다.

 

response.sendError(Http 상태 코드, 오류 메시지)

오류가 발생했을 때 HttpServletResponse가 제공하는 sendError라는 메서드를 사용해도 되는데 이것을 호출한다고 당장 예외가 발생하는 것은 아니지만, 서블릿 컨테이너에게 오류가 발생했다는 것을 전달할 수 있다. 

또한 HTTP 상태 코드와 오류 메시지도 추가할 수 있다.

 

[ServletExController.java] - 추가

    //Exception이 터지면 서블릿 컨테이너는 500으로 처리한다.

    @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);
    }

response.sendError()를 호출하게 되면 response 내부에는 오류가 발생했다는 상태를 저장해둔다. 그리고 서블릿 컨테이너는 고객에게 응답 전에 response에 sendError()가 호출되었는지 확인한다. 만약 호출이 되었다면 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다.

WAS(sendError 호출 기록 확인) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(response.sendError())

 

2. 서블릿 예외 처리 - 오류 화면 제공

서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 고객 친화적이지 않다.

이를 위해서 서블릿은 Exception(예외)가 발생해서 서블릿 밖으로 전달되거나 또는 response.sendError()가 호출되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다. 

 

스프링 부트를 통해 서블릿 컨테이너를 실행하기 때문에, 스프링 부트가 제공하는 기능을 사용하여 서블릿 오류 페이지를 등록하면 된다.

 

[WebServerCustomizer.java] - 서블릿 오류 페이지 등록

기본 오류 페이지를 커스텀화하기 위해서 사용한다.

@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<ConfigurableWebServerFactory> {

    @Override
    public void customize(ConfigurableWebServerFactory factory) {
        ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-page/404");
        ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/error-page/500");
        ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-page/500");
        factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
    }

• response.sendError(404) : errorPage404 호출
• response.sendError(500) : errorPage500 호출
• RuntimeException 또는 그 자식 타입의 예외 : errorPageEx 호출

500예외가 서버 내부에서 발생한 오류라는 뜻을 포함하고 있기 때문에 여기서는 예외가 발생한 경우도 500 오류 화면으로 처리했다.

 

오류가 발생했을 때 처리할 수 있는 컨트롤러가 필요하다. 예를 들어 RuntimeException 예외가 발생하면 errorPageEx에서 지정한 /error-page/500이 호출된다.

 

[ErrorPageController.java]

@Slf4j
@Controller
public class ErrorPageController {

    @RequestMapping("/error-page/404")
    public String errorPage404(HttpServletRequest request, HttpServletResponse
            response) {
        log.info("errorPage 404");
        printErrorInfo(request);
        return "error-page/404";
    }
    @RequestMapping("/error-page/500")
    public String errorPage500(HttpServletRequest request, HttpServletResponse
            response) {
        log.info("errorPage 500");
        printErrorInfo(request);
        return "error-page/500";
    }

}

이후 localhost:8080/error-ex로 접속을 하면 설정한 에러 화면을 볼 수 있다.

 

3. 서블릿 예외 처리 - 오류 페이지 작동 원리

예외가 WAS까지 전달되면 WAS는 예외를 처리하는 오류 페이지 정보를 확인한다.

new ErrorPage(RuntimeException.class, "/error-page/500")

예를 들어 RuntimeException 예외가 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인한다. 

RuntimeException의 오류 페이지로 /error-page/500이 지정되어 있다. 

WAS는 오류 페이지를 출력하기 위해 /error-page/500을 다시 요청한다.

 

예외 발생과 오류 페이지 요청 흐름

1. WAS(여기까지 전파) <- 필터 <- 서블릿 <- 인터셉터 <- 컨트롤러(예외발생)
2. WAS '/error-page/500' 다시 요청 -> 필터 -> 서블릿 -> 인터셉터 -> 컨트롤러(/error-page/500) -> View

 

클라이언트 입장에서는 내부적으로 WAS가 오류 페이지로 재요청 보내는 것을 모른다. 오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 한다.

 

오류 정보 추가

WAS는 오류 페이지를 단순히 다시 요청만 하는 것이 아니라, 오류 정보를 request.setAttribute()를 통해 추가해서 Controller에 넘겨준다. 필요하면 오류 페이지에서 전달된 오류 정보를 사용할 수 있다.

 

정보들은 RequestDispatcher에 상수로 정의되어있다.

 

[ErrorPageController.java] -오류 출력

@Slf4j
@Controller
public class ErrorPageController {
    //RequestDispatcher 상수로 정의되어 있음
    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"; //오류 메시지
    public static final String ERROR_REQUEST_URI =
            "javax.servlet.error.request_uri"; //클라이언트 요청 URI
    public static final String ERROR_SERVLET_NAME =
            "javax.servlet.error.servlet_name"; //오류가 발생한 서블릿 이름
    public static final String ERROR_STATUS_CODE =
            "javax.servlet.error.status_code"; //HTTP 상태코드
            
    @RequestMapping("/error-page/404")
    public String errorPage404(HttpServletRequest request, HttpServletResponse
            response) {
        log.info("errorPage 404");
        printErrorInfo(request);
        return "error-page/404";
    }
    
    @RequestMapping("/error-page/500")
    public String errorPage500(HttpServletRequest request, HttpServletResponse
            response) {
        log.info("errorPage 500");
        printErrorInfo(request);
        return "error-page/500";
    }

    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());
    }
}

 

 

4. 서블릿 예외 처리 - 필터

오류가 발생하면 오류 페이지를 출력하기 위해서 WAS 내부에서 다시 한 번 호출이 발생하는데 이때 필터, 서블릿, 인터셉터도 모두 전부 호출된다. 

그런데 로그인 인증 체크 같은 경우를 생각해보면, 이미 한 번 필터나 인터셉터에서 로그인 체크를 완료했다 그러므로 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉트가 한 번 더 호출 되는 것은 매우 비효율적인 일이다.

 

결국 클라이언트로부터 발생한 정상 요청인지, 오류 페이지를 출력하기 위한 내부 요청인지 구분 가능해야한다. 서블릿은 이러한 문제를 해결하기 위해 WAS에서 넘겨줄 때 DispatcherType라는 추가 정보를 제공해준다.

 

DispatcherType

고객이 처음 요청 올 때는 dispatcherType = REQUEST로 전달된다. 이후에 에러가 발생하게되면 dispatcherType=ERROR을 전달한다. dispatcherType를 통해 요청을 구분할 수가 있다. 

 

javax.servlet.DispatcherType

• REQUEST : 클라이언트 요청
• ERROR : 오류 요청 (오류 페이지 요청을 위해 WAS가 다시 요청하는 경우)
• FORWARD : MVC에서 배웠던 서블릿에서 다른 서블릿이나 JSP를 호출할 때
  • RequestDispatcher.forward(request, response);
• INCLUDE : 서블릿에서 다른 서블릿이나 JSP의 결과를 포함할 때 
  • RequestDispatcher.include(request, response);
• ASYNC : 서블릿 비동기 호출

 

필터와 DispatcherType

[LogFilter.java] - DispatcherType 추가

@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");
    }
}

로그 출력 부분에 request.getDispatcherType() 추가해두었다.

 

[WebConfig.java]

@Configuration
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); //REQUEST, ERROR 두 가지의 경우에 호출됨
        return filterRegistrationBean;
    }
}

filterRegistrationBean.setDispatcherTypes(DispatcherType.Request, DispatcherType.Error);

필터는 DispatcherType을 지정해서 중복 호출을 제거할 수 있다. setDispatcherTypes()에 지정된 DispatcherType의 경우에만 필터가 호출된다. 

 

이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론 오류 페이지 요청에도 필터가 호출된다.

아무것도 넣지 않으면 기본 값이 DispatcherType.REQUEST이다.

즉, 클라이언트의 요청이 있는 경우에만 필터가 적용된다. 특별히 오류 페이지 경로도 적용할 거 아니면 기본 값 그대로 사용하면 된다. 

 

1) /error-ex 접속

처음 /error-ex로 이동하면 DispatcherType.REQUEST로 필터를 통과하게 된다. 이후 컨트롤러까지 도착을 하게 되면 throw new RuntimeException이 던져지게 된다.

 

이후 다시 WAS까지 예외가 올라가면서 다음과 같이 출력하게 된다. REQUEST, RESPONSE는 filter에서 출력된 부분이다.

 

 

2) WAS에서 에러페이지로 재 요청

WAS는 예외를 인지하고 이전에 등록해둔 사용자 등록 예외페이지에서 해당 예외 페이지를 찾아 재요청을 보낸다. 

보낼 때는 다음과 같이 ERROR로 /error-page/500으로 재요청을 보내고 있다.

5. 서블릿 예외 처리 - 인터셉터

인터셉터 중복 호출 제거

 

[LogInterceptor.java] - 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);
        }
    }
}

 

인터셉터는 서블릿이 제공하는 기능이 아니라 스프링이 제공하는 기능이므로 필터처럼 DispatcherType을 지정할 수 없기 때문에 DispatcherType과는 무관하게 항상 호출된다.

 

대신 인터셉터는 요청 경로에 따라 추가하거나 제외하기 쉽게 되어 있기 때문에 오류 페이지 경로를 excludePathPatterns를 사용해서 빼주면 된다.

 

[WebConfig.java]

@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/**"); //오류 페이지 경로

    }
 }

 

 

6. 스프링 부트 - 오류페이지 1

이전까지는 예외 처리 페이지를 만드려면 WebServerCustomizer을 만들고 예외 종류에 따라 ErrorPage 추가하고 예외처리용 컨트롤러 ErrorPageController를 만들었다. 

 

스프링 부트는 위와 같은 과정을 기본적으로 제공한다. 

ErrorPage를 자동으로 등록

• /error 경로로 기본 오류 페이지 설정
• new ErrorPage("/error")가 자동으로 등록
• 상태 코드와 예외를 설정하지 않으면 기본 오류페이지로 사용
• 서블릿 밖으로 예외가 전달되거나, response.sendError()이 호출되면 모든 오류는 /error를 호출

BasicErrorController라는 스프링 컨트롤러를 자동으로 등록

• ErrorPage에서 등록한 /error를 매핑해서 처리하는 컨트롤러 

즉 아무것도 설정하지 않았을 때 오류가 발생하면 오류 페이지로 /error를 요청하고 스프링 부트가 자동으로 등록한 BasicErrorController는 /error 경로를 기본으로 받는다.

 

개발자는 오류 페이지 화면만 BasicErrorController가 제공하는 룰과 우선순위에 따라서 등록하면 된다. 정적 HTML이면 정적 리소스, 뷰 템플릿을 사용한 동적 오류 화면이면 뷰템플릿 경로에 오류 페이지 파일을 만들어 넣어두기만 하면 된다.

 

BasicErrorController가 처리하는 순서

• 뷰 템플릿 : resources/templates에 있는 html
• 정적 리소스(static, public) : resources/static에 있는 html
• 적용 대상 없는 경우 : resources/templates/error.html

같은 우선순위라면 구체적인 파일명이 우선순위가 더 높다.

• ex > 4XX.html보다 404.html이 우선순위 더 높다.
• ex > 404.html와 4XX.html이 존재하는데 404오류가 발생하면 404.html을 오류 페이지로 사용한다.

400번대 오류가 발생하면 4XX.html을 실행하도록 컨트롤러가 작성되어 있다.

• ex > 404.html와 4XX.html이 존재하면 404오류 발생시 4XX.html을 오류 페이지로 사용한다.
• ex > 404.html이 없고 4XX.html이 존재하면 404오류 발생시 4XX.html을 오류 페이지로 사용한다.

7. 스프링 부트 - 오류 페이지 2

BasicErrorController가 제공하는 몇몇 정보들을 model에 담아서 view 전달하기 떄문에 view template에서 이 값을 활용해서 동적 HTML 오류 페이지를 만들 수 있다.

• timestamp, path, message, trace, status 등 여러 정보들을 제공

하지만 오류 관련 정보들을 고객에게 노출하는 것은 보안에 문제될 수 있다. 그래서 application.properties에서 BasicErrorController가 오류 정보를 model에 포함할지 여부를 선택할 수 있다.

• on_param : url에 특정 (쿼리)파라미터가 있을 때만 정보를 제공 ( ?message= 가 있으면 message에 관련된 정보를 제공 )
• always : 항상 사용
• false : 사용하지 않음

스프링 부트 오류 관련 옵션

• server.error.whitelabel.enabled=true : 오류 처리 화면을 찾지 못했을 경우, 스프링 whitelabel 오류 페이지 적용
• server.error.path=/error : 오류 페이지 경로, 스프링부트가 자동 등록하는 서블릿 글로벌 오류 페이지 경로와 BasicErrorController 오류 컨트롤러 경로에 함께 사용
• 오류를 공통으로 처리하는 컨트롤러의 기능을 변경하고 싶다면 ErrorController 인터페이스를 상속받아 구현하거나 BasicErrorController를 상속받아 기능을 추가하면 된다