springboot 过滤器

1、过滤器的实现

springboot中过滤器通过实现接口Filter并重写init、doFilter、destroy三个方法。在三个方法中加入自己的业务逻辑处理。
【注意】Filter接口的完备包名在不同的jdk版中中的变革。这里示例中使用的版本为 open-jdk17。完备名称 jakarta.servlet.Filter。如果使用的是常用的1.8的话，那么使用的应该为 javax.servlet.Filter。
   从 JDK 11 开始，Java SE 平台开始逐步淘汰 javax.* 包，并渐渐将其替换为 jakarta.* 包。这是由于 Java EE 从 Oracle 转移到了 Eclipse 基金会，并改名为 Jakarta EE，因此相关的 API 也相应地进行了迁移和重命名。
javax.servlet 和 jakarta.servlet 的区别仅在于包名的变革，代表不同版本的 Java Servlet API，也就意味着在代码中使用javax.servlet包大概使用jakarta.servlet包，而不必要修改代码。这也是必要注意在升级到 JDK 11 及以上版本后在使用相关包时的变革。
使用tomcat摆设 jakarta.servlet时，tomcat10以后才支持 jakarta.servlet，而tomcat10版本必要jdk11及以后版本。
在springboot 3.3.2中内嵌tomcat的版本为10.1.26因此使用Filter要接纳jakarta包的Filter
  完备代码（方式1）

1. package org.javatrip.springbootfilter;
3. import jakarta.servlet.*;
4. import java.io.IOException;
5. public class MyFilter_Filter implements Filter {
7.     @Override
8.     public void init(FilterConfig filterConfig) throws ServletException {
9.         Filter.super.init(filterConfig);
10.         System.out.println("MyFilter init");
11.     }
13.     @Override
14.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
15.         // 执行一些预处理操作
16.         System.out.println("1Filter==Before the request...");
17.         // 调用下一个过滤器
18.         filterChain.doFilter(servletRequest, servletResponse);
19.         // 执行一些后处理操作
20.         System.out.println("1Filter==After the request...");
21.     }
23.     @Override
24.     public void destroy() {
25.         System.out.println("MyFilter destroy");
26.         Filter.super.destroy();
27.     }
28. }

复制代码

通过继承 org.springframework.web.filter.OncePerRequestFilter类覆写 doFilterInternal方法实现过滤器
完备代码（方式2）

1. package org.javatrip.springbootfilter;
3. import jakarta.servlet.FilterChain;
4. import jakarta.servlet.ServletException;
5. import jakarta.servlet.http.HttpServletRequest;
6. import jakarta.servlet.http.HttpServletResponse;
7. import org.springframework.web.filter.OncePerRequestFilter;
9. import java.io.IOException;
11. /**
12. * @author 10914
13. */
14. public class MyFilter_OncePerRequestFilter extends OncePerRequestFilter {
15.     @Override
16.     protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
17.         // 执行一些预处理操作
18.         System.out.println("2Filter==Before the request...");
19.         // 调用下一个过滤器
20.         filterChain.doFilter(request, response);
21.         // 执行一些后处理操作
22.         System.out.println("2Filter==After the request...");
23.     }
24. }

复制代码

2、过滤器的注册、多个之间的实行次序、过滤规则及排除过滤规则

Springboot中通过配置org.springframework.boot.web.servlet.FilterRegistrationBean类的方式可以动态的注册过滤。
FilterRegistrationBean注册时推荐使用泛型的方式，这样更清晰。
【注意】1、多个过滤器的实行次序为套娃式的

2、FilterRegistrationBean这种方式注册过滤器
完备代码（方式1）

1. package org.javatrip.springbootfilter;
3. import org.springframework.boot.web.servlet.FilterRegistrationBean;
4. import org.springframework.context.annotation.Bean;
5. import org.springframework.context.annotation.Configuration;
7. @Configuration
8. public class MyFilterConfiguration  {
10.         // 过滤器1
11.     @Bean
12.     public FilterRegistrationBean<MyFilter_Filter> MyFilter_Filter() {
13.         FilterRegistrationBean<MyFilter_Filter> registrationBean = new FilterRegistrationBean<>();
14.         // 设置过滤器
15.         registrationBean.setFilter(new MyFilter_Filter());
16.         // 设置过滤器顺序，匹配模式
17.         registrationBean.addUrlPatterns("/*");
18.         // 设置过滤器顺序，数字小的在先执行
19.         registrationBean.setOrder(1);
20.         return registrationBean;
21.     }
22.         // 过滤器2
23.     @Bean
24.     public FilterRegistrationBean<MyFilter_OncePerRequestFilter> MyFilter_OncePerRequestFilter() {
25.         FilterRegistrationBean<MyFilter_OncePerRequestFilter> registrationBean = new FilterRegistrationBean<>();
26.         // 设置过滤器
27.         registrationBean.setFilter(new MyFilter_OncePerRequestFilter());
28.         // 设置过滤器顺序，匹配模式
29.         registrationBean.addUrlPatterns("/*");
30.          // 设置过滤器顺序，数字小的在先执行
31.         registrationBean.setOrder(2);
32.         return registrationBean;
33.     }
34. }

