展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > 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。

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

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

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

    Windows

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

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

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

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。

    Cubase Windows版
    Cubase Windows版

    Cubase 是 Steinberg 推出的数字音频工作站,提供 MIDI 编曲、多轨录音、音频编辑、虚拟乐器、效果处理、自动化、混音和母带输出工具。其 Pro、Artist 与 Elements 版本面向不同预算和制作规模,