Spring Boot 使用 Filter 的正确姿势！

左手的ㄟ右手 2022-08-28 14:43 126阅读 0赞

**点击关注公众号，Java干货****及时送达**![be20fa4af3106063f9c26348b82c3631.png][]

Filter 是 JavaEE 中 Servlet 规范的一个组件，位于包`javax.servlet` 中，它可以在 HTTP 请求到达 Servlet 之前，被一个或多个Filter处理。

它的工作流程如图：![7f91630e3718a9a88361264bbce5a98f.png][]

Filter的这个特性在生产环境中有很广泛的应用，如：修改请求和响应、防止xss攻击、包装二进制流使其可以多次读，等等。

实际工作中，我们都是使用 SpringBoot 进行业务开发，本文总结三种 Filter 用法，SpringBoot 版本采用目前最新的 `v2.3.1.RELEASE`

## 1. 编写Filter ##

要编写 Filter ，只需要实现`javax.servlet.Filter`接口就可以了

public class MyFilter implements Filter {
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
            System.out.println("MyFilter");
            // 要继续处理请求，必须添加 filterChain.doFilter()
            filterChain.doFilter(servletRequest,servletResponse);
        }
    }

Filter 接口有三个方法：`init()`,`doFilter()`,`destroy()`。

其中`doFilter()`需要自己实现，其余两个是`default`的，可以不用实现。

Spring Boot 基础就不介绍了，推荐下这个实战教程：https://github.com/javastacks/spring-boot-best-practice

注意：**如果Filter要使请求继续被处理，就一定要调用filterChain.doFilter()！**

## 2. 配置Filter被 Spring 管理 ##

让自定义的 Filter 被 Spring 的 IOC 容器管理，有三种实现方式，各有优缺点。下面课代表给大家总结一下：

### 1. 使用@Component+@Order ###

在刚刚定义的`MyFilter`类上加上@Component和@Order注解，即可被Spring管理

@Component
    @Order(1)
    public class MyFilter implements Filter {
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
            System.out.println("MyFilter");
            // 要继续处理请求，必须添加 filterChain.doFilter()
            filterChain.doFilter(servletRequest,servletResponse);
        }
    }

没错就这么简单，这样 MyFilter 就生效了，写个`Controller` 调用一下就可以看到效果。

当有多个Filter时，这里的`@Order(1)`注解会指定执行顺序，数字越小，越优先执行，如果只写`@Order`，默认顺序值是`Integer.MAX_VALUE`。

@Component + @Order 注解方式配置简单，支持自定义 Filter 顺序。缺点是只能拦截所有URL，不能通过配置去拦截指定的 URL。

### 2.@WebFilter+@ServletComponentScan ###

在 `MyFilter`上添加`@WebFilter`注解，并在启动类上增加`@ServletComponentScan("com.zhengxl.filterdemo.filter")`注解，参数就是Filter所在的包路径，相当于告诉 SpringBoot，去哪里扫描 Filter

@WebFilter(urlPatterns = "/*")
    public class MyFilter implements Filter {
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
            System.out.println("MyFilter");
            // 要继续处理请求，必须添加 filterChain.doFilter()
            filterChain.doFilter(servletRequest,servletResponse);
        }
    }

@SpringBootApplication
    @ServletComponentScan("com.zhengxl.filterdemo.filter")
    public class FilterDemoApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(FilterDemoApplication.class, args);
        }
    
    }

@WebFilter+@ServletComponentScan 注解方式支持对 Filter 匹配指定URL，但是不支持指定 Filter 的执行顺序。

### 3. JavaConfig 配置方式 ###

@Configuration
    public class FilterConfig {
        @Bean
        public FilterRegistrationBean registerMyFilter(){
            FilterRegistrationBean<MyFilter> bean = new FilterRegistrationBean<>();
            bean.setOrder(1);
            bean.setFilter(new MyFilter());
            // 匹配"/hello/"下面的所有url
            bean.addUrlPatterns("/hello/*");
            return bean;
        }
        @Bean
        public FilterRegistrationBean registerMyAnotherFilter(){
            FilterRegistrationBean<MyAnotherFilter> bean = new FilterRegistrationBean<>();
            bean.setOrder(2);
            bean.setFilter(new MyAnotherFilter());
            // 匹配所有url
            bean.addUrlPatterns("/*");
            return bean;
        }
    }

通过 Java 代码显式配置 Filter ，功能强大，配置灵活。只需要把每个自定义的 Filter 声明成 Bean 交给 Spring 管理即可，还可以设置匹配的 URL 、指定 Filter 的先后顺序。

