【SpringBoot】过滤器Filter使用方式及遇到的不过滤路径问题

本文详细介绍了在SpringBoot中使用过滤器Filter的两种方法:@WebFilter注解配置与@Bean方式配置。解析了不当使用@Component导致过滤器不按预期工作的问题及解决方案,强调了@ServletComponentScan的作用。同时,提供了多个过滤器执行顺序设定的方法。

在springboot中使用过滤器Filter有两种方式:
1、使用@WebFilter注解方式来配置。
2、在启动类中使用@Bean方式配置。

一、@WebFilter注解方式

@Component
@WebFilter(urlPatterns = "/test/list", filterName = "testFilter")
public class TestFilter implements Filter {
    ......
}

网上有说使用这种方法配置过滤器,自己试了一下,发起请求时确实进到过滤器里来了,但是并没有按照“/test/list”路径进行过滤,而是过滤了所有URL请求。在百度之后找到解决方案如下:

解决方法
首先,在上边TestFilter类上加@WebFilter注解是没错的,但是不要加@Component注解,然后在springboot的启动类上加上注解 @ServletComponentScan即可过滤指定路径。
原因
如果添加了@Component或@Configuration,又添加了@WebFilter(),那么会初始化两次Filter,并且会过滤所有路径+自己指定的路径 ,便会出现对没有指定的URL也会进行过滤的情况。

@ServletComponentScan注解的含义:在SpringBootApplication(启动类)上使用@ServletComponentScan注解后,Servlet、Filter(过滤器)、Listener(监听器)可以直接通过@WebServlet、@WebFilter、@WebListener注解自动注册,无需其他代码!

二、@Bean注解方式

    @Bean
    public FilterRegistrationBean testFilterRegistration() {
    		FilterRegistrationBean registration = new FilterRegistrationBean(new TestFilter());
    		registration.addUrlPatterns("/test/list"); 
    		registration.setName("testFilter");
    		return registration;
    }

在启动类中写上上述代码即可。

当有多个过滤器时可以通过registration.setOrder(1); 来设定过滤器执行顺序。当指定order时,Filter的执行顺序和注册顺序是无关的。order数字越小,优先级越高!

	@Bean
	public FilterRegistrationBean testFilterRegistration() {
		FilterRegistrationBean registration = new FilterRegistrationBean(new TestFilter());
		registration.addUrlPatterns("/test/list"); 
		registration.setName("testFilter");
		
		registration.setOrder(1);
		return registration;
	}

参考博文:

https://blog.youkuaiyun.com/testcs_dn/article/details/80265196
https://blog.youkuaiyun.com/east123321/article/details/79694974

<think>好的,我现在要帮用户解决在Spring Boot中使用过滤器问题。用户可能刚接触Spring Boot,需要详细的步骤和示例。首先,我需要回忆一下Spring Boot中Filter的几种常见实现方式。 记得有几种方法,比如使用@WebFilter注解,或者通过FilterRegistrationBean来注册。用户提供的引用里提到使用@WebFilterFilterRegistrationBean,还有提到要添加@Component注解。可能需要分步骤讲解同的方法,并比较它们的优缺点。 用户给的引用2推荐使用FilterRegistrationBean并配合@Component,这可能更灵活,可以配置过滤路径。而引用4提到整合Filter成功的例子,可能涉及组件注册方式。需要确保代码示例正确,比如配置类中的写法。 还要注意,是否需要添加额外的依赖?引用5提到spring-boot-starter-web,所以应该提醒用户引入这个依赖。另外,是否需要考虑顺序问题,比如多个Filter的执行顺序,可以通过FilterRegistrationBean设置order属性。 用户可能还关心如何测试Filter是否生效,可以建议在Filter中打印日志,或者在浏览器中访问路径查看效果。同时,注意事项部分需要提到要重复注册,避免路径配置错误,以及处理异常等。 最后,生成相关问题的时候,要想到用户可能接下来会问如何控制多个Filter的顺序,或者如何结合Spring Security使用Filter,以及监控相关的内容,比如Druid的Filter配置,如引用3提到的。需要确保回答覆盖这些潜在的问题点,并引导用户进一步学习。</think>### Spring Boot 中过滤器使用教程 在 Spring Boot 中使用过滤器Filter)可以通过以下三种方式实现,每种方法均提供代码示例和注意事项。 --- #### **方法一:使用 `@WebFilter` 注解** 1. **定义过滤器类** 使用 `@WebFilter` 注解标记类,并通过 `urlPatterns` 指定过滤路径: ```java @Component @WebFilter(urlPatterns = "/*") // 过滤所有请求 public class MyFilter implements Filter { @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { System.out.println("请求进入过滤器"); chain.doFilter(request, response); // 放行请求 } } ``` 2. **启用扫描** 在启动类添加 `@ServletComponentScan` 以扫描过滤器: ```java @SpringBootApplication @ServletComponentScan // 启用 Servlet 组件扫描 public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` **注意事项**: - 需配合 `@Component` 将过滤器注册到 Spring 容器[^2]。 - 过滤路径需明确,避免过度拦截。 --- #### **方法二:通过 `FilterRegistrationBean` 注册** 1. **定义过滤器类** 实现 `Filter` 接口: ```java public class MyFilter implements Filter { @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { System.out.println("过滤器逻辑执行"); chain.doFilter(request, response); } } ``` 2. **注册过滤器** 在配置类中使用 `FilterRegistrationBean`: ```java @Configuration public class FilterConfig { @Bean public FilterRegistrationBean<MyFilter> myFilterRegistration() { FilterRegistrationBean<MyFilter> registration = new FilterRegistrationBean<>(); registration.setFilter(new MyFilter()); registration.addUrlPatterns("/*"); // 设置过滤路径 registration.setOrder(1); // 定义执行顺序 return registration; } } ``` **优点**: - 灵活配置多个路径和优先级[^4]。 - 无需依赖 Servlet API 注解。 --- #### **方法三:整合 Spring Security 过滤器** 若已集成 Spring Security,可通过配置类添加自定义过滤器: ```java @Configuration @EnableWebSecurity public class SecurityConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { http.addFilterBefore(new MySecurityFilter(), UsernamePasswordAuthenticationFilter.class); } } ``` **适用场景**:处理认证、授权等安全逻辑[^1]。 --- #### **依赖配置** 确保 `pom.xml` 包含 Spring Boot Web 依赖: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> ``` --- #### **注意事项** 1. **避免重复注册**:若使用 `@WebFilter` 和 `FilterRegistrationBean` 同时注册同一过滤器,会导致重复执行。 2. **路径匹配规则**:`urlPatterns` 支持 `/*`(所有请求)、`/api/*`(特定路径)等格式。 3. **异常处理**:过滤器中需妥善处理异常,避免请求中断。 ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值