复制代码

3 通过注解实现配置及注册==@WebFilter+@ServletComponentScan/@Component注解

（1）@WebFilter+@ServletComponentScan注解

（1.1）@WebFilter实现过滤器的界说与配置拦截路径

1. package org.javatrip.springbootfilter;
3. import jakarta.servlet.*;
4. import jakarta.servlet.annotation.WebFilter;
5. import java.io.IOException;
7. @WebFilter(filterName = "MyFilter_Filter3", urlPatterns = "/*")
8. public class MyFilter_Filter3 implements Filter {
10.     @Override
11.     public void init(FilterConfig filterConfig) throws ServletException {
12.         Filter.super.init(filterConfig);
13.         System.out.println("3Filter==init");
14.     }
16.     @Override
17.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
18.         // 执行一些预处理操作
19.         System.out.println("3Filter==Before the request...");
20.         // 调用下一个过滤器
21.         filterChain.doFilter(servletRequest, servletResponse);
22.         // 执行一些后处理操作
23.         System.out.println("3Filter==After the request...");
24.     }
25. }

复制代码

（1.2）启动类配合@ServletComponentScan注解注册过滤器

1. package org.javatrip.springbootfilter;
3. import org.springframework.boot.SpringApplication;
4. import org.springframework.boot.autoconfigure.SpringBootApplication;
5. import org.springframework.boot.web.servlet.ServletComponentScan;
7. @SpringBootApplication
8. @ServletComponentScan
9. public class SpringbootFilterApplication {
11.     public static void main(String[] args) {
12.         SpringApplication.run(SpringbootFilterApplication.class, args);
13.     }
15. }

复制代码

（2）@WebFilter/@Component注解

1. package org.javatrip.springbootfilter;
3. import jakarta.servlet.*;
4. import jakarta.servlet.annotation.WebFilter;
5. import java.io.IOException;
7. @WebFilter(filterName = "MyFilter_Filter3", urlPatterns = "/*")
8. @Component
9. public class MyFilter_Filter3 implements Filter {
11.     @Override
12.     public void init(FilterConfig filterConfig) throws ServletException {
13.         Filter.super.init(filterConfig);
14.         System.out.println("3Filter==init");
15.     }
17.     @Override
18.     public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
19.         // 执行一些预处理操作
20.         System.out.println("3Filter==Before the request...");
21.         // 调用下一个过滤器
22.         filterChain.doFilter(servletRequest, servletResponse);
23.         // 执行一些后处理操作
24.         System.out.println("3Filter==After the request...");
25.     }
26. }

复制代码

【注意】这种方式针对项目使用单过滤器的环境，由于该方式无法配置多个过滤器的实行次序因此发起在单个环境时使用。 在多个过滤器时发起使用FilterRegistrationBean的方式配置。
@ServletComponentScan 和 @Component 两个注解只用其中一个，一个定时器如果同时使用则会出现定时器初始化方法重复实行的题目
4 spring 通过web.xml配置过滤器

1. <filter>
2.     <filter-name>myFilter</filter-name>
3.     <filter-class>org.javatrip.springbootfilter.MyFilter_Filter4</filter-class>
4. </filter>
5. <filter-mapping>
6.     <filter-name>myFilter</filter-name>
7.     <url-pattern>/*</url-pattern> <!-- 过滤器将应用于所有URL -->
8.     <exclude-url-pattern>/login</exclude-url-pattern> <!-- 排除登录页面 -->
9.     <exclude-url-pattern>/register</exclude-url-pattern> <!-- 排除注册页面 -->
10. </filter-mapping>

复制代码

这种方式可以配置拦截地址和排除的拦截地址，配置多个过滤器时，次序为配置编写的次序，写在前面的先实行。
总结

1、简单的单个过滤器使用 注解方式
@WebFilter+@ServletComponentScan/@Component
2、复杂环境多个过滤器使用FilterRegistrationBean注册，注意最好用泛型

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。