ServletException - 필터

현시기얌·2021년 8월 15일

ServletException

목록 보기

4/7

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

WAS (여기까지 전파) <-- Filter <-- Servlet <-- Interceptor <-- Controller (예외발생)
WAS ('/error-page/500' 다시 요청) --> Filter --> Sevlet --> Interceptor --> Controller ('/error-page/500')

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생한다. 이때 필터, 서블릿, 인터셉터도 모두 다시 호출된다.
그런데 로그인 인증 체크 같은 경우를 살펴보면, 이미 한번 필터나, 인터셉터에서 로그인 체크를 완료 했다.
따라서 서버 내부에서 오류 페이지를 호출한다고해서 해당 필터나 인터셉터가 한번 더 호출되는 것은 매우 비효율적이다.
결국 클라이언트로부터 발생한 정상 요청인지, 아니면 오류 페이지를 출력하기 위한 내부 요청인지 구분할 수 있어야 한다.
서브릿은 이러한 문제를 해결하기 위해 DispatcherType라는 추가 정보를 제공한다.

DispatcherType

필터는 이런 경우를 위해서 dispatcherTypes 라는 옵션을 제공한다.
log.info("dispatcherType: {}, request.getDispatcherType());
그리고 출력해보면 오류페이지에서 다음과 같이 나오는 것을 확인 할 수 있다.
dispatcherType = ERROR

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

javax.servlet.DispatcherType

public enum DispatcherType {
    FORWARD,
    INCLUDE,
    REQUEST,
    ASYNC,
    ERROR
}

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

필터와 DispatcherType

LogFilter

@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 {
        log.info("log filter doFilter");

        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, requestURI);
        }


    }

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

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("/*");
        //이 필터는 DispatcherType이 REQUEST, ERROR 두가지 경우에 호출됨
        filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);
        return filterRegistrationBean;
    }
}

filterRegistrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ERROR);
이렇게 두 가지를 모두 넣으면 클라이언트 요청은 물론이고, 요류 페이지 요청에서도 필터가 호출된다.
아무것도 넣지 않으면 기본 값이 DispatcherType.REQUEST 이다.
즉 클라이언트 요청이 있는 경우에만 필터가 적용된다.
따라서 특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 된다.
cf) 물론 오류페이지 요청 전용 필터를 적용하고 싶으면 DispatcherType.Error만 지정하면 된다.

localhost:8080/error-ex 접속 했을 경우 (예외발생)

첫번째 필터 거쳤을 때

예외 발생으로 인해 필터가 다시 요청 받았을 때

처음 필터가 요청 받았을 때는 사용자에 의한 요청이므로 DispatcherType이 REQUEST지만 예외가 발생해서 WAS에서 다시 필터로 요청 했을 경우에는 DispatcherType이 ERROR인 것을 확인할 수 있다.
이렇듯 우리는 DispatcherType을 통해서 사용자에 의한 요청인지, 서버 내부에 의한 요청인지 알 수 있게 되었다.