springboot 过滤器简单实现及顺序执行实现

SpringBoot过滤器实现:注解与配置类方式解析
本文介绍了SpringBoot中使用注解和配置类两种方式实现过滤器的方法。通过注解实现时,需注意`servletComponentScan`的使用及`doFilter`的调用顺序。在配置类中,可以通过`FilterRegistrationBean`设置过滤器的执行顺序,该方式的`order`属性生效。示例代码展示了如何注册和配置过滤器,并给出了访问路径的输出结果。

基于注解实现过滤器

实现基础的过滤器, 可以直接用注解的方式实现, 其中要注意的有两点:

  1. 主启动类要加 servletComponentScan
  2. 一定要执行最后一句, 不然不会执行 servlet 的 service 方法, 也就不会执行你的业务方法
    filterChain.doFilter(servletRequest, servletResponse);
    
    另外 urlPatterns 支持 /* 通配, 但不支持 /**/abc 通配
@Order(2)
@WebFilter(urlPatterns={"/*"})
public class DemoFilter01 implements Filter {

	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		System.out.println( "Filter01 执行了");
		filterChain.doFilter(servletRequest, servletResponse);
	}
}

@Order(1)
@WebFilter(urlPatterns={"/**/test1"})
public class DemoFilter02 implements Filter {

	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		System.out.println( "Filter02 执行了");
		filterChain.doFilter(servletRequest, servletResponse);
	}
}

@WebFilter(urlPatterns={"/aaa"})
public class DemoFilter03 implements Filter {

	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		System.out.println( "Filter03 执行了");
        filterChain.doFilter(servletRequest, servletResponse);
	}
}

访问地址 localhost:8080/demo/test1 ,得到以下输出, 加了 order, 经证实对执行顺序没有用

 

基于配置类实现过滤器

基于配置类实现过滤, 则以上代码可以去掉注解

//@WebFilter(urlPatterns={"/*"})
public class DemoFilter01 implements Filter {

	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		System.out.println( "Filter01 执行了");
		filterChain.doFilter(servletRequest, servletResponse);
	}

}

然后声明一个配置类, 在类中声明过滤器类

@Configuration
public class FilterConfig {

	@Bean
	public FilterRegistrationBean registrationBean(){
		FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
		DemoFilter01 demoFilter01 = new DemoFilter01();
		filterRegistrationBean.setFilter(demoFilter01);
		filterRegistrationBean.addUrlPatterns("/*");
		filterRegistrationBean.setName("regist01");
		filterRegistrationBean.setOrder(3);
		return filterRegistrationBean;
	}

	@Bean
	public FilterRegistrationBean registrationBean2(){
		FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
		DemoFilter02 demoFilter02 = new DemoFilter02();
		filterRegistrationBean.setFilter(demoFilter02);
		filterRegistrationBean.addUrlPatterns("/demo/test1");
		filterRegistrationBean.setName("regist02");
		filterRegistrationBean.setOrder(2);
		return filterRegistrationBean;
	}

	@Bean
	public FilterRegistrationBean registrationBean3(){
		FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
		DemoFilter03 demoFilter03 = new DemoFilter03();
		filterRegistrationBean.setFilter(demoFilter03);
		filterRegistrationBean.addUrlPatterns("/aaa");
		filterRegistrationBean.setName("regist03");
		filterRegistrationBean.setOrder(1);
		return filterRegistrationBean;
	}

}

依然访问  localhost:8080/demo/test1 ,得到以下输出 ( 注意代码的 order设置和输出顺序, 证明这种方式的 order 是生效的)

以上就是 springboot 的两种过滤器实现方式了, 记录一下, 也分享给需要的朋友们.

 