## 3. 三种方式对比 ##

以上介绍完 SpringBoot 中三种 Filter的使用姿势，非常简单，下面列个表格总结一下：

<table> 
 <thead> 
  <tr> 
   <th>使用方式</th> 
   <th>排序</th> 
   <th>指定URL</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Component<br>@Order</td> 
   <td>1</td> 
   <td>0</td> 
  </tr> 
  <tr> 
   <td>@WebFilter<br>@ServletComponentScan</td> 
   <td>0</td> 
   <td>1</td> 
  </tr> 
  <tr> 
   <td>JavaConfig</td> 
   <td>1</td> 
   <td>1</td> 
  </tr> 
 </tbody> 
</table>

实际使用过程中，可以按照业务需求选择合适的使用方式，比如：如果编写的过滤器要拦截所有请求，不需要指定URL，那选择最简单的 @Component+@Order 就非常合适。

PS：其实还有第四种，web.xml配置，不过这都2020年了，用 SpringBoot 的自动装配或者 JavaConfig 不是更方便吗？

![3419873f598042fb02d6e1e65bdaa799.gif][]

![7c29e8af11a7e4c56cb28675f28ace02.png][]

[![d7f723eb12e639e78dcf8479585c1a1c.png][]][d7f723eb12e639e78dcf8479585c1a1c.png 1]

[![3b30cff8eeb2165ec7096700aac04ca3.png][]][3b30cff8eeb2165ec7096700aac04ca3.png 1]

[![c4e4dcc445dbbde612ca9d280d8b7e84.png][]][c4e4dcc445dbbde612ca9d280d8b7e84.png 1]

[![4d23f129d9c4c12cea7cab8938021009.png][]][4d23f129d9c4c12cea7cab8938021009.png 1]

[![091287d5c4f075a51bd101ccb89d3857.png][]][091287d5c4f075a51bd101ccb89d3857.png 1]

**关注Java技术栈看更多干货**

![527f7bf6725860e27553e4f3a1f16cf6.png][]

![ced1c7173707c7ffb6a03c30eab781c2.gif][]

获取 Spring Boot 实战笔记！

[be20fa4af3106063f9c26348b82c3631.png]: /images/20220828/a4041e55c912405ca26938e5e4b0eccb.png
[7f91630e3718a9a88361264bbce5a98f.png]: /images/20220828/69109314d61e4d6188aed62781565a67.png
[3419873f598042fb02d6e1e65bdaa799.gif]: /images/20220828/f2edde412b2b40dbad30ccf4f483dcd1.png
[7c29e8af11a7e4c56cb28675f28ace02.png]: /images/20220828/34f2e651315046ea9162313464a97a67.png
[d7f723eb12e639e78dcf8479585c1a1c.png]: /images/20220828/5454064dd96a43079ca34553b90b8503.png
[d7f723eb12e639e78dcf8479585c1a1c.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247539795&scene=21&sn=1efca511169265e8146e90db220159d5#wechat_redirect
[3b30cff8eeb2165ec7096700aac04ca3.png]: /images/20220828/c50ff253700f42b386dc7930b6a140cc.png
[3b30cff8eeb2165ec7096700aac04ca3.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=2&mid=2247539679&scene=21&sn=c197d84d39f21de9f12987e1781d1dfc#wechat_redirect
[c4e4dcc445dbbde612ca9d280d8b7e84.png]: /images/20220828/e788dabbb6fd4d36a71be922123a0457.png
[c4e4dcc445dbbde612ca9d280d8b7e84.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=2&mid=2247540613&scene=21&sn=acbe3189c3e5d11419b8f383f36b145f#wechat_redirect
[4d23f129d9c4c12cea7cab8938021009.png]: /images/20220828/e0d370f2bd964060bf6535a095eed343.png
[4d23f129d9c4c12cea7cab8938021009.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247537730&scene=21&sn=3869e164e482b838671fa8896cb33cdb#wechat_redirect
[091287d5c4f075a51bd101ccb89d3857.png]: /images/20220828/aa9b4422393d48e1aeed7baddf13fb34.png
[091287d5c4f075a51bd101ccb89d3857.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247540947&scene=21&sn=a4941f93acb4ee551534a4a1f57d9376#wechat_redirect
[527f7bf6725860e27553e4f3a1f16cf6.png]: /images/20220828/bd735bd50f9e47a3a90831ad843f8ff5.png
[ced1c7173707c7ffb6a03c30eab781c2.gif]: /images/20220828/1c0847fc9e304505a7ee298f1927a2d3.png