java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > SpringBoot拦截器

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

作者：碎碎念...

还在为SpringBoot拦截器的使用发愁？本文带你从零掌握拦截器的核心接口、注册配置和多拦截器链式调用,并清晰对比拦截器与过滤器的区别,助你轻松实现登录验证、日志记录等全局处理逻辑,提升开发效率

前言

在现代的 Spring Boot 应用开发中，拦截器（Interceptor）是一个非常重要的机制。

它位于客户端请求到达 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 可用于设置响应内容（如状态码、响应头、输出数据等）。

注意：preHandle、postHandle、afterCompletion 都由 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 方法完成注册和配置。

创建一个配置类，实现 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. 多拦截器链式调用

在实际项目中，通常会注册多个拦截器组成一个“拦截器链”，请求会依次经过每个拦截器的 preHandle、postHandle 和 afterCompletion 方法。理解多拦截器的执行顺序，有助于合理设计拦截器的职责和调用时机。

执行顺序：

假设按顺序注册了拦截器 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. 总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:
阅读全文