[Spring] 서블릿 예외 처리

오늘은 스프링이 아닌 순수 서블릿 컨테이너가 예외를 어떻게 처리하는지 정리해보려고 한다.

 

서블릿 예외 처리

서블릿은 2가지 방식으로 예외 처리를 지원한다.

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

Exception(예외)

자바 직접 실행

자바의 메인 메서드를 직접 실행하는 경우 main이라는 이름의 쓰레드가 실행된다.

실행 도중에 예외를 잡지 못하고 처음 실행한 main() 메서드를 넘어서 예외가 던져지면, 예외 정보를 남기고 해당 쓰레드는 종료된다.

 

웹 애플리케이션

웹 애플리케이션은 사용자 요청별로 별도의 쓰레드가 할당되고, 서블릿 컨테이너 안에서 실행된다. 애플리케이션에서 예외가 발생했는데, try ~ catch로 예외를 잡아서 처리하면 아무런 문제가 없을 것이다. 그런데 만약 애플리케이션이 예외를 잡지 못하고, 서블릿 밖으로 까지 예외가 전달되면 어떻게 동작할까?

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

 

결국 톰캣 같은 WAS까지 예외가 전달된다. WAS는 예외가 올라오면 어떻게 처리할까?🤔

 

application.properteis
server.error.whitelabel.enabled=false
설정을 통해 스프링 부트가 제공하는 기본 예외 페이지를 꺼두고 테스트해야 한다. 

 

🔻ServletExController - 서블릿 예외 컨트롤러

@Slf4j
@Controller
public class ServletExcController {

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

 

실행해보면 아래와 같이 톰캣이 기본으로 제공하는 오류 화면이 나타나고, Exception의 경우 서버 내부에서 처리할 수 없는 오류가 발생한 것으로 생각해서 HTTP 상태 코드 500을 반환한다.

 

 

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

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

- response.sendError(HTTP 상태 코드)

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

🔻ServletExController - 서블릿 예외 컨트롤러(추가)

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

sendError 흐름

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

 

서블릿 컨테이너는 고객에게 응답 전에 response에 sendError()가 호출되었는지 확인하고, 설정한 오류 코드에 맞추어 기본 오류 페이지를 보여준다. 

 

👉 서블릿 컨테이너가 제공하는 기본 예외 처리 화면은 사용자가 보기에 불편하므로 직접 설정한 의미 있는 오류 화면으로 제공해 보자.

 

오류 화면 제공

서블릿은 Exception(예외)가 발생해서 서블릿 밖으로 전달되거나, response.sendError()가 호출되었을 때 각각의 상황에 맞춘 오류 처리 기능을 제공한다. 이 기능을 사용하면 오류 처리 화면을 준비해서 고객에게 보여줄 수 있다.

 

과거에는 web.xml이라는 파일에 오류 화면을 등록했는데, 지금은 스프링 부트를 통해서 서블릿 컨테이너를 실행하기 때문에 스프링 부트가 제공하는 기능을 사용해서 서블릿 오류 페이지를 등록하면 된다.

 

🔻서블릿 오류 페이지 등록

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

 

500 예외가 서버 내부에서 발생한 오류를 의미하기 때문에, 예외가 발생한 경우도 500 오류 화면으로 처리했다. 

++ 오류 페이지는 예외를 다룰 때 해당 예외와 그 자식 타입의 오류를 함께 처리한다.

 

🔻 에러 페이지 컨트롤러 - 오류가 발생했을 때 처리할 수 있는 컨트롤러 필요

@Slf4j
@Controller
public class ErrorPageController {

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

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

 

오류 처리 View도 설정하고 테스트해보면 아래와 같은 화면을 볼 수 있다.

(내가 설정할 수 있다는 것만 확인하는 용도..ㅎㅎ)

 

오류 페이지 작동 원리

지금까지 했던 과정을 한 번 정리해 보자.

 

1-1. 예외 발생 흐름

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

 

1-2. sendError 흐름

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

 

WAS는 해당 예외를 처리하는 오류 페이지 정보를 확인한다.

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

 

2. 오류 페이지 요청 흐름

WAS '/error-page/500' 다시 요청 >> 필터 >> 서블릿 >> 인터셉터 >> 컨트롤러(/error-page/500) >> View

 

🔸중요한 점은 웹 브라우저(클라이언트)는 서버 내부에서 이런 일이 일어나는지 전혀 모른다. 오직 서버 내부에서 오류 페이지를 찾기 위해 추가적인 호출을 한다.

 

✔️ 정리해 보면, 예외 발생해서 WAS까지 전달되면, WAS는 오류 페이지 정보를 확인한다. 이때 오류 페이지를 출력하기 위해 필터, 서블릿, 인터셉터, 컨트롤러 다시 요청한다.

 

오류 정보 추가

WAS는 오류 페이지를 단순히 요청하는 것이 아니라, 오류 정보를 request의 attribute에 추가해서 넘겨준다.

필요하면 오류 페이지에서 전달된 오류 정보를 사용할 수 있다.

 

🔻ErrorPageController - 오류 출력 컨트롤러

@Slf4j
@Controller
public class ErrorPageController {

