springboot 过滤器

server/2024/9/23 4:23:03/

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)

java">package org.javatrip.springbootfilter;import jakarta.servlet.*;
import java.io.IOException;
public class MyFilter_Filter implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {Filter.super.init(filterConfig);System.out.println("MyFilter init");}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {// 执行一些预处理操作System.out.println("1Filter==Before the request...");// 调用下一个过滤器filterChain.doFilter(servletRequest, servletResponse);// 执行一些后处理操作System.out.println("1Filter==After the request...");}@Overridepublic void destroy() {System.out.println("MyFilter destroy");Filter.super.destroy();}
}

通过继承 org.springframework.web.filter.OncePerRequestFilter类覆写 doFilterInternal方法实现过滤器

完整代码(方式2)

java">package org.javatrip.springbootfilter;import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.web.filter.OncePerRequestFilter;import java.io.IOException;/*** @author 10914*/
public class MyFilter_OncePerRequestFilter extends OncePerRequestFilter {@Overrideprotected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {// 执行一些预处理操作System.out.println("2Filter==Before the request...");// 调用下一个过滤器filterChain.doFilter(request, response);// 执行一些后处理操作System.out.println("2Filter==After the request...");}
}

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

Springboot中通过配置org.springframework.boot.web.servlet.FilterRegistrationBean类的方式可以动态的注册过滤。
FilterRegistrationBean注册时推荐使用泛型的方式,这样更清晰。
【注意】1、多个过滤器的执行顺序为套娃式的
在这里插入图片描述
2、FilterRegistrationBean这种方式注册过滤器

完整代码(方式1)

java">package org.javatrip.springbootfilter;import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class MyFilterConfiguration  {// 过滤器1@Beanpublic FilterRegistrationBean<MyFilter_Filter> MyFilter_Filter() {FilterRegistrationBean<MyFilter_Filter> registrationBean = new FilterRegistrationBean<>();// 设置过滤器registrationBean.setFilter(new MyFilter_Filter());// 设置过滤器顺序,匹配模式registrationBean.addUrlPatterns("/*");// 设置过滤器顺序,数字小的在先执行registrationBean.setOrder(1);return registrationBean;}// 过滤器2@Beanpublic FilterRegistrationBean<MyFilter_OncePerRequestFilter> MyFilter_OncePerRequestFilter() {FilterRegistrationBean<MyFilter_OncePerRequestFilter> registrationBean = new FilterRegistrationBean<>();// 设置过滤器registrationBean.setFilter(new MyFilter_OncePerRequestFilter());// 设置过滤器顺序,匹配模式registrationBean.addUrlPatterns("/*");// 设置过滤器顺序,数字小的在先执行registrationBean.setOrder(2);return registrationBean;}
}

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

(1)@WebFilter+@ServletComponentScan注解

(1.1)@WebFilter实现过滤器的定义与配置拦截路径

java">package org.javatrip.springbootfilter;import jakarta.servlet.*;
import jakarta.servlet.annotation.WebFilter;
import java.io.IOException;@WebFilter(filterName = "MyFilter_Filter3", urlPatterns = "/*")
public class MyFilter_Filter3 implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {Filter.super.init(filterConfig);System.out.println("3Filter==init");}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {// 执行一些预处理操作System.out.println("3Filter==Before the request...");// 调用下一个过滤器filterChain.doFilter(servletRequest, servletResponse);// 执行一些后处理操作System.out.println("3Filter==After the request...");}
}

(1.2)启动类配合@ServletComponentScan注解注册过滤器

java">package org.javatrip.springbootfilter;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;@SpringBootApplication
@ServletComponentScan
public class SpringbootFilterApplication {public static void main(String[] args) {SpringApplication.run(SpringbootFilterApplication.class, args);}}

(2)@WebFilter/@Component注解

java">package org.javatrip.springbootfilter;import jakarta.servlet.*;
import jakarta.servlet.annotation.WebFilter;
import java.io.IOException;@WebFilter(filterName = "MyFilter_Filter3", urlPatterns = "/*")
@Component
public class MyFilter_Filter3 implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {Filter.super.init(filterConfig);System.out.println("3Filter==init");}@Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {// 执行一些预处理操作System.out.println("3Filter==Before the request...");// 调用下一个过滤器filterChain.doFilter(servletRequest, servletResponse);// 执行一些后处理操作System.out.println("3Filter==After the request...");}
}

【注意】这种方式针对项目使用单过滤器的情况,由于该方式无法配置多个过滤器的执行顺序因此建议在单个情况时使用。 在多个过滤器时建议使用FilterRegistrationBean的方式配置。
@ServletComponentScan 和 @Component 两个注解只用其中一个,一个定时器如果同时使用则会出现定时器初始化方法重复执行的问题

4 spring 通过web.xml配置过滤器

<filter><filter-name>myFilter</filter-name><filter-class>org.javatrip.springbootfilter.MyFilter_Filter4</filter-class>
</filter>
<filter-mapping><filter-name>myFilter</filter-name><url-pattern>/*</url-pattern> <!-- 过滤器将应用于所有URL --><exclude-url-pattern>/login</exclude-url-pattern> <!-- 排除登录页面 --><exclude-url-pattern>/register</exclude-url-pattern> <!-- 排除注册页面 -->
</filter-mapping>

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

总结

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


http://www.ppmy.cn/server/100513.html

相关文章

【机器学习】深度学习实践

欢迎来到 破晓的历程的 博客 ⛺️不负时光&#xff0c;不负己✈️ 文章目录 引言一、深度学习基础二、图像分类示例三、拓展思考结语 引言 在当今人工智能的浪潮中&#xff0c;深度学习作为其核心驱动力之一&#xff0c;正以前所未有的速度改变着我们的世界。从图像识别、语音…

探索Llama 3.1 : 405B参数模型:部署、硬件配置、测试与训练的心得

引言 随着人工智能技术的快速发展&#xff0c;大规模语言模型&#xff08;Large Language Models, LLMs&#xff09;在自然语言处理&#xff08;NLP&#xff09;领域取得了显著的突破。MetaAI最新发布的Llama 3.1 : 405B参数模型&#xff0c;凭借其庞大的参数规模和先进的架构…

代码随想录算法训练营day39|动态规划part07

第一题&#xff1a;198. House Robber 这题的dp和滚动数组的解法都值得学习一下。 // 动态规划 class Solution {public int rob(int[] nums) {if (nums null || nums.length 0) return 0;if (nums.length 1) return nums[0];int[] dp new int[nums.length];dp[0] nums…

Qt自定义控件:关于大佬“飞扬青云“的自定义UI控件的使用教程(MinGw,MSVC)

前言 最近在搞自定义控件&#xff0c;无意间发现大佬飞扬青云的开源项目&#xff0c;Qt/C编写超精美自定义控件 这里先贴出大佬项目地址和博客 码云&#xff1a;wwlzq5/qucsdk (gitee.com)&#xff08;旧版下载地址Qt4.7到Qt5.14&#xff09; github&#xff1a;https://git…

MongoDB数据类型介绍

MongoDB作为一种高性能、开源、无模式的文档型数据库&#xff0c;支持丰富的数据类型&#xff0c;以满足各种复杂的数据存储需求。本文将详细介绍MongoDB支持的主要数据类型&#xff0c;包括数值类型、字符串类型、日期和时间类型、布尔类型、二进制类型、数组、对象以及其他扩…

CsvExport:一个.Net高性能、低内存的CSV导出开源库

在我们项目开发中&#xff0c;导出CSV数据功能是非常常见的。 今天推荐一个高性能、低内存的CSV导出开源库。 01 项目简介 CsvExport是一个基于C#非常简单和快速的CSV导出开源库。 该开源库的核心特点&#xff1a; 导出功能兼容性高&#xff08;自动检测分隔符&#xff0c;…

Element UI导航菜单刷新就复原问题解决方法~

1、首先要知道为什么一刷新就复原了&#xff0c;是因为default-active属性设置的是默认值&#xff0c;是一个死值&#xff0c;一旦刷新就会复原&#xff0c;造成高亮不能保持&#xff0c;那么怎么解决呢&#xff1f; 2、很简单&#xff0c;无需像一些博主一样绑定path。思路&a…

机械行业数字化生产供应链产品解决方案(七)

在机械行业的数字化生产供应链产品解决方案中&#xff0c;通过全面部署物联网&#xff08;IoT&#xff09;传感器、智能分析平台和自动化控制系统&#xff0c;实现对生产设备的实时监控和数据采集&#xff0c;并结合大数据和人工智能技术进行深度分析&#xff0c;从而优化生产调…