当前位置:

首页 > 编程开发 > SpringBoot拦截器怎么用?从入门到多拦截器链式调用详解

SpringBoot拦截器怎么用?从入门到多拦截器链式调用详解

本文目录

    SpringBoot拦截器通过实现HandlerInterceptor接口,在请求前后执行预处理和后处理,实现权限校验、日志记录等功能。多拦截器按注册顺序执行preHandle,反向执行postHandle与afterCompletion。过滤器基于Servlet容器,范围更广;拦截器聚焦SpringMVC业务处理,两者常配合使用。

    前言

    要聊 Spring Boot 里的拦截器,这玩意儿确实是个好东西。它在现代的应用开发中,几乎成了标配机制。

    SpringBoot拦截器怎么用?从入门到多拦截器链式调用详解

    简单来说,它横在客户端请求到达 Controller 之前,也守在响应返回之后。在这个中间环节,开发者可以插入自定义逻辑,实现对请求的预处理和后处理。业务代码不用动,但全局统一的处理逻辑却安排得明明白白。

    拦截器具体能干些什么?总结下来,核心能力集中在三个方向:

    • 请求预处理:身份认证、权限校验、日志记录、请求参数统一处理,这些活儿都能干。

    • 响应后处理:对返回结果进行统一包装,或者清理一些临时资源。

    • 异常处理和性能监控:统计接口调用耗时,捕获并处理异常信息,这些都不在话下。

    实际项目中,它的应用场景非常广泛。比如:用户登录状态验证,拦截未登录用户访问受限接口;接口访问日志记录,方便审计和问题排查;请求参数校验和统一格式化;还有跨域请求处理和安全防护,以及性能监控和统计接口响应时间。本质上,就是在请求进入 Controller 前后,把那些通用的、必要的逻辑统一起来,让代码维护变得更清爽。

    1. 拦截器的核心接口与原理

    在 Spring Boot 里,拦截器本质上是通过实现 Spring MVC 提供的 HandlerInterceptor 接口来完成的。它允许我们在请求进入 Controller 前、请求处理后、以及请求完成后分别插入自定义逻辑,适用于权限校验、日志记录、性能监控等场景。

    拦截器的执行流程

     Client Request
           ↓
       preHandle()
           ↓        (如果返回 true)
       Controller   (调用 Service 层处理业务)
           ↓
      postHandle()
           ↓
        视图渲染
           ↓
    afterCompletion()
           ↓
     Client Response
    

    以上流程是个简化示意,方便理解拦截器的执行顺序。实际底层还涉及 Servlet 容器对请求和响应的处理,以及 Spring MVC 内部的多层调用,不过核心脉络就是如此。

    HandlerInterceptor接口的三个核心方法

    /**
     * 在控制器方法执行前调用。
     * 可用于权限认证、参数校验、日志记录等。
     * 返回 false 会终止请求流程,后续的拦截器和 Controller 都不会被执行。
     */
    boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler);
    
    /**
     * 控制器方法执行后、视图渲染之前调用。
     * 可用于修改 ModelAndView,实现页面统一封装等功能。
     */
    void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView);
    
    /**
     * 请求处理完成后(视图渲染之后)调用。
     * 可用于资源清理、异常处理、日志收集等。
     */ 
    void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);
    

    HttpServletRequest 可以获取请求相关信息,比如请求路径、参数、Header 等;而 HttpServletResponse 则用于设置响应内容,比如状态码、响应头、输出数据等。这三个方法都是由 Spring 框架自动在请求生命周期中调用的,对业务代码来说是不可见的中间处理逻辑。

    2. 示例:创建一个简单的拦截器

    理论说完了,上手实操一下。创建一个类实现 HandlerInterceptor,并重写所需的方法,比如 preHandle,用于在请求到达 Controller 前打印日志:

    import jakarta.servlet.http.HttpServletRequest;
    import jakarta.servlet.http.HttpServletResponse;
    import org.springframework.web.servlet.HandlerInterceptor;
    
    public class LoggingInterceptor implements HandlerInterceptor {
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            System.out.println("请求URL:" + request.getRequestURI() + " | 方法:" + request.getMethod());
            // 返回 true 表示继续流程(放行),返回 false 则中断请求
            return true;
        }
    
        // 可根据需要重写 postHandle 和 afterCompletion 方法
    }
    

    通常登录拦截器会从请求头中获取 token,解析后将用户信息存入 ThreadLocal,实现用户登录状态的维护与传递。

    3. 示例:拦截器的注册与配置

    拦截器类创建好了,要让它生效,还得注册到 Spring MVC 的拦截器链中。实现方式是通过实现 WebMvcConfigurer 接口的 addInterceptors 方法来完成注册和配置。

    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 WebConfig implements WebMvcConfigurer {
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(new LoggingInterceptor())
                    .addPathPatterns("/**")      // 拦截所有请求
                    .excludePathPatterns("/login", "/register"); // 排除特定路径
        }
    }
    

    几个关键点:

    • addPathPatterns 指定拦截的 URL 路径模式,支持通配符。
    • excludePathPatterns 用来排除某些路径,比如登录页、静态资源等。
    • 可以注册多个拦截器,按照添加顺序依次执行。

    别忘了给 WebConfig 类加上 @Configuration 注解,Spring 框架才会识别并加载这个配置。

    4. 多拦截器链式调用

    真实项目中,往往不止一个拦截器。多个拦截器会组成一个“拦截器链”,请求依次经过每个拦截器的 preHandle、postHandle 和 afterCompletion 方法。理解这个执行顺序,对合理设计拦截器的职责和调用时机很有帮助。

    执行顺序:

    假设咱按顺序注册了拦截器 A、B、C,执行顺序是这样的:

    • 请求进入,先按注册顺序依次调用各拦截器的 preHandle 方法:A → B → C
    • 业务处理(Controller)执行
    • 响应返回,按注册顺序反向调用各拦截器的 postHandle 方法:C → B → A
    • 请求完成后,按注册顺序反向调用各拦截器的 afterCompletion 方法:C → B → A

    特殊情况说明:

    • 任何一个拦截器的 preHandle 返回 false,后续的拦截器和 Controller 都不会执行,请求直接中断。
    • afterCompletion 方法无论请求是否正常完成都会被调用,适合做资源清理。

    示例代码(简化):

    public class InterceptorA implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
            System.out.println("A preHandle");
            return true;
        }
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
            System.out.println("A postHandle");
        }
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
            System.out.println("A afterCompletion");
        }
    }
    // InterceptorB 和 InterceptorC 类似
    

    5. 拦截器与过滤器的区别

    1. 作用层级不同

    • 过滤器(Filter) 基于 Servlet 规范,属于 Servlet 容器层面的组件,能拦截所有到达应用的请求,包括静态资源和动态请求。
    • 拦截器(Interceptor) 是 Spring MVC 的一部分,作用于 Spring 的 DispatcherServlet 之后,主要拦截控制器(Controller)的方法调用,只针对处理器映射的请求起作用。

    2. 生命周期和调用时机

    • 过滤器在请求进入应用时最早执行,可以在 Servlet 容器层对请求进行修改或阻断。
    • 拦截器是在 Handler 执行之前和之后执行,能够访问 Handler 的具体信息,适合做业务相关的处理。

    3. 功能侧重点

    • 过滤器更适合做通用的请求过滤、编码设置、压缩、日志记录、安全检查等与底层协议相关的处理。
    • 拦截器适合做业务层面的权限控制、日志记录、性能监控、参数绑定预处理等。

    4. 配置方式

    • 过滤器需要在 web.xml 中配置,或者通过代码注册(FilterRegistrationBean),相对底层。
    • 拦截器通过实现 HandlerInterceptor 并注册到 Spring MVC 配置中,配置更简洁且与 Spring 框架集成紧密。

    5. 是否支持异步处理

    • 过滤器对异步请求的支持有限。
    • 拦截器在 Spring MVC 中对异步请求支持更好,能够处理异步请求的生命周期。

    简单总结:过滤器更偏底层、范围更广;拦截器偏 Spring MVC 层面,更加聚焦于业务处理。两者常结合使用,互为补充。

    6. 总结

    • 实现拦截器只需定义一个类实现 HandlerInterceptor 接口,并重写其中的方法,然后通过实现 WebMvcConfigurer 接口在 addInterceptors 方法中注册拦截器。

    • 多个拦截器的调用顺序为:preHandle 方法按注册顺序执行,postHandle 和 afterCompletion 方法按注册顺序的反向执行。

    • 过滤器是 Servlet 规范的一部分,运行于底层 Servlet 容器,作用范围更广;拦截器是 Spring MVC 特有,专注于处理请求和响应,能访问 Handler。

    • 过滤器适合做通用功能(如日志、编码、安全等),拦截器适合做权限校验、请求处理和视图渲染前后操作,两者在实际项目中常常配合使用。

    本文内容来源于网友投稿,如有侵权请联系删除。
    作者最新文章
    编程开发
    相关文章 更多
    链表删除节点的时间复杂度是多少及其详细分析
    链表删除节点的时间复杂度是多少及其详细分析

    详细分析链表删除节点的时间复杂度,深入探讨单链表与双向链表在不同已知前提下的查找与删除开销,并结合完整代码与清晰图解进行对比总结。

    codex如何配置模型参数及文件设置教程
    codex如何配置模型参数及文件设置教程

    想知道如何让AI写出的代码更贴合你的习惯?本文手把手教你在VS Code中调整Codex相关模型参数,通过修改配置文件优化温度值和令牌限制,解决代码建议不准确或响应慢的问题。

    Claude Code AI编程工具实力揭秘与编程助手实测
    Claude Code AI编程工具实力揭秘与编程助手实测

    通过实测展示Claude Code在终端中如何理解自然语言指令、自动修改代码文件并处理复杂编程任务,帮助开发者评估其实际辅助能力。

    winforms教程自学入门与基础开发步骤详解
    winforms教程自学入门与基础开发步骤详解

    本教程详细讲解如何使用Visual Studio创建WinForms项目,通过添加按钮和标签控件并编写点击事件代码,实现一个基础的计数器功能,适合C#初学者快速上手Windows窗体应用开发。

    Cursor自动补全设置教程教你快速开启代码补全功能
    Cursor自动补全设置教程教你快速开启代码补全功能

    详解Cursor编辑器中自动补全功能的开启与优化设置,涵盖Tab触发机制、上下文窗口调整及模型切换,帮助开发者解决补全延迟、干扰大等问题,提升编码流畅度。

    pandas的数据格式怎么转换和设置方法教程
    pandas的数据格式怎么转换和设置方法教程

    详解Pandas中数据格式转换的核心方法,包括astype强制转换、to_numeric容错处理及日期解析技巧,解决常见类型错误并提升数据处理效率。

    VS Code中文设置方法 简体语言包安装与切换教程
    VS Code中文设置方法 简体语言包安装与切换教程

    详细介绍在Visual Studio Code中安装Chinese (Simplified)语言包的方法,包括通过扩展市场搜索、安装及自动重启切换至简体中文界面的完整步骤,帮助开发者快速将编辑器本地化。

    cursor安装过程无法更改安装位置的解决方法
    cursor安装过程无法更改安装位置的解决方法

    针对Cursor安装包默认锁定C盘且无路径选择界面的问题,提供通过手动移动文件并创建目录联结(Symbolic Link)的解决方案,实现将软件安装在其他磁盘分区。

    rust下载安装教程详解及Windows环境配置方法
    rust下载安装教程详解及Windows环境配置方法

    详解Windows系统下Rust语言的安装步骤,重点解析rustup工具链管理机制,解决环境变量配置错误及MSVC链接器缺失问题,提供可复制的命令验证方法与常见报错的因果排查思路。

    vs code怎么配置 chat实用设置教程步骤
    vs code怎么配置 chat实用设置教程步骤

    详解VS Code中Chat插件的安装与核心配置步骤,重点解决API连接失败、响应慢等常见问题,通过优化上下文设置提升代码生成质量,适合希望集成AI辅助工具的开发者阅读。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    macOS软件
    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    Mac软件 更多
    photoshop
    photoshop
    Windows、macOS 、 iPad

    Photoshop 2026 是 Adobe 推出的专业图像处理与视觉设计软件,支持 Windows、macOS 和 iPad 等平台,广泛应用于摄影修图、电商设计、平面海报、数字绘画及视觉合成等创作场景。

    Blender
    Blender
    Windows、macOS 和 Linux

    Blender 是一款免费开源、跨平台的专业 3D 创作软件,集建模、动画、渲染、视频编辑与视觉合成等功能于一体,广泛应用于影视动画、游戏设计和建筑可视化等领域。软件支持 Cycles 物理渲染器与 Eevee 实时渲染引擎,并提供多边形建模、骨骼绑定、物理模拟等专业工具。Blender 兼容 Windows、macOS 和 Linux 系统,安装包轻巧、运行流畅,依托活跃的全球开发者社区持续更新,是从初学者到专业创作者都值得选择的正版 3D 创作工具。

    灵活计算器
    灵活计算器
    macOS/iOS/Android

    灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

    WINDOWS 更多
    3dmax(3ds max)
    3dmax(3ds max)
    Windows

    Autodesk 3ds Max 是一款专业的三维建模、动画与渲染软件,广泛应用于建筑可视化、游戏开发、影视动画、广告设计和产品展示等领域。

    photoshop
    photoshop
    Windows、macOS 、 iPad

    Photoshop 2026 是 Adobe 推出的专业图像处理与视觉设计软件,支持 Windows、macOS 和 iPad 等平台,广泛应用于摄影修图、电商设计、平面海报、数字绘画及视觉合成等创作场景。

    Blender
    Blender
    Windows、macOS 和 Linux

    Blender 是一款免费开源、跨平台的专业 3D 创作软件,集建模、动画、渲染、视频编辑与视觉合成等功能于一体,广泛应用于影视动画、游戏设计和建筑可视化等领域。软件支持 Cycles 物理渲染器与 Eevee 实时渲染引擎,并提供多边形建模、骨骼绑定、物理模拟等专业工具。Blender 兼容 Windows、macOS 和 Linux 系统,安装包轻巧、运行流畅,依托活跃的全球开发者社区持续更新,是从初学者到专业创作者都值得选择的正版 3D 创作工具。