前言

要聊 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"); // 排除特定路径
    }
}

几个关键点:

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

4. 多拦截器链式调用

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

执行顺序:

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

特殊情况说明:

示例代码(简化):

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. 作用层级不同

2. 生命周期和调用时机

3. 功能侧重点

4. 配置方式

5. 是否支持异步处理

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

6. 总结

本文转载于:https://www.jb51.net/program/368524y26.htm 如有侵犯,请联系zhengruancom@outlook.com删除。
免责声明:正软商城发布此文仅为传递信息,不代表正软商城认同其观点或证实其描述。