springboot 过滤器

大溪流

已于 2024-08-10 23:41:28 修改

阅读量728

点赞数 15

文章标签： spring boot 后端 java 过滤器

于 2024-08-10 18:22:29 首次发布

本文链接：https://blog.csdn.net/qq_32719215/article/details/141090181

版权

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）

package org.javatrip.springbootfilter;

import jakarta.servlet.*;
import java.io.IOException;
public class MyFilter_Filter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
        System.out.println("MyFilter init");
    }

    @Override
    public 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...");
    }

    @Override
    public void destroy() {
        System.out.println("MyFilter destroy");
        Filter.super.destroy();
    }
}

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

完整代码（方式2）

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 {
    @Override
    protected 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）

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
    @Bean
    public FilterRegistrationBean<MyFilter_Filter> MyFilter_Filter() {
        FilterRegistrationBean<MyFilter_Filter> registrationBean = new FilterRegistrationBean<>();
        // 设置过滤器
        registrationBean.setFilter(new MyFilter_Filter());
        // 设置过滤器顺序，匹配模式
        registrationBean.addUrlPatterns("/*");
        // 设置过滤器顺序，数字小的在先执行
        registrationBean.setOrder(1);
        return registrationBean;
    }
	// 过滤器2
    @Bean
    public 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实现过滤器的定义与配置拦截路径

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 {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
        System.out.println("3Filter==init");
    }

    @Override
    public 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注解注册过滤器

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注解

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 {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
        System.out.println("3Filter==init");
    }

    @Override
    public 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>