【过滤器 vs 拦截器】SpringBoot中过滤器与拦截器：明智选择的艺术（如何在项目中做出明智选择）

无理 Java2024-07-31 16:35

文章目录

SpringBoot 过滤器 vs 拦截器

在构建Spring Boot应用程序时，开发者经常需要在过滤器（Filters）与拦截器（Interceptors）之间做出选择，尽管两者都能在请求-响应周期中发挥作用，但它们各自有着特定的设计目的和应用场景。下面我们将探讨过滤器与拦截器之间的主要区别，并给出在不同情况下如何合理选用的指导原则。

过滤器 (Filter)

定义

过滤器是Java Servlet API的一部分，用于在请求达到目标资源（如Servlet或JSP页面）之前或在响应从目标资源返回到客户端之后进行预处理或后处理。它们可以被看作是请求和响应的"管道"，允许开发人员执行一些跨切割关注点的操作，如编码转换、添加响应头、身份验证、日志记录等。

特点

  • 生命周期管理：过滤器具有初始化（init），过滤（doFilter）和销毁（destroy）的方法，这些方法分别在过滤器创建、每次请求和服务器关闭时调用。
  • 执行顺序：过滤器的执行顺序是由部署描述符（web.xml）或等效的Java配置类中定义的过滤器映射所决定的。
  • 跨容器：过滤器可以在任何实现了Servlet规范的容器中工作，这意味着它们可以用于任何基于Servlet的Web应用程序，而不仅仅是Spring Boot应用。
  • 请求/响应处理：过滤器可以在请求到达目标资源前和响应离开容器后执行操作，这使得它们非常适合处理一些需要在所有请求中都生效的任务。

使用场景

  • 安全性：实现身份验证和授权逻辑，确保只有经过验证的用户才能访问某些资源。
  • 编码转换：在请求和响应中进行字符集转换，以支持国际化。
  • 日志记录：记录每个请求的信息，用于调试和监控应用程序行为。
  • 性能监控：测量请求处理时间，以便进行性能分析和优化。
  • 资源限制：限制请求频率，防止资源滥用，例如通过实现速率限制功能。
  • 响应头添加：自动添加HTTP响应头，如CORS支持或安全相关的头部信息。

实现步骤

在Spring Boot项目中，过滤器可以通过实现javax.servlet.Filter接口或使用Spring的org.springframework.web.filter.OncePerRequestFilter来创建，然后在WebSecurityConfigurerAdapter中配置，或者直接在SpringBootServletInitializer中注册，以确保它们在应用程序启动时正确加载和初始化。

创建过滤器类

实现 javax.servlet.Filter 接口。

java 复制代码 
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

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

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化代码，可选实现
        System.out.println("Filter initialized");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 过滤器逻辑在请求处理前执行
        System.out.println("Request received at filter");

        // 继续调用过滤器链，传递请求和响应
        chain.doFilter(request, response);

        // 过滤器逻辑在响应处理后执行
        System.out.println("Response leaving filter");
    }

    @Override
    public void destroy() {
        // 销毁代码，可选实现
        System.out.println("Filter destroyed");
    }
}
注册过滤器（可选，如果不使用 @WebFilter 注解）
java 复制代码 
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<MyFilter> loggingFilter(){
        FilterRegistrationBean<MyFilter> registrationBean = new FilterRegistrationBean<>();
        
        // 注册自定义过滤器实例
        registrationBean.setFilter(new MyFilter());
        
        // 指定过滤器应用的 URL 模式
        registrationBean.addUrlPatterns("/*");
        
        // 设置过滤器优先级，值越低优先级越高
        registrationBean.setOrder(1);
        
        return registrationBean;
    }
}

拦截器 (Interceptor)

定义

拦截器是AOP（面向切面编程）概念在Web开发中的具体应用，主要用于在不修改原始代码的情况下增强程序的功能。在Spring Boot框架中，拦截器被广泛应用于处理请求的特定阶段，如在请求到达控制器之前或之后执行某些操作。它提供了一种机制，可以在请求处理的不同阶段执行自定义的代码逻辑。

特点

  • 生命周期钩子 ：拦截器提供了多个钩子方法，如preHandle()、postHandle()和afterCompletion()，分别在请求处理的开始、结束和完成后调用。
  • 动态性：可以通过配置来决定哪些请求会被拦截器处理，而无需修改具体的控制器代码。
  • 非侵入性：拦截器的设计使得业务逻辑与横切关注点分离，使得代码更加模块化和可维护。
  • 可插拔性：可以根据需要轻松地添加、移除或更改拦截器，而不会影响到现有的业务逻辑。

使用场景

  • 权限认证与授权：在请求到达控制器之前检查用户的身份和权限，以确定是否允许访问相应的资源。
  • 日志记录：记录请求和响应的详细信息，有助于调试和性能分析。
  • 数据预处理：在请求数据到达控制器前进行预处理，如数据转换、校验等。
  • 响应修饰：在响应发送给客户端前，可以对响应体进行修改或补充，如添加额外的响应头。
  • 性能监控：测量控制器方法的执行时间，监控应用性能。
  • 事务管理：在业务逻辑方法执行前后进行事务管理，确保数据的一致性和安全性。

实现步骤

在Spring Boot中，拦截器的实现和注册相对简单。开发者可以创建一个实现了HandlerInterceptor接口的类，并在配置类中使用@Configuration和WebMvcConfigurer接口来注册拦截器。这样，拦截器就能按照定义的规则自动生效，无需手动在每个控制器上添加注解或配置。这种机制使得Spring Boot应用程序能够高效地处理各种请求，并能轻松地扩展其功能，而不会破坏原有的代码结构。

创建拦截器类

