[MVC] 필터, 인터셉터

시작하기에 앞서

필터는 서블릿이 제공하는 기능이고, 인터셉터는 스프링이 제공하는 기능이다.

이를 알고 공부를 시작해보도록 하자.

 

 

 

---

 

 

서블릿 필터

필터를 사용하는 이유는 로그인 처리 등과 같은, 애플리케이션에서 공통적으로 관심이 있는 로직을 처리하기 위함이다.

스프링 AOP로도 처리할 수 있지만, 웹과 관련된 공통 관심사는 필터 또는 인터셉터를 사용하는 것이 좋다.

웹과 관련된 로직을 처리할 때에는 HTTP의 정보가 필요한데, 필터나 인터셉터는 HttpServletRequest, HttpServletResponse를 제공하기 때문이다.

 

 

 

필터의 흐름

Http 요청 -> WAS -> 필터 -> (디스패처)서블릿 -> 컨트롤러

필터를 호출한 다음에 서블릿이 호출되기 때문에, 요청 로그를 남기능 등의 로직을 처리하기 위해서는 필터를 사용하면 좋다.

 

 

필터의 제한

Http 요청 -> WAS -> 필터 -> 서블릿 -> 컨트롤러  //정상 흐름
Http 요청 -> WAS -> 필터  (종료) //적절하지 않은 요청이라 판단될 경우, 서블릿 호출 X

 

필터 체인

Http 요청 -> WAS -> 필터1 -> 필터2 -> 필터3 -> 서블릿 -> 컨트롤러 

필터는 체인으로 구성되어, 중간에 필터를 자유롭게 추가하거나 제거할 수 있다.

 

 

필터 인터페이스

public interface Filter {

    public default void init(FilterConfig filterConfig) throws ServletException {}

    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException;

    public default void destroy() {}
}

 

1. init : 필터 초기화 메서드, 서블릿 컨테이너가 생성될 때 호출된다.

2. doFilter : 고객의 요청이 올 때 마다 해당 메서드가 호출된다. 필터의 로직을 작성한다.

3. destroy : 필터 종료 메서드, 서블릿 컨테이너가 종료될 때 호출된다.

 

(참고로 필터를 등록하면, 서블릿 컨테이너가 필터를 싱글톤 객체로 생성하고 관리해주기 때문에 사용에 주의해야 한다.)

 

 

필터 등록

필터를 등록할 때에는 FilterRegistrationBean을 사용하여 등록한다.

@Bean
public FilterRegistrationBean filter() {
	
    FilterRegistrationBean<Filter> filterRegistrationBean = new FilterRegistrationBean<>();
    filterRegistrationBean.setFilter(new 등록할필터);
    filterRegistrationBean.setOrder(순서, 번호가 낮을수록 먼저 실행);
    filterRegistrationBean.addUrlPatterns("적용할  URL");
    
    return filterRegistrationBean;

}

 

 

---

 

스프링 인터셉터

스프링 인터셉터도 필터와 비슷한 기능을 수행한다.

그러나 적용되는 순서와 범위, 그리고 사용 방법이 필터와 다른데, 지금부터 알아보자.

 

 

인터셉터의 흐름

Http 요청 -> WAS -> 필터 -> 디스패처 서블릿 -> 스프링 인터셉터 -> 컨트롤러

스프링 인터셉터는 디스패처 서블릿과 컨트롤러 사이에서 컨트롤러 호출 직전에 호출된다.

스프링 인터셉터는 스프링 MVC가 제공하는 기능이기 때문에 결국 디스패처 서블릿 이후에 등장하게 된다.

 

 

 

인터셉터의 제한

Http 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 -> 컨트롤러  //정상 흐름
Http 요청 -> WAS -> 필터 -> 서블릿 -> 스프링 인터셉터 (종료)//적절하지 않은 요청이라 판단될 경우, 컨트롤러 호출 X

 

 

인터셉터의 체인

Http 요청 -> WAS -> 필터 -> 서블릿 -> 인터셉터1 -> 인터셉터2 -> 컨트롤러 

 

 

 

스프링 인터셉터 인터페이스

public interface HandlerInterceptor {

   default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
         throws Exception {

      return true;
   }

   default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
         @Nullable ModelAndView modelAndView) throws Exception {
   }

 
   default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
         @Nullable Exception ex) throws Exception {
   }

}

• preHandle : 컨트롤러 호출 전에 호출
• postHandle : 컨트롤러 호출 후에 호출
• afterCompletion : 요청 완료 이후

 

인터셉터의 경우 어떤 컨트롤러(handler)를 호출하는지에 대한 정보도 받을 수 있다.

 

 

인터셉터 예외 발생 시

컨트롤러에서 예외가 발생한다면 컨트롤러 호출 후에 호출되는 postHandle은 호출되지 않는다. 

afterCompletion은 예외가 발생해도 호출되는데, 예외가 발생한 경우라면 어떤 예외가 발생했는지 파라미터로 받아서 로그로 출력할 수 있다.

 

 

 

인터셉터 등록

인터셉터는 WebMvcConfigurer을 구현한 후,  addInterceptors를 Override하여 등록해주면 된다.

 

@Configuration
public String WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry){
    	registry.addInterceptor(new LogInterceptor())
                .order(1)
                .addPathPatterns("/**")
                .excludePathPatterns("/css/**","/*.ico");
    }

}

 

 

 

 

 

 

📔 Reference

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