Spring Boot拦截器Interceptor与过滤器Filter详细教程(示例详解)

本文主要是介绍Spring Boot拦截器Interceptor与过滤器Filter详细教程(示例详解),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《SpringBoot拦截器Interceptor与过滤器Filter详细教程(示例详解)》本文详细介绍了SpringBoot中的拦截器(Interceptor)和过滤器(Filter),包括它们的...

Spring Boot拦截器(Interceptor)与过滤器(Filter)详细教程

1. 概述

1.1 什么是拦截器(Interceptor)?

拦截器是 Spring MVC 框架的组件,基于 AOP(面向切面编程 实现。它允许在请求处理的不同阶段(如Controller方法执行前后)插入自定义逻辑。

1.2 什么是过滤器(Filter)?

过滤器是 Java Servlet规范 定义的组件,作用于所有进入容器的请求(如Tomcat)。它可以在请求到达Servlet前或响应返回客户端前进行预处理和后处理。

1.3 核心区别

特性拦截器(Interceptor)过滤器(Filter)
所属框架Spring MVCServlet API
作用范围仅Spring MVC管理的请求所有请求(包括静态资源)
依赖依赖Spring容器依赖Servlet容器(如Tomcat)
执行时机Controller方法前后Servlet处理前后
获取Bean支持(通过Spring上下文)不支持(需通过其他方式注入)

2. 使用场景

2.1 拦http://www.chinasem.cn截器的典型应用

  • 日志记录:记录请求参数、响应时间。
  • 权限验证:检查用户是否登录或拥有权限。
  • 事务管理:在Controller方法前后开启/提交事务。
  • 性能监控:统计接口耗时。

2.2 过滤器的典型应用

  • 全局字符编码:统一设置请求/响应的编码(如UTF-8)。
  • 跨域处理:添加CORS响应头。
  • XSS防御:过滤请求参数中的恶意脚本
  • 请求压缩:对响应内容进行GZIP压缩。

3. 实现步骤

3.1 创建拦截器

步骤:

实现 HandlerInterceptor 接口,重写以下方法:

  • preHandle():在Controller方法执行前调用。
  • postHandle():在Controller方法执行后、视图渲染前调用。
  • afterCompletion():在请求完成后调用(视图渲染后)。

注册拦截器到Spring MVC配置。

代码示例:

public class AuthInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        // 检查用户是否登录
        if (request.getSession().getAttribute("user") == null) {
            response.sendRedirect("/login");
            return false; // 中断请求
        }
        return true;
    }
}

注册拦截器:

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AuthInterceptor())
                .addPathPatterns("/**")
                .excludePathPatterns("/login", "/static/**");
    }
}

注册多个拦截器:

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 第一个拦截器:日志(优先级高)
        registry.addInterceptor(new LogInterceptor())
                .addPathPatterns("/**")       // 拦截所有路径
                .excludePathPatterns("/static/**"); // 排除静态资源
        // 第二个拦截器:权限(优先级低)
        registry.addInterceptor(new AuthInterceptor())
                .addPathPatterns("/api/**");  // 仅拦截/api路径
    }
}

关键配置选项

配置方法说明
addPathPatterns("/api")指定拦截的路径(支持Ant风格)
excludePathPatterns("/login")排除特定路径
order(1)显式设置顺序(默认按注册顺序)

若要手动指定顺序,可添加:

registry.addInterceptor(new LogInterceptor()).order(1);
registry.addInterceptor(new AuthInterceptor()).order(2);

3.2 创建过滤器

步骤:

  • 实现 javax.servlet.Filter 接口,重写 doFilter 方法。
  • 注册过滤器到Servlet容器(通过注解或配置类)。

代码示例:

@WebFilter(urlPatterns = "/*")
public class LoggingFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
            throws IOException, ServletException {
        System.out.println("请求开始: " + ((HttpServletRequest) request).getRequestURI());
        chain.doFilter(request, response); // 继续执行后续过滤器或Servlet
        System.out.println("请求结束");
    }
}

注册过滤器(若未使用@WebFilter):

@ConfChina编程iguration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean<LoggingFilter> loggingFilter() {
        FilterRegistrationBean<LoggingFilter> bean = new FilterRegistrationBean<>();
        bean.setFilter(new LoggingFilter());
        bean.addUrlPatterns("/*");
        bean.setOrder(1); // 设置执行顺序
        return bean;
    }
}

注意: 确保主类添加 @ServletComponentScan 以启用 @WebFilter 注解。

4KwTWHYqR. 执行顺序与流程

4.1 执行顺序

  • 过滤器(FilterChain) → 2. 拦截器(preHandle) → 3. Controller方法 → 4. 拦截器(postHandle) → 5. 视图渲染 → 6. 拦截器(afterCompletion) → 7. 过滤器后续处理

4.2 流程图

客户端 → Filter.doFilter() → Interceptor.preHandle()
       → Controller → Interjsceptor.postHandle()
       → 视图渲染 → Interceptor.afterCompletion()
       → Filter.doFilter()后续处理 → 客户端

5. 常见问题与解决方案

Q1:如何控制多个拦截器/过滤器的执行顺序?

  • 拦截器:通过 registry.addInterceptor() 的顺序决定。
  • 过滤器:通过 FilterRegistrationBean.setOrder() 设置优先级(值越小越先执行)。

Q2:拦截器中如何获取Spring管理的Bean?

