Spring Boot servlet filter 사용하기

ServletContext와 ApplicationContext의 연동

filter를 설명하기 전 기본적인 설명

servlet은 ServletContext를 사용한다.

java.servlet.Filter는 javax.servlet-api나 tomcat-embed-core를 사용하면 제공되는 servlet filter interface이다.

spring은 ApplicationContext를 사용한다.

servlet에서 spring을 사용하기 위해선 servlet의 ServletContext에 spring의 ApplicationContext를 연동해야 한다.

Spring은 ApplicationContext를 servlet에서 사용하기 위한 ServletWebServerApplicationContext를 제공하고 해당 class에서는 servlet의 ServletContext에 ApplicationContext를 setAttribute 하여 요청마다 담는 처리를 한다.

Spring Boot 없이 사용한다면 WebApplicationInitializer를 따로 구현해야 하지만 Spring Boot를 사용한다면 SpringBootServletInitializer에서 ServletContextApplicationContextInitializer를 사용해 ApplicationContext를 ServletContext에 등록하게 된다.

filter 사용하기

servlet에서 제공하는 Filter interface를 구현하여 사용할 수 있다.

public class SomeFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // TODO 전처리
        chain.doFilter(request, response);
        // TODO 후처리
    }

}

spring은 filter에서 spring config 설정 정보를 쉽게 처리하기 위한 GenericFilterBean을 제공한다.

Filter를 구현한 것과 동일하고 getFilterConfig()나 getEnvironment()를 제공해주는 정도이다.

public class SomeFilter extends GenericFilterBean {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // TODO 전처리
        chain.doFilter(request, response);
        // TODO 후처리
    }

}

또한 Filter를 중첩 호출한 경우 (의도치 않은 경우) 매번 Filter의 내용이 수행되는 것을 방지하기 위해 GenericFilterBean을 상속한 OncePerRequestFilter도 있다.

OncePerRequestFilter를 상속하여 구현한 경우 doFilter 대신 doFilterInternal 메서드를 구현하면 된다.

public class SomeFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
        // TODO 전처리
        filterChain.doFilter(request, response);
        // TODO 후처리
    }

}

이렇게 필터를 정의하였으면 bean 선언만 하면 spring boot를 사용하는 경우 자동으로 filter가 추가되게 된다.

아래처럼 해당 class에 직접 선언해도 되고

@Component
public class SomeFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
        // TODO 전처리
        filterChain.doFilter(request, response);
        // TODO 후처리
    }

}

@Bean을 사용해도 동일하다.

@Configuration
public class SomeConfiguration {
	
    @Bean
    public SomeFilter someFilter() {
        return new SomeFilter();
    }
}

Filter의 순서 지정하기

위처럼 사용하면 호출마다 filter가 동작하는 것을 확인할 수 있다.

filter의 순서를 지정하고 싶은 경우 @Order annotation을 사용하면 된다.

(@Bean으로 선언하여 사용할 때에도 filter class에 @Order를 사용해야 제대로 동작한다.)

@Order(0)
public class SomeFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
        // TODO 전처리
        filterChain.doFilter(request, response);
        // TODO 후처리

    }

}

지정된 숫자가 클수록 안쪽에서 실행된다.

즉 filterChain.doFilter의 전처리는 숫자가 낮을수록 먼저 실행되고 후처리는 숫자가 높을수록 먼저 실행된다.

지정할 숫자는 최소 -105 보다 큰 숫자를 사용하는 것을 권장한다.

이유는 spring에서 제공하는 기본 filter 4종의 순서 때문이다.

대상 filter	순서 지정	Order 값
CharacterEncodingFilter	OrderedCharacterEncodingFilter	-2147483648
HiddenHttpMethodFilter	OrderedHiddenHttpMethodFilter	-10000
FormContentFilter	OrderedFormContentFilter	-9900
RequestContextFilter	OrderedRequestContextFilter	-105

custom filter를 등록하는 경우 위 filter의 처리를 거치고 난 이후의 수행을 사용하는 경우가 대부분이고 filter에서 만약 RequestContextHolder를 호출하는 구간이 있다면 필히 -105보다 순서를 상위로 지정해야 한다.