<think> 首先,用户的问题是:“我想查找确定Spring Boot过滤器Filter执行顺序的方法 请问如何确定Spring Boot过滤器Filter的执行顺序”。这基于我的系统级指令,我需要用中文回答,结构清晰,逐步解决问题。 我参考了用户提供的引用: - 引用[1]: 讨论了Spring Boot过滤器的概述、数据流程、生命周期,以及使用注解方式实现过滤器。提到了@WebFilter和@Component的使用。 - 引用[2]: 讨论了什么是过滤器,如何使用@Component和FilterRegistrationBean注册过滤器,自定义过滤器示例,多个过滤器执行顺序,以及与其他技术的区别。 - 引用[3]: 简要介绍了Spring Boot和Filter的基本使用,包括定义过滤器。 用户特别提到了“确定Spring Boot过滤器Filter执行顺序的方法”,所以我需要从这些引用中提取相关信息。 从引用[2]中,有一个部分标题是“四、多个 Filter 的执行顺序”,这直接相关。让我梳理一下关键点: - 使用@Component注册过滤器时,执行顺序不确定,因为Spring Bean的加载顺序可能受影响。 - 使用FilterRegistrationBean显式注册时,可以通过设置顺序来控制执行顺序,比如使用setOrder方法。 引用[1]也提到了@WebFilter的使用,但没有特别强调顺序控制。 引用[3]没有深入讨论顺序。 所以,核心方法是从引用[2]来的: 1. **使用 FilterRegistrationBean**: 通过FilterRegistrationBean注册过滤器并设置顺序值。顺序值越小,优先级越高,执行越靠前。 2. **使用 @Order 注解**: 结合@Component或@WebFilter,使用@Order注解指定顺序。 在引用[2]中,明确说: - 当使用@Component时,添加@Order注解可以指定顺序。 - 使用FilterRegistrationBean时,通过setOrder方法设置。 回答结构: - 我应该逐步解释方法。 - 保持清晰:解释是什么、为什么重要、如何操作。 - 最后生成相关问题,作为指令的一部分。 系统指令说: - 所有行内数学表达式用$...$,但这里是关于Spring Boot的,不太可能有数学,所以可能不需要。 - 独立公式用$$...$$,同样不太相关。 - 使用中文。 - 生成相关问题。 - 引用的段落末尾自然地添加引用标识,如[^1]。 在回答中,我需要引用这些资料。用户提供的引用是[^1],[^2],[^3],我应该基于这些引用回答。 步骤: 1. **介绍问题**: 简要说明过滤器执行顺序的重要性。 2. **解释方法**: - 方法1: 使用 FilterRegistrationBean 显式注册并设置顺序。 - 方法2: 使用 @Order 注解配合注解方式。 - 提到默认顺序的注意事项。 3. **提供示例**: 简化代码示例,展示如何实现。 4. **总结**: 强调推荐方法。 5. **生成相关问题**: 作为结尾。 确保回答真实可靠:基于提供的引用,不要添加外部知识。 相关问题生成:指令说“生成相关问题”,在示例中,它在最后添加了相关问题列表。我应该类似地做。 例如: §§相关问题§§ 1. ... 2. ... 现在,构建回答。 </think> ### 确定Spring Boot过滤器Filter的执行顺序 在Spring Boot应用中,过滤器(Filter)用于在请求处理链中拦截请求和响应,执行顺序决定了多个过滤器执行优先级(顺序值越小,优先级越高)。执行顺序的不确定性可能导致逻辑错误或性能问题,因此掌握其控制方法至关重要。以下是基于引用资料的详细解释和方法,采用Spring Boot的常见实践。 #### 为什么执行顺序重要 - 多个过滤器组成一个链式结构(FilterChain),顺序影响处理流程(例如,先执行认证过滤器执行日志过滤器)[^2]。 - 默认情况下,注册方式不同可能导致顺序不一致(如注解方式顺序不确定),需显式控制以确保正确性[^2]。 #### 确定和执行顺序的方法 Spring Boot提供了两种主要方式来控制过滤器执行顺序,核心是通过设置顺序值(order value),值越小执行越早。 1. **使用 FilterRegistrationBean 显式注册并设置顺序(推荐方式)** - 这是最可靠的方法,通过编程方式注册过滤器并指定顺序值。 - 步骤: - 创建一个自定义过滤器类,实现`javax.servlet.Filter`接口。 - 在配置类中,使用`FilterRegistrationBean`注册过滤器,并通过`setOrder(int order)`方法设置顺序值。 - 顺序值可以是任意整数,值越小优先级越高(例如,order=1 先于 order=2)。 - **示例代码**: ```java import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import javax.servlet.Filter; @Configuration public class FilterConfig { @Bean public FilterRegistrationBean<Filter> firstFilter() { FilterRegistrationBean<Filter> registrationBean = new FilterRegistrationBean<>(); registrationBean.setFilter(new CustomFilter1()); // 自定义过滤器实例 registrationBean.addUrlPatterns("/*"); // 设置过滤URL registrationBean.setOrder(1); // 设置顺序值:越小越优先 return registrationBean; } @Bean public FilterRegistrationBean<Filter> secondFilter() { FilterRegistrationBean<Filter> registrationBean = new FilterRegistrationBean<>(); registrationBean.setFilter(new CustomFilter2()); // 另一个自定义过滤器 registrationBean.addUrlPatterns("/*"); registrationBean.setOrder(2); // 顺序值大于第一个 return registrationBean; } } ``` - 优点:顺序完全可控,适合复杂场景[^2]。 2. **使用 @Order 注解配合注解方式** - 当使用注解(如`@Component`或`@WebFilter`)注册过滤器时,可以通过`@Order`注解指定顺序值。 - 步骤: - 定义过滤器类,添加`@Component`或`@WebFilter`注解。 - 同时添加`@Order(int value)`注解设置顺序值。 - 注意:Spring Boot启动类需添加`@ServletComponentScan`以扫描`@WebFilter`(如果使用该注解)[^1]。 - **示例代码**: ```java import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; import javax.servlet.*; import java.io.IOException; @Component @Order(1) // 设置顺序值:越小越优先 public class CustomFilter1 implements Filter { @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { // 过滤器逻辑 chain.doFilter(request, response); // 调用下一个过滤器 } } @Component @Order(2) // 顺序值大于第一个 public class CustomFilter2 implements Filter { @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { // 过滤器逻辑 chain.doFilter(request, response); } } ``` - 优点:简洁,适合简单应用。 - 缺点:顺序可能受Spring Bean加载顺序影响(例如,依赖注入顺序),导致不完全可靠[^2]。 #### 默认顺序和注意事项 - **默认顺序**:如果不设置顺序,Spring Boot内部依赖于注册顺序(如Bean初始化顺序),但此行为不确定,可能导致过滤器执行乱序[^2]。 - **FilterChain 的作用**:在`doFilter`方法中调用`chain.doFilter()`会将控制权传递给下一个过滤器顺序值直接影响此链的调用顺序[^1]。 - **最佳实践**:推荐优先使用`FilterRegistrationBean`,因为它提供更细粒度的控制(例如,添加URL模式),避免注解方式的潜在问题[^2]。 - **调试技巧**:在开发过程中,可以添加日志输出过滤器顺序值,以验证执行顺序是否符合预期[^3]。 #### 总结 在Spring Boot中,确定过滤器执行顺序的关键是显式设置顺序值,推荐使用`FilterRegistrationBean`的`setOrder`方法或结合`@Order`注解。这确保了过滤器的可预测性和可维护性,尤其在多过滤器场景下[^1][^2]。如果您有具体代码场景,可以提供更多细节以进一步分析。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值