直接从Spring容器注入:

public class AuthInterceptor implements HandlerInterceptor {
    @Autowired
    private UserService userService; // 直接注入
}

Q3:过滤器中如何修改请求参数?

通过自定义 HttpServletRequestWrapper

public class ModifyRequestWrapper extends HttpServletRequestWrapper {
    // 重写getParameter等方法以修改参数
}
// 在Filter中替换Request对象
chain.doFilter(new ModifyRequestWrapper(request), response);

Q4:拦截器和过滤器执行时出现异常如何处理?

  • 拦截器:在 afterCompletion 中处理异常。
  • 过滤器:使用 try-catch 包裹 chain.doFilter()

Q5:如何让某个拦截器全局生效?

使用 addPathPatterns("/**")

registry.addInterceptor(new LogInterceptor())
        .addPathPatterns("/**");

Q6:如何跳过特定拦截器的执行?

preHandle 中返回 false

@Override
public boolean preHandle(...) {
    if (跳过条件) {
        return false; // 后续拦截器和Controller不会执行
    }
    return true;
}

Q7:拦截器之间如何共享数据?

通过 request.setAttribute 传递:

// 在第一个拦截器中存储数据
request.setAttribute("key", "value");
// 在后续拦截器中获取
String value = (String) request.getAttribute("key");

6. 总结

选择拦截器还是过滤器?

  • 需要访China编程问Spring上下文或Controller信息 → 拦截器。
  • 需处理所有请求(包括静态资源) → 过滤器。

最佳实践

  • 优先使用拦截器处理业务相关逻辑。
  • 使用过滤器处理底层Servlet容器的任务(如编码、压缩)。

到此这篇关于Spring Boot拦截器(Interceptor)与过滤器(Filter)详细教程的文章就介绍到这了,更多相关Spring Boot拦截器与过滤器内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于Spring Boot拦截器Interceptor与过滤器Filter详细教程(示例详解)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1153798

相关文章

MySQL 中的 JSON 查询案例详解

《MySQL中的JSON查询案例详解》:本文主要介绍MySQL的JSON查询的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录mysql 的 jsON 路径格式基本结构路径组件详解特殊语法元素实际示例简单路径复杂路径简写操作符注意MySQL 的 J

pandas中位数填充空值的实现示例

《pandas中位数填充空值的实现示例》中位数填充是一种简单而有效的方法,用于填充数据集中缺失的值,本文就来介绍一下pandas中位数填充空值的实现,具有一定的参考价值,感兴趣的可以了解一下... 目录什么是中位数填充?为什么选择中位数填充?示例数据结果分析完整代码总结在数据分析和机器学习过程中,处理缺失数

Java学习手册之Filter和Listener使用方法

《Java学习手册之Filter和Listener使用方法》:本文主要介绍Java学习手册之Filter和Listener使用方法的相关资料,Filter是一种拦截器,可以在请求到达Servl... 目录一、Filter(过滤器)1. Filter 的工作原理2. Filter 的配置与使用二、Listen

Pandas统计每行数据中的空值的方法示例

《Pandas统计每行数据中的空值的方法示例》处理缺失数据(NaN值)是一个非常常见的问题,本文主要介绍了Pandas统计每行数据中的空值的方法示例,具有一定的参考价值,感兴趣的可以了解一下... 目录什么是空值?为什么要统计空值?准备工作创建示例数据统计每行空值数量进一步分析www.chinasem.cn处

Spring Boot中JSON数值溢出问题从报错到优雅解决办法

《SpringBoot中JSON数值溢出问题从报错到优雅解决办法》:本文主要介绍SpringBoot中JSON数值溢出问题从报错到优雅的解决办法,通过修改字段类型为Long、添加全局异常处理和... 目录一、问题背景:为什么我的接口突然报错了?二、为什么会发生这个错误?1. Java 数据类型的“容量”限制

Java对象转换的实现方式汇总

《Java对象转换的实现方式汇总》:本文主要介绍Java对象转换的多种实现方式,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录Java对象转换的多种实现方式1. 手动映射(Manual Mapping)2. Builder模式3. 工具类辅助映

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》:本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置

利用Python调试串口的示例代码

《利用Python调试串口的示例代码》在嵌入式开发、物联网设备调试过程中,串口通信是最基础的调试手段本文将带你用Python+ttkbootstrap打造一款高颜值、多功能的串口调试助手,需要的可以了... 目录概述:为什么需要专业的串口调试工具项目架构设计1.1 技术栈选型1.2 关键类说明1.3 线程模

SpringBoot基于配置实现短信服务策略的动态切换

《SpringBoot基于配置实现短信服务策略的动态切换》这篇文章主要为大家详细介绍了SpringBoot在接入多个短信服务商(如阿里云、腾讯云、华为云)后,如何根据配置或环境切换使用不同的服务商,需... 目录目标功能示例配置(application.yml)配置类绑定短信发送策略接口示例:阿里云 & 腾

Python ZIP文件操作技巧详解

《PythonZIP文件操作技巧详解》在数据处理和系统开发中,ZIP文件操作是开发者必须掌握的核心技能,Python标准库提供的zipfile模块以简洁的API和跨平台特性,成为处理ZIP文件的首选... 目录一、ZIP文件操作基础三板斧1.1 创建压缩包1.2 解压操作1.3 文件遍历与信息获取二、进阶技