[ Spring ] 예외 처리와 오류 페이지 - Servlet Exception Handling(Filter , Interceptor)

---

이어서 Servlet Exception Handling 포스팅 진행하겠습니다.

 

이번 포스팅의 목표는 예외 처리에 따른 필터와 인터셉터 그리고 서블릿이 제공하는 DispatchType에 대해 이해하는 부분을 중점으로 글을 작성하겠습니다.

 

[ Spring ] 예외 처리와 오류 페이지 - Servlet Exception Handling(오류 페이지 작동 원리)

---

Servlet Exception Handling - Filter

 

 

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

1. WAS(여기까지 전파) <- FILTER <- SERVLET <- INTERCEPTOR <- CONTROLLER(예외 발생)


2. WAS '/error-page/500' 다시 요청 -> FILTER -> SERVLET -> INTERCEPTOR -> CONTROLLER(/error-page/500) -> VIEW

 

오류가 발생하면 오류 페이지를 출력하기 위해 WAS 내부에서 다시 한번 호출이 발생합니다.

 

이때 필터, 서블릿, 인터셉터도 모두 다시 호출됩니다.

그런데 로그인 인증 체크 같은 경우를 생각해 보면, 이미 한번 필터나, 인터셉터에서 로그인 체크를 완료했습니다.

 

따라서 서버 내부에서 오류 페이지를 호출한다고 해서 해당 필터나 인터셉터가 한번 더 호출되는 것은 매우 비효율적입니다.

 

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

 

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

 

---

DispatcherType

 

필터는 이런 경우를 위해서 dispatcherTypes라는 옵션을 제공합니다.

 

예시를 들자면 이전 포스팅 때 추가한 로그를 바탕으로 알아보자면

log.info("dispatchType={}", request.getDispatcherType())

 

출력해 보면 오류 페이지에서  dispatchType=ERROR로 나오는 것을 확인할 수 있습니다.

 

고객이 처음 요청하면 dispatcherType=REQUEST입니다.

이렇듯 서블릿 스펙은 실제 고객이 요청한 것인지, 서버가 내부에서 오류 페이지를 요청하는 것인지 

DispatcherType으로 구분할 수 있는 방법을 제공합니다.

 

[ javax.servlet.DispatcherType ] 

public enum DispatcherType {

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

 

그렇다면 필터와 DispatcherType이 어떻게 사용되는지 알아봅시다.

 

---

필터와 DispatcherType

 

• LogFilter - DispatcherType 로그 추가

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

 

로그를 출력하는 부분에 request.getDispatcherType()을 추가해두었습니다.

 

• WebConfig

import hello.exception.filter.LogFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.servlet.DispatcherType;
import javax.servlet.Filter;

@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입니다.

즉, 클라이언트의 요청이 있는 경우에만 필터가 적용되는데,

특별히 오류 페이지 경로도 필터를 적용할 것이 아니면, 기본 값을 그대로 사용하면 됩니다. 

 

물론 오류 페이지 요청 전용 필터를 적용하고 싶으면 DispatcherType.ERROR만 지정하면 됩니다.

 

---

Servlet Exception Handling - Interceptor

 

• LogInterceptor - DispatcherType 로그 추가

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;

@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

import hello.exception.filter.LogFilter;
import hello.exception.interceptor.LogInterceptor;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.servlet.DispatcherType;
import javax.servlet.Filter;

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

 

인터셉터와 중복으로 처리되지 않기 위해 앞의 logFilter()의 @Bean에 주석을 달아주고

여기에서 /error-page/**를 제거하면 error-page/500 같은 내부 호출의 경우에도 인터셉터가 호출됩니다.

 

---

전체 흐름 정리

 

[ /hello 정상 요청]

WAS(/hello, dispatchType=REQUEST) -> FILTER -> SERVLET -> INTERCEPTOR -> CONTROLLER -> VIEW

 

[ /error-ex 오류 요청]

 

• 필터는 DispatchType으로 중복 호출 제거(dispatchType=REQUEST)
• 인터셉터는 경로 정보로 중복 호출 제거(excludePathpatterns("/error-page/**"))

 

1. WAS(/error-ex, dispatchType=REQUEST) -> FILTER -> SERVLET -> INTERCEPTOR -> CONTROLLER

2. WAS(여기까지 전파) <- FILTER <- SERVLET <- INTERCEPTOR <- CONTROLLER(예외발생)

3. WAS 오류 페이지 확인

4. WAS(/error-page/500, dispatchType=ERROR) -> FILTER(x) -> SERVLET -> INTERCEPTOR(x) -> CONTROLLER(/error-page/500) -> View

---

마치며

오늘까지 Servlet Exception Handling Section에 대해 알아봤습니다.

 

다음 포스팅으로 뵙겠습니다.

 

위 포스팅은 김영한님의 Spring MVC 2편 - 백엔드 웹 개발 활용  강의를 참고했습니다.

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 강의 - 인프런