[SpringBoot] Filter(필터) OncePerRequestFilter간단히 사용하기

Filter란 서블릿의 ServletContext 기능으로 사용자에 의해 서블릿이 호출 되기 전/후로 사용자 요청/응답의 헤더 정보 등을 검사 및 설정할 수 있다.

Servlet Filter와 HandlerInterceptor의 차이

Filter와 Interceptor 비교

필터는 DispatcherServlet 앞에서 먼저 동작하고, 인터셉터는 DispatcherServlet에서 Controller(Handler) 사이에서 동작한다.

필터

• 웹 어플리케이션의 Context의 기능

• 스프링 기능을 활용하기에 어려움

• 일반적으로 인코딩, CORS, XSS, LOG, 인증, 권한 등 을 구현

인터셉터

• 스프링의 Spring Context의 기능이며 일종의 빈

• 스프링 컨테이너이기에 다른 빈을 주입하여 활용성이 좋음

• 다른 빈을 활용 가능하기에 인증, 권한 등을 구현함

Filter보다는 OncePerRequestFilter를 사용하는을 추천합니다.

OnePerRequestFilter의 역할을 이해하려면 먼저 일반 필터의 작동 방식을 명확히 이해해야 합니다. 서블릿 실행 직전 또는 후에 특정 코드를 실행하려면 다음과 같은 기능을 하는 필터를 생성합니다. 코드1 > 서블릿 실행(체인.doFilter() > 코드2 그래서 code1은 servlet 전에, code2는 servlet 실행 후에 실행된다. 그러나 여기서 서블릿을 실행하는 동안 다른 서블릿에 대한 다른 요청이 있을 수 있으며 다른 서블릿에도 동일한 필터가 있습니다. 이 경우 이 필터가 다시 실행됩니다. 일단 요청당 필터로 인해 이 동작을 방지할 수 있습니다. 한 번의 요청에 대해 이 필터는 정확히 한 번 실행됩니다. 이 동작은 보안 인증으로 작업하는 동안 매우 유용합니다.

@Component, @WebFilter를 사용하는 방법입니다.

경축! 아무것도 안하여 에스천사게임즈가 새로운 모습으로 재오픈 하였습니다.
어린이용이며, 설치가 필요없는 브라우저 게임입니다.
https://s1004games.com

FirstSampleFilter.java

package com.example.base.common.filter;

import java.io.IOException;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@Component
@WebFilter(urlPatterns = "/base/sample/*")
@Order(0)
public class FirstSampleFilter extends OncePerRequestFilter {

	@Override
	protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
			throws ServletException, IOException {
		log.debug("FirstSampleFilter doFilter()");
		// 다음 Filter 실행 전 처리 (preHandle)
		if(request.getRequestURI().startsWith("/base/sample")) {
			log.debug("if(request.getRequestURI().startsWith(\"/base/sample\"))");
			response.setStatus(401);
			return;
		}
		// 다음 filter-chain에 대한 실행 (filter-chain의 마지막에는 Dispatcher servlet실행)
		filterChain.doFilter(request, response);
	}
	
	@Override
	public void destroy() {
		log.debug("FirstSampleFilter destroy()");
		super.destroy();
	}
}

SecondSampleFilter.java

package com.example.base.common.filter;

import java.io.IOException;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@Component
@WebFilter(urlPatterns = "/base/sample/*")
@Order(1)
public class SecondSampleFilter extends OncePerRequestFilter {

	@Override
	protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
			throws ServletException, IOException {
		log.debug("SecondSampleFilter doFilterInternal()");
		// 다음 Filter 실행 전 처리 (preHandle)
				
		// 다음 filter-chain에 대한 실행 (filter-chain의 마지막에는 Dispatcher servlet실행)
		filterChain.doFilter(request, response);
	}

	@Override
	public void destroy() {
		log.debug("SecondSampleFilter destroy()");
		super.destroy();
	}
}

실행시키면 firstSampleilter 'firstSampleFilter' configured for use, Filter 'secondSampleFilter' configured for use

그리고 doFilterdoFilterInternal() 에서 if(request.getRequestURI().startsWith("/base/sample")) 걸러져서 401코드로 return 되는것을 볼 수 있다.

또한 @Order 값을 서로 바꿔주면 init은 똑같은 순서로 진행되지만 요청시의 마주하는 Filter의 순서는 바뀌는것을 확인할 수 있다.

@Component로 등록하지않고 필터 설정하는 방법도 있다.

@Component, @Order를 지운후 config 클래스를 만들어 @Bean으로 등록하고

Application 클래스에서 @ServletComponentScan해주면 된다

package com.example.base.config;
/*
 * 사용 가능하다. 하지만 @ServletComponentScan 하면 2번실행되게된다.
 * 각 Filter들에 붙은 Component를 제거하고 Application에 @ServletComponentScan을 달아주면 된다.
 * 
 * 
 * 
 */

package com.example.base.config;

import java.util.Arrays;

import javax.servlet.Filter;
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;

@Configuration
public class FilterConfig implements WebMvcConfigurer {

	@Bean
	public FilterRegistrationBean<Filter> firstSampleFilter() {
		FilterRegistrationBean<Filter> registrationBean = new FilterRegistrationBean<Filter>(new FirstSampleFilter());
		registrationBean.setUrlPatterns(Arrays.asList("/base/*"));
		return registrationBean;
	}	

	@Bean
	public FilterRegistrationBean<Filter> secondSampleFilter() {
		FilterRegistrationBean<Filter> registrationBean = new FilterRegistrationBean<Filter>(new SecondSampleFilter());
		registrationBean.setUrlPatterns(Arrays.asList("/base/*"));
		return registrationBean;
	}	
}

Reference Link :

linked2ev.github.io/gitlog/2019/09/15/springboot-mvc-13-%EC%8A%A4%ED%94%84%EB%A7%81%EB%B6%80%ED%8A%B8-MVC-Filter-%EC%84%A4%EC%A0%95/

[출처] https://pgnt.tistory.com/102