当前位置:

首页 > 编程开发 > 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
    作者最新文章
    编程开发
    相关文章 更多
    SpringBoot拦截器怎么配置?手把手教你实现自定义拦截器
    SpringBoot拦截器怎么配置?手把手教你实现自定义拦截器

    SpringBoot添加拦截器 在Web开发中,拦截器几乎是绕不开的组件。但在SpringBoot项目里,该怎么配置才能让它生效?这篇文章就来拆解一下。 和普通属性不同,拦截器本身是一个类,所以不能直接在application.properties里配置,得用Ja va Config的方式搞定。Sp

    SpringBoot中的拦截器使用详解
    SpringBoot中的拦截器使用详解

    拦截器 还记得我们之前的图书管理系统吗?当时我们实现了强制登录的功能。原理其实很直观:用户登录成功后,后端就把用户信息存到 Session 里,然后程序根据 Session 来判断用户是否登录。听起来挺简单的,对吧?但实际操作起来,你可能会觉得有点麻烦: • 每个接口的处理逻辑都得改一遍 • 每个接

    n8n 2.47.6、2.47.7、2.48.3 Beta、2.48.4 Beta、3.2.2预发布与1.123.96适用哪些安全修复?
    n8n 2.47.6、2.47.7、2.48.3 Beta、2.48.4 Beta、3.2.2预发布与1.123.96适用哪些安全修复?

    按维护分支、利用权限与节点类型对应四项修复,区分正式补丁、Beta和临时缓解的适用边界。

    GitHub合并故障的已缓解、监控与已解决有什么不同
    GitHub合并故障的已缓解、监控与已解决有什么不同

    GitHub合并故障中的“已缓解并监控”和“已解决”不能互换。前者表示影响已经采取措施缓解,仍在观察稳定性;后者是供应商正式结束这场事故的状态。11月13日的Pull Requests合并超时事件先进入监控,随后于北京时间11月14日02:29标记为已解决。

    llama.cpp v1.0.0的网页聊天分组与Markdown编辑适合哪些场景
    llama.cpp v1.0.0的网页聊天分组与Markdown编辑适合哪些场景

    llama.cpp v1.0.0改善聊天组织、长消息编辑和附件预览;界面变化与底层API迁移、缓存及访问边界需要分别理解。

    Postman 12.36.4 更新后仍报错,怎么判断是哪一层的问题
    Postman 12.36.4 更新后仍报错,怎么判断是哪一层的问题

    Postman 12.36.4 更新后仍有异常时,可按应用、API请求和平台服务区分问题范围,避免把补丁版本当作故障原因。

    n8n 2.47.6、2.48.3 Beta与1.123.96适合哪些部署环境?
    n8n 2.47.6、2.48.3 Beta与1.123.96适合哪些部署环境?

    按正式、预发布和1.x维护渠道对应补丁,再结合Redis、Agent端点和Pinecone索引判断适用范围。

    Codex CLI 0.169.0与0.171.0-alpha.2怎样选择,终端工作区适合哪些任务
    Codex CLI 0.169.0与0.171.0-alpha.2怎样选择,终端工作区适合哪些任务

    Codex CLI 0.169.0提供有明确说明的终端工作区能力;0.171.0-alpha.2为预发布,当前没有功能清单,选用时应分开评估。

    llama.cpp b12345的Hexagon后端支持哪些Q5量化格式?
    llama.cpp b12345的Hexagon后端支持哪些Q5量化格式?

    llama.cpp b12345的预发布构建为Hexagon HTP后端增加Q5_0和Q5_1支持。选择模型时需要核对完整量化名称及实际运行后端,不能只看到“Q5”就视为同一种格式。

    llama.cpp b12344的MCP工具调用在断连或超时后会怎样处理?
    llama.cpp b12344的MCP工具调用在断连或超时后会怎样处理?

    llama.cpp b12344的预发布构建调整了MCP工具调用的取消行为:客户端断连或调用超时时,服务器会向MCP服务发送带请求ID的取消通知。使用服务端工具的Web界面也属于这项变更范围。

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

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

    Windows
    Windows

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

    PDF教程
    PDF教程

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

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。