实现 HandlerInterceptor 接口。

java 复制代码 
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 请求处理前逻辑
        System.out.println("Request intercepted at preHandle");
        // 返回 true 继续请求，返回 false 中断请求
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
                           ModelAndView modelAndView) throws Exception {
        // 请求处理后逻辑
        System.out.println("Request intercepted at postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 请求处理完成后的逻辑
        System.out.println("Request intercepted at afterCompletion");
    }
}
注册拦截器
java 复制代码 
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册自定义拦截器实例，并指定拦截的路径模式
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**")
            .excludePathPatterns("/login", "/register"); // 可以排除某些路径不被拦截
    }
}

过滤器与拦截器的比较

特性 过滤器 (Filter) 拦截器 (Interceptor)
所属规范 Servlet 规范 Spring MVC 框架
作用范围 整个应用程序的所有请求 仅限于 Spring MVC 的控制器请求
修改请求响应 可以直接修改请求和响应 通常不直接修改请求和响应
配置方式 通过 @WebFilter 注解或 FilterRegistrationBean 通过实现 HandlerInterceptor 并注册
典型应用场景 认证、日志、压缩响应 日志、权限校验、视图处理

在实际项目中选择使用过滤器（Filter）还是拦截器（Interceptor），主要取决于你的具体需求和它们各自的特点。以下是一些指导原则，帮助你做出明智的选择：

实际项目中的选择

过滤器（Filter）

  • 何时使用

    • 当你需要在所有请求的入口处执行代码，而不论请求最终会到达哪个具体的Spring组件时。
    • 当你关注的是跨多个应用程序的通用功能，如安全性（如CSRF保护）、编码转换、性能监控、添加响应头等。
    • 当你想要在请求到达Spring MVC DispatcherServlet之前或在响应被发送给客户端之后执行代码。

  • 优势

    • 过滤器在Servlet容器级别运行，这意味着它们适用于所有基于Servlet的Web应用，而不局限于Spring MVC或Spring Boot。
    • 过滤器的执行顺序在web.xml或等效的Java配置中明确定义，这提供了清晰的控制流。

拦截器（Interceptor）

  • 何时使用

    • 当你需要在Spring MVC的请求处理链中添加逻辑，尤其是在请求到达控制器方法前后或在视图渲染前后。
    • 当你关心的是与Spring MVC紧密相关的功能，如用户认证、权限检查、日志记录、数据预处理等。
    • 当你需要访问Spring MVC的上下文，如模型数据、视图、控制器等。

  • 优势

    • 拦截器是Spring框架的一部分，可以充分利用Spring的特性，如依赖注入、事务管理等。
    • 拦截器的配置更加灵活，你可以选择只对特定的请求路径应用拦截器。

实际考虑因素

  • 性能影响：考虑过滤器和拦截器对系统性能的影响。通常，过滤器由于更早地介入请求流程，可能对性能有更大影响。
  • 代码耦合度：拦截器更倾向于业务逻辑的紧密集成，而过滤器则更偏向于独立于具体业务逻辑的跨切关注点。
  • 维护成本：评估长期维护成本，包括代码的可读性、可测试性和可扩展性。

结论

在SpringBoot应用中，过滤器和拦截器都扮演着重要角色，选择使用哪一种应基于项目需求和它们各自的特点进行权衡。如果需求指向处理所有请求的低层次功能，如编码转换或安全检查，过滤器可能是更优的选择；而如果功能更偏向于Spring MVC的高层次操作，如权限控制或数据预处理，拦截器则更为适合。在实际项目中，我们可能会发现同时利用过滤器和拦截器的情况，以便全面覆盖应用程序的不同方面。记住，没有一成不变的规则，最重要的是根据项目的具体需求和上下文来灵活决定使用哪种机制，以达到最佳的效果。

相关推荐
Wyang_XXX12 分钟前
CSS 选择器和优先级权重计算这么简单，你还没掌握？一篇文章让你轻松通关面试！（下）
面试
星河梦瑾14 分钟前
SpringBoot相关漏洞学习资料
java·经验分享·spring boot·安全
黄名富17 分钟前
Redis 附加功能（二）— 自动过期、流水线与事务及Lua脚本
java·数据库·redis·lua
love静思冥想19 分钟前
JMeter 使用详解
java·jmeter
言、雲22 分钟前
从tryLock()源码来出发，解析Redisson的重试机制和看门狗机制
java·开发语言·数据库
TT哇29 分钟前
【数据结构练习题】链表与LinkedList
java·数据结构·链表
Yvemil71 小时前
《开启微服务之旅：Spring Boot 从入门到实践》（三）
java
Anna。。1 小时前
Java入门2-idea 第五章：IO流（java.io包中）
java·开发语言·intellij-idea
计算机学长felix1 小时前
基于SpringBoot的“交流互动系统”的设计与实现（源码+数据库+文档+PPT)
spring boot·毕业设计
.生产的驴1 小时前
SpringBoot 对接第三方登录 手机号登录 手机号验证 微信小程序登录 结合Redis SaToken
java·spring boot·redis·后端·缓存·微信小程序·maven
热门推荐
01〔AI 绘画〕Stable Diffusion 之 解决绘制多人或面部很小的人物时面部崩坏问题 篇02YOLOv8训练好模型后，追加轮数继续训练、或者提前终止训练，缩减训练轮数03玄机平台应急响应—webshell查杀04机器人编程怎么入门？05HCIA-datacom数通题库和录播视频资料06Docker 夺命连环 15 问07SQL 主从数据库实时备份08校验 GPT-4 真实性的三个经典问题：快速区分 GPT-3.5 与 GPT-4，并提供免费测试网站09(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明10VSCode插件 —— Cody AI （免费AI助手！）