Spring Boot 使用 Filter 的正确姿势!

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

 [[424114]]

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

它的工作流程如图:

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

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

1. 编写Filter

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

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

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管理 

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

没错就这么简单,这样 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 

  1. @WebFilter(urlPatterns = "/*" 
  2. public class MyFilter implements Filter {  
  3.     @Override  
  4.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {  
  5.         System.out.println("MyFilter");  
  6.         // 要继续处理请求,必须添加 filterChain.doFilter()  
  7.         filterChain.doFilter(servletRequest,servletResponse);  
  8.     }  
  9.  
  1. @SpringBootApplication  
  2. @ServletComponentScan("com.zhengxl.filterdemo.filter")  
  3. public class FilterDemoApplication {  
  4.     public static void main(String[] args) {  
  5.         SpringApplication.run(FilterDemoApplication.class, args);  
  6.     }  

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

(3)JavaConfig 配置方式 

  1. @Configuration  
  2. public class FilterConfig {  
  3.     @Bean  
  4.     public FilterRegistrationBean registerMyFilter(){  
  5.         FilterRegistrationBean<MyFilter> bean = new FilterRegistrationBean<>();  
  6.         bean.setOrder(1);  
  7.         bean.setFilter(new MyFilter());  
  8.         // 匹配"/hello/"下面的所有url  
  9.         bean.addUrlPatterns("/hello/*");  
  10.         return bean;  
  11.     }  
  12.     @Bean  
  13.     public FilterRegistrationBean registerMyAnotherFilter(){  
  14.         FilterRegistrationBean<MyAnotherFilter> bean = new FilterRegistrationBean<>();  
  15.         bean.setOrder(2);  
  16.         bean.setFilter(new MyAnotherFilter());  
  17.         // 匹配所有url  
  18.         bean.addUrlPatterns("/*");  
  19.         return bean;  
  20.     }  

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

3. 三种方式对比

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

使用方式 排序 指定URL
@Component
@Order
1 0
@WebFilter
@ServletComponentScan
0 1
JavaConfig 1 1

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

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

 

责任编辑:庞桂玉 来源: Java技术栈
相关推荐

2024-08-12 10:13:01

2024-08-01 09:10:03

2017-02-23 15:37:44

OptionObject容器

2017-07-10 13:09:45

前端Flexbox

2020-08-05 08:30:25

Spring BootJavaSE代码

2024-08-02 09:15:22

Spring捕捉格式

2016-01-05 11:28:20

按需付费云计算docker

2022-02-21 11:21:40

golang编程语言

2018-01-11 15:31:39

命令Linux关机

2016-05-09 10:41:03

算法分析开发

2020-06-18 08:18:35

密码加密安全

2020-08-31 06:54:37

注解脱敏ELK

2021-07-12 11:35:13

Go协程Goroutine

2017-03-16 11:39:33

Openstack源码姿势

2023-01-30 07:41:43

2021-10-08 08:38:00

Pipelineshell命令Jenkins

2019-10-18 10:43:11

JPASpring Boot Flyway

2017-10-12 11:30:34

Spark代码PR

2021-01-08 08:10:34

MySQL表空间回收

2019-12-27 15:58:57

大数据IT互联网
点赞
收藏

51CTO技术栈公众号