    //RequestDispatcher 상수로 정의되어 있음
    public static final String ERROR_EXCEPTION = "jakarta.servlet.error.exception";
    public static final String ERROR_EXCEPTION_TYPE = "jakarta.servlet.error.exception_type";
    public static final String ERROR_MESSAGE = "jakarta.servlet.error.message";
    public static final String ERROR_REQUEST_URI = "jakarta.servlet.error.request_uri";
    public static final String ERROR_SERVLET_NAME = "jakarta.servlet.error.servlet_name";
    public static final String ERROR_STATUS_CODE = "jakarta.servlet.error.status_code";

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

    @RequestMapping("/error-page/500")
    public String errorPage500(HttpServletRequest request, HttpServletResponse response) {
        log.info("error-page 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));
        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());
    }
}

jakarta.servlet.error.exception : 예외
jakarta.servlet.error.exception_type : 예외 타입
jakarta.servlet.error.message : 오류 메시지
jakarta.servlet.error.request_uri : 클라이언트 요청 URI
jakarta.servlet.error.servlet_name : 오류가 발생한 서블릿 이름
jakarta.servlet.error.status_code : HTTP 상태 코드

서블릿 컨테이너에 오류가 있다고 알려준 거지 실제로 예외를 발생시키는 것이 아니라 500으로 했을 땐 error_exception에 null이 나온다.

 

👉 이제는 예외 처리에 따른 필터와 인터셉터 그리고 서블릿이 제공하는 DispatchType에 대해 알아보자.

 

서블릿 예외 처리 - 필터

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

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

 

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

 

🤔결국 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 한다.

이런 문제를 해결하기 위해 서블릿은 DispatchType이라는 추가 정보를 제공한다.

 

DispatchType

고객이 처음 요청하면 dispatcherType=REQUEST이다. 이렇듯 서블릿 스펙은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지 구분할 수 있는 방법을 제공한다.

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

 

필터와 DispatcherType

필터와 어떻게 사용되는지 알아보자.

 

🔻LogFilter - 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) {
            log.info("EXCEPTION {}", e.getMessage());
            throw e;
        }
        finally {
            log.info("RESPONSE [{}][{}][{}]", uuid, request.getDispatcherType(), requestURI);
        }
    }

    @Override
    public void destroy() {
        log.info("log filter destroy");
    }
}

 

🔻WebConfig

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

 

filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);
이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 오류 페이지 요청에서도 필터가 호출된다.

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

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

인터셉터 중복 호출 제거

🔻LogInterceptor - 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(추가)

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new LogInterceptor())
            .order(1)
            .addPathPatterns("/**")
            .excludePathPatterns("/css/**", "/*.ico", "/error", "/error-page/**"); //오류 페이지 경로
}

 

📌 전체 흐름 정리

/hello 정상 요청

WAS(/hello, dispatcherType=REQUEST) >> 필터 >> 서블릿 >> 인터셉터 >> 컨트롤러 >> View

 

/error-ex 오류 요청

1. WAS(/error-ex, dispatcherType=REQUEST) >> 필터 >> 서블릿 >> 인터셉터 >> 컨트롤러
2. WAS(여기까지 전파) << 필터 << 서블릿 << 인터셉터 << 컨트롤러(예외발생)
3. WAS 오류 페이지 확인
4. WAS(/error-page/500, dispatcherType=ERROR) >> 필터(x) >> 서블릿 >> 인터셉터(x) >> 컨트롤러(/error-page/500) >> View

• 필터는 DispatchType으로 중복 호출 제거
• 인터셉터는 경로 정보로 중복 호출 제거

 

✨👩‍💻✨

이번엔 예외 처리하는 흐름에 대해 이해해 봤는데, 다음엔 스프링 부트가 편리하게 제공해 주는 것을 이용해 예외 처리하는 방법에 대해 알아보고 정리해 봐야겠다.

 

 

 

출처

스프링 MVC 2편 - 백엔드 웹 개발 핵심 기술 | 김영한 - 인프런