springboot自定义过滤器

时间:2022-05-23 clonetx 人气:0

过滤器是Servlet的规范，是基于函数回调的，需要实现javax.servlet.Filter接口，依赖于Tomcat等容器，一般用于过滤请求的URL。

1自定义过滤器

自定义filter的实现，本质上只有一种方式，就是实现Filter接口。但是在spring中我们有时候也会通过继承框架提供的XXXFilter，例如OncePerRequestFilter、 AbstractAuthenticationProcessingFilter（Spring Security使用的认证过滤器），当然，这些过滤器所实现的顶层接口还是Filter，只不过框架提供的过滤器都是有其特殊职能的，我们自己实现过滤器基本通过下面两种方法。

1.1实现Filter接口

public class MyFilterOne implements Filter {
 
    @Override
    public void destroy() {
        //服务停止时销毁;
    }
 
    @Override
    public void doFilter(ServletRequest srequest, ServletResponse sresponse, FilterChain filterChain)
            throws IOException, ServletException {
        
        System.out.println("this is MyFilter,url :" + request.getRequestURI());
        //1、进入过滤器，通常在这里根据requet做一些事情
        HttpServletRequest request = (HttpServletRequest) srequest;
        //2、放行，进入下一个过滤器，如果是最后一个过滤器，就执行Controller代码
        filterChain.doFilter(srequest, sresponse);
        //3、回到过滤器，通常在这里对response做一些处理
        HttpServletResponse response = (HttpServletResponse) srequest;
    }
 
    @Override
    public void init(FilterConfig arg0) throws ServletException {
        //服务启动时创建;
    }
 
}

1.2继承OncePerRequestFilter

下面的实现，并没有配置过滤路径，所有的请求都会进入到这个过滤器，但是它通过@Value获取配置的url列表，然后用这个列表去和进入过滤器的请求进行对比，如果匹配就做一些操作，如果不匹配直接放行。个人觉得还是配置过滤路径好。

@Component
@Order(-1)
public class MyFilterThree extends OncePerRequestFilter {
 
    private final List<Pattern> uriPatterns = new ArrayList<Pattern>();
 
    @Value("#{'${filtered.uris:^$}'.split(',')}")
    private List<String> filteredUris;
 
    @PostConstruct
    public void initialize() {
        for (String uri : this.filteredUris) {
            try {
                this.uriPatterns.add(Pattern.compile(uri));
                System.out.println(String.format("符合 '%s' 格式的URI,将进行过滤处理，否则放行.", uri));
 
            } catch (PatternSyntaxException patternSyntaxException) {
                System.out.println("Invalid regular expression pattern in filtered.uris: " + uri);
            }
        }
    }
 
    @Override
    protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
        System.out.println(httpServletRequest.getRequestURI());
        System.out.println("需要过滤的路径"+ Arrays.toString(uriPatterns.toArray()));
        System.out.println("进入过滤器了");
        filterChain.doFilter(httpServletRequest, httpServletResponse);//放行
        System.out.println("又回到过滤器了");
    }
 
    private boolean isMatchedUri(String uri) {
        if (StringUtils.isEmpty(uri)) {
            return false;
        } else {
            Iterator var2 = this.uriPatterns.iterator();
 
            Pattern pattern;
            do {
                if (!var2.hasNext()) {
                    return false;
                }
 
                pattern = (Pattern)var2.next();
            } while(!pattern.matcher(uri).find());
 
            return true;
        }
    }
}

1.3使过滤器生效配置

使用配置类

@Configuration
public class MyFilterConfiguration {
 
    @Bean
    public FilterRegistrationBean registerFilter() {
        System.out.println("MyFilterConfiguration");
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new MyFilterOne());
        registration.addUrlPatterns("/public/*");//过滤的路径
        registration.addInitParameter("paramName", "paramValue");
        registration.setName("MyFilter");
        registration.setOrder(1);//在过滤链中的执行顺序
        return registration;
    }
}

@WebFilter和@ServletComponentScan(basePackages = "")

个人比较喜欢这个方式，代码量最小

第一步：在启动类上添加注解@ServletComponentScan(basePackages = "")

第二步：Filter类添加@WebFilter注解，配置FilterRegistrationBean的属性@WebFilter基本都有

@WebFilter(urlPatterns = "/selfAnnotation/*")
@Order(-2)
public class MyFilterFive extends OncePerRequestFilter {
 
    @Override
    protected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, FilterChain filterChain) throws ServletException, IOException {
 
        System.out.println("进入5号过滤器了");
    }
}

2 Filter生命周期

init()：在构造器被调用后，紧接着被调用。作用：用来初始化Filter。

doFilter()：每一次拦截请求时都会调用。

destroy()：方法在项目停止时调用，用来在对象被销毁前做一些收尾工作。

加载全部内容