SpringBoot过滤器简单构建详细教程以及与拦截器区别解释

1. 作用范围：过滤器基于Servlet规范，作用于更广泛的层面，不仅限于Spring MVC，它可以拦截进入Web应用的所有请求，包括静态资源请求。过滤器可以对请求和响应的内容进行预处理和后处理。
2. 实现方式：过滤器需要实现javax.servlet.Filter接口，并在web.xml中配置，或使用Spring Boot的@WebFilter注解进行配置。
3. 执行时机：过滤器的执行时机更早，它在请求进入Servlet之前和响应离开Servlet之后执行，可以用来做字符编码转换、安全验证、压缩响应内容等。
4. 依赖性：过滤器依赖于Servlet容器，是Java EE标准的一部分，无需依赖Spring框架。

SpringBoot中拦截器与过滤器区别：

拦截器更面向业务逻辑，与Spring框架集成紧密，而过滤器则更加通用，适用于更底层的网络请求处理。

• 拦截器：通常用于处理业务逻辑相关的拦截，如权限检查、日志记录、事务管理等，更适合需要访问Spring容器中Bean的场景。
• 过滤器：适用于更底层的处理，如处理跨站脚本攻击（XSS）、敏感词过滤、请求与响应内容的修改等，尤其是那些不特定于某个框架的通用处理逻辑。

拦截器构建文章：SpringBoot中HandlerInterceptor拦截器的构建详细教程-CSDN博客

目录

Spring Boot项目构建过滤器

1、新建一个springboot项目

2、创建过滤器类

3、注册过滤器

方法一：使用@Bean

方法二：使用@WebServletComponentScan

4、创建controller类

5、启动Spring Boot应用

---

Spring Boot项目构建过滤器

1、新建一个springboot项目

项目完成后的结构：

pom文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.softeem</groupId>
    <artifactId>springboot</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.6.13</spring-boot.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>
                <configuration>
                    <mainClass>com.softeem.springboot.SpringbootApplication</mainClass>
                    <skip>true</skip>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

2、创建过滤器类

//@WebFilter(urlPatterns = "/user/*") //看注册过滤器方法而定，如果采用@WebServletComponentScan 就需要这个注解
public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("--------------您已进入过滤器------------");
        
        filterChain.doFilter(servletRequest, servletResponse);
    }
}

详解：

• @WebFilter(urlPatterns = "/user/*")：这个注解用来标记该类是一个过滤器，并且指定了该过滤器需要拦截的URL模式。（此处表示所有以/user/开头的请求路径都会被此过滤器处理）
• 实现javax.servlet.Filter接口的核心方法doFilter，这个方法会在每次请求匹配到该过滤器的URL模式时被调用。
• filterChain.doFilter(servletRequest, servletResponse); 这行代码是调用过滤链中的下一个过滤器或最终的目标资源。

3、注册过滤器

方法一：使用@Bean

在Sprin Boot的配置类中，可以通过@Bean注解将过滤器类注册为一个Bean，并使用FilterRegistrationBean来配置过滤器的详细信息。

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean myFilterRegistrationBean(){
        //注册过滤器
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new MyFilter());
        
        //添加过滤路径
        filterRegistrationBean.addUrlPatterns("/user/*");
        
        return filterRegistrationBean;
    }
}

方法二：使用@WebServletComponentScan

不需要配置类，但需要在上文创建的过滤器类添加注解@WebFilter(urlPatterns = "/user/*")

在主启动类添加注解@ServletComponentScan

4、创建controller类

@RestController
public class UserController {

    @RequestMapping("/user/detail")
    public String userDetail() {
        return "/user/detail";
    }

    @RequestMapping("/center")
    public String center() {
        return "center";
    }
}

5、启动Spring Boot应用

访问/uer/路径

控制台显示