Spring Boot 拦截器实战:用 HandlerInterceptor 实现登录校验

spring boot3token拦截器链的设计与实现 本文介绍了spring boot后端服务开发中有关如何设计拦截器的思路,坚持看完相信对你有帮助。同时欢迎订阅springboot系列专栏,持续分享spring boot的使用经验。首先,需要定义第一个拦截器类,该拦截器类需要实现 Spring 框架提供的接口。该拦截器只做一件事就是刷新token。/***/@Slf4j@Component@Override// 1、从请求头中获取token// 2.解析token// 3.获取用户信息。 阅读详情

项目里有两个接口:一个查询当前账号资料,一个修改当前账号资料。它们的业务逻辑不同,但进入业务之前,都要解决同一个问题:这次请求是谁发起的?

如果两个 Controller 都自己取 token、校验 JWT、读取账号 ID,这段逻辑很快就会出现在更多接口里。我们可以把它放进 LoginInterceptor:登录校验通过后,Controller 直接使用当前账号信息。校验失败时,拦截器返回未登录响应,请求到这里结束。

本文以 Spring Boot 3、Spring MVC 和同步请求为例,沿用项目里的 JwtUtils、`AccountDTO`、`BizCodeEnum` 和 JsonData。

一、一个请求什么时候会经过拦截器?

假设前端要查询当前账号,发送了这样一个请求:

GET /api/account/me
token: <登录时拿到的 JWT>

Spring MVC 找到这个请求对应的 Controller 方法后,会先执行与路径匹配的拦截器。`HandlerInterceptor` 提供了三个回调,其中登录校验主要用到第一个和最后一个。Spring HandlerInterceptor 文档https://docs.spring.io/spring-framework/docs/6.2.x/javadoc-api/org/springframework/web/servlet/HandlerInterceptor.html

方法在本例中的执行时机适合做什么
preHandle()调用 Controller 之前校验 token,保存当前账号
postHandle()Controller 正常执行完成之后、视图渲染之前对有视图的请求补充模型数据
afterCompletion()当前同步请求处理结束时清理当前线程上的账号信息

preHandle() 的返回值决定请求能否继续。返回 true,Spring MVC 继续执行后续拦截器和 Controller。返回 false,处理链在这里停止,因此拦截器需要自己把错误响应写给客户端。

二、编写登录拦截器

下面的代码根据项目中的 LoginInterceptor 整理。保留了 token 请求头和原有的未登录响应,并做了三处调整:只通过请求头接收凭证、校验 accountId 的格式、将账号上下文封装为私有字段。

package net.Bdu.interceptor;

import io.jsonwebtoken.Claims;
import io.jsonwebtoken.JwtException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import net.Bdu.dto.AccountDTO;
import net.Bdu.enums.BizCodeEnum;
import net.Bdu.utils.CommonUtil;
import net.Bdu.utils.JsonData;
import net.Bdu.utils.JwtUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.cors.CorsUtils;
import org.springframework.web.servlet.HandlerInterceptor;

@Component
public class LoginInterceptor implements HandlerInterceptor {

    private static final ThreadLocal<AccountDTO> CURRENT_ACCOUNT =
            new ThreadLocal<>();

    public static AccountDTO currentAccount() {
        return CURRENT_ACCOUNT.get();
    }

    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response,
                             Object handler) throws Exception {

        if (CorsUtils.isPreFlightRequest(request)) {
            return true;
        }

        String token = request.getHeader("token");
        if (StringUtils.isBlank(token)) {
            return reject(response);
        }

        Claims claims;
        try {
            claims = JwtUtils.checkLoginJWT(token);
        } catch (JwtException | IllegalArgumentException ex) {
            return reject(response);
        }

        if (claims == null) {
            return reject(response);
        }

        Object rawId = claims.get("accountId");
        Object rawUsername = claims.get("username");
        if (rawId == null || !(rawUsername instanceof String username)
                || StringUtils.isBlank(username)) {
            return reject(response);
        }

        long accountId;
        try {
            accountId = Long.parseLong(rawId.toString());
        } catch (NumberFormatException ex) {
            return reject(response);
        }

        AccountDTO account = AccountDTO.builder()
                .id(accountId)
                .username(username)
                .build();

        CURRENT_ACCOUNT.set(account);
        return true;
    }

    private boolean reject(HttpServletResponse response) throws Exception {
        response.setStatus(HttpStatus.UNAUTHORIZED.value());
        CommonUtil.sendJsonMessage(
                response,
                JsonData.buildResult(BizCodeEnum.ACCOUNT_UNLOGIN)
        );
        return false;
    }

    @Override
    public void afterCompletion(HttpServletRequest request,
                                HttpServletResponse response,
                                Object handler,
                                Exception ex) {
        CURRENT_ACCOUNT.remove();
    }
}

原代码的 postHandle() 只调用了接口默认实现,因此这里直接省略。阅读这个拦截器时,可以关注三个具体问题。

第一个问题:从哪里取 token? 原代码先读请求头,取不到时再调用 request.getParameter("token")。如果调用方把 token 拼进 URL,它可能留在访问日志或浏览器历史中。示例统一从请求头读取。如果已有客户端依赖参数传递,需要同步调整调用方式。

第二个问题:什么时候可以相信 accountId? JwtUtils.checkLoginJWT(token) 是整个流程的前提。这个工具方法需要按项目约定验证签名、有效期等条件,再返回可信的 Claims。即使校验通过,也要检查项目需要的字段。原代码直接执行 accountIdObj.toString(),遇到缺少 accountId 的凭证会抛出空指针异常,客户端可能收到 500。这里把这种情况归入未登录响应。

第三个问题:为什么最后才调用 CURRENT_ACCOUNT.set()? 对当前拦截器而言,只有 preHandle() 成功返回 true 后,Spring MVC 才会调用它的 afterCompletion()。把 set() 放在所有失败分支之后,就能保证被拒绝的请求不会留下一个等不到清理的账号对象。Spring HandlerInterceptor 回调约定

三、注册拦截器,指定哪些接口需要登录

@Component 会让 Spring 创建 LoginInterceptor 实例。要让它参与 MVC 请求处理,还要通过 WebMvcConfigurer 注册,并指定生效范围。Spring MVC 拦截器配置

package net.Bdu.config;

import net.Bdu.interceptor.LoginInterceptor;
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 WebMvcConfig implements WebMvcConfigurer {

    private final LoginInterceptor loginInterceptor;

    public WebMvcConfig(LoginInterceptor loginInterceptor) {
        this.loginInterceptor = loginInterceptor;
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/api/account/**")
                .excludePathPatterns(
                        "/api/account/login",
                        "/api/account/register"
                );
    }
}

按这份配置,`/api/account/me` 需要登录,`/api/account/login` 和 /api/account/register 可以直接访问。路径要与项目真实的 Controller 映射一致。比如消息接口位于 /api/message/**,也需要登录,就要把这组路径加入 addPathPatterns()。

原代码对所有 OPTIONS 请求设置 204,随后返回 true。这里有个容易忽略的区别:设置响应状态不会结束处理链,返回 true 后请求仍会继续。 示例使用 CorsUtils.isPreFlightRequest() 识别浏览器的跨域预检,由项目的 CORS 配置处理允许的来源、方法和请求头。前端跨域发送自定义 token 请求头时,CORS 配置也要允许这个请求头。

四、在 Controller 中获取当前账号

完成注册后,查询当前账号的接口可以写得很短:

package net.Bdu.controller;

import net.Bdu.dto.AccountDTO;
import net.Bdu.interceptor.LoginInterceptor;
import net.Bdu.utils.JsonData;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/account")
public class AccountController {

    @GetMapping("/me")
    public JsonData me() {
        AccountDTO account = LoginInterceptor.currentAccount();
        return JsonData.buildSuccess(account);
    }
}

这里有个实际收益:前端调用 /me 时,只需带上登录凭证。 后端使用已校验 JWT 中的账号 ID 来确定当前用户。以后实现“修改我的昵称”,也可以从这个上下文获取操作人,再用请求体接收新昵称。

如果接口是“修改某个群聊资料”,知道当前账号是谁只完成了身份确认。这个账号是不是群主、有没有修改权限,仍要根据具体资源做授权判断。对需要覆盖整个应用的认证与授权,Spring 官方推荐使用 Spring Security 或与 Servlet 过滤器链集成的方案。Spring MVC 关于拦截器适用范围的说明

五、为什么请求结束后必须 remove()?

ThreadLocal 把值绑定在当前线程上。一次普通的同步请求中,拦截器和 Controller 通常运行在同一个线程,因此前面 set(account),后面就能 get()。

但 Web 容器会复用工作线程。假设线程先处理了小明的请求,请求结束后,这个线程还可能处理一个公开接口。如果没有清理,公开接口中的日志代码一旦读取账号上下文,就可能读到上一次请求留下的小明。

所以本例将账号上下文的使用范围限定为:

登录校验通过 → set(account) → Controller 使用 → afterCompletion 中 remove()

这个约定适用于本文的同步 MVC 示例。如果把任务提交给 @Async 或线程池,工作线程有自己的 ThreadLocal。异步任务需要操作人 ID 时,可以在提交任务前读取 accountId 并作为参数传入。使用 MVC 异步请求时,还需要考虑原请求线程退出后的清理时机。Spring HandlerInterceptor 异步处理说明

六、用四次请求验证拦截器

可以在 preHandle()、`AccountController.me()` 和 afterCompletion() 各打一个断点,用 Postman 对照下面的结果:

请求预期结果
调用 /api/account/me,不带 token返回 HTTP 401 和未登录业务响应,`me()` 不执行
调用 /api/account/me,携带已过期的 tokenJWT 校验失败,返回未登录响应
调用 /api/account/me,携带有效 token进入 me(),读到当前账号,完成后清理上下文
调用已排除的登录接口直接进入登录流程,`LoginInterceptor` 不参与

联调时尤其值得看一眼真实的 HTTP 状态码。`JsonData.buildResult(...)` 决定响应体里的业务码,`response.setStatus(401)` 决定 HTTP 状态。如果 Postman 里显示“正文提示未登录,但 HTTP 仍然是 200”,就要检查 CommonUtil.sendJsonMessage() 写 JSON 时是否又设置了响应状态。

把有效 token 的那次请求用断点走完,就能看到这个拦截器最重要的三行代码分别在什么时候生效:`set()` 让当前账号在同步请求中可用,`return true` 让业务方法继续执行,`remove()` 在线程被复用前结束这次请求的账号上下文。

Spring Boot实战:拦截器 什么是拦截器:概念 :拦截器是Spring框架提供的核功能之, 主要来拦截的请求, 在指定法前后, 根据业务需要执预先设定的代码。也就是说, 允许开发员提前预定义些逻辑, 在的请求响应前后执. 也可以在请求前阻其执.在拦截器当中,开发员可以在应程序中做些通性的操作, 如通过拦截器来拦截前端发来的请求, 判断Session中是否有登录的信息. 如果有就可以放, 如果没有就进拦截.拦截器在SpringBoot中主要有以下几个作用:1.2拦截器的基本使用拦截器的使步骤分为两步:1.定义拦截器:实现HandlerI 阅读详情

相关推荐

Spring Boot拦截器(Interceptor)详解

在拦截器当中,我们通常也是做一些通用性的操作,比如:我们可以通过拦截器来拦截前端发起的请求,将登录校验的逻辑全部编写在拦截器当中。方法,这个方法执行完成后需要返回一个布尔类型的值,如果返回true,就表示放行本次操作,才会继续访问controller中的方法;以上就是拦截器的执行流程。,表示拦截所有资源,而在配置拦截器时,不仅可以指定要拦截哪些资源,还可以指定不拦截哪些资源,只需要调用。首先我们先来看拦截器的拦截路径的配置,在注册配置拦截器的时候,我们要指定拦截器的拦截路径,通过。

Delu3376451753的博客 2583

SpringBoot 之 HandlerInterceptor 拦截器的使用

SpringBoot 之 HandlerInterceptor 拦截器的使用

陈皮的JavaLib 1万+

拦截器+Redis实现Token用户信息登录校验

登录拦截器:在这里介绍的登录拦截器主要有两个功能作用,禁止未登录或登录信息失效状态下对系统进行操作,同时实现用户登录信息的过期机制。 我们通常会将用户信息保存在session或cookie中,而对于session来讲设置它的过期时间相对不太灵活,cookie又允许被禁用,所以我选择将用户信息加密成token存在请求头中。 对于我的项目来说,后端所有接口中只会用到当前用户的userId,userName和用户类型userType。所以在登陆时我将这三个信息拼接并解密成token传给前端,同时将此token存入

weixin_43204673的博客 3269

springboot拦截器

1.什么是拦截器 拦截器(Interceptor)类似于Servlet中的过滤器,主要用于拦截客户请求并做出相应的处理。与过滤器有如下区别: 1.过滤器只能在容器初始化时被调用一次,在action的生命周期中,而拦截器可以多次被调用。 2.过滤器可以对几乎所有的请求起作用,拦截器只能对action请求起作用。 3.过滤器不能访问action上下文、值栈里的对象,而拦截器可以访问。 4.过滤器依赖于servlet容器,而拦截器不依赖于servlet容器。 5.过滤器是基于函数回调,而拦截器是基于java的反射

作为一个长者,有必要记录下人生经验 2万+

Spring Boot拦截器精讲

我们对拦截器并不陌生,无论是 Struts 2 还是 Spring MVC 中都提供了拦截器功能,它可以根据 URL 对请求进行拦截,主要应用于登陆校验、权限验证、乱码解决、性能监控和异常处理等功能上。Spring Boot 同样提供了拦截器功能。在 Spring Boot 项目中,使用拦截器功能通常需要以下 3 步: 定义拦截器; 注册拦截器; 指定拦截规则(如果是拦截所有,静态资源也会被拦截)。 定义拦截器 在 Spring Boot 中定义拦截器十分的简单,只需要创建一个拦截器类,并实现 Handle

洛卡JAVA架构师每日分享Java架构师知识 2143

基于openEuler配置LAMP,部署WordPress

openEuler 基于OpenEular操作系统部署WordPress,必须包含以下内容: OpenEular的安装与基本配置。 基于SSH远程管理方式开展操作。 部署LAMP环境。 部署WordPress软件。 提供个人网站服务,并通过浏览器测试应用。 简要讲授相关知识与原理。 cd /etc/yum.repos.d 欧拉系统安装后,没有配置yum源,我们需要重新配置。 [root@localhost yum.repos.d]# ls -l 总用量 4 -rw-r--r--

Axiayouqiaomu的博客 6084

spring boot 拦截器 HandlerInterceptor

一、简介 拦截器常用于登录拦截、权限校验、防重复提交 二、流程 新建spring boot web 项目 1.TestInterceptor.java 实现拦截器接口 package com.vincent; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; ...

Zllvincent的博客 3668

Codesys电子凸轮Cam表实战:从可视化配置到程序化构建

本文详细介绍了Codesys电子凸轮Cam表的实战应用,从可视化配置到程序化构建的全过程。通过包装机和印刷机案例,解析Cam表的基础设置、调试技巧及动态构建方法,帮助工程师快速掌握电子凸轮技术,提升运动控制精度和效率。

weixin_29309785的博客 302

【SpringBoot】深度解析 Spring Boot 拦截器:实现统一功能处理的关键路径

本期主要总结了在SpringBoot中统一功能处理的拦截器功能,从简单了解实现方法,定义到配置到如何运用到我们的图书管理系统代码里都做了解释

GGBond778的博客 5404

在STM32上运行小波变换及神经网络算法——(一)单片机中小波算法编写

在单片机上实现离散小波变换的C代码,通过确定信号长度、小波分解层数、小波基名称后进行编写,并改写成了方便调用的结构体格式。

weixin_45400202的博客 991

C# WebAPI安全实战:JWT认证与HMAC数字签名防篡改防重放

在分布式系统和微服务架构中,API安全是保障数据交互可信的基石。其核心原理在于建立一套可靠的身份验证与数据完整性保障机制。从技术价值看,这不仅能防止未授权访问,更能有效抵御数据在传输过程中被篡改或重放的风险,是构建高安全等级应用服务的必备能力。典型的应用场景包括金融交易、物联网设备通信、开放平台接口等对安全敏感的业务领域。本文聚焦于C# WebAPI开发,深入探讨如何结合JWT(JSON Web Token)认证与HMAC-SHA256数字签名技术,构建一套覆盖身份验证、防参数篡改和防重放攻击的全方位安全方

快马扬鞭须努力! 606

Spring Boot 拦截器HandlerInterceptor

在 Spring Boot 中定义拦截器十分的简单,只需要创建一个拦截器类,并实现 HandlerInterceptor 接口即可。HandlerInterceptor 接口中定义以下 3 个方法,如下表。返回值类型方法声明描述boolean该方法在控制器处理请求方法前执行,其返回值表示是否中断后续操作,返回 true 表示继续向下执行,返回 false 表示中断后续操作。void该方法在控制器处理请求方法调用之后、解析视图之前执行,可以通过此方法对请求域中的模型和视图做进一步修改。

zhzjn的博客 1329

大数据国赛第2套任务C-子任务一特征工程

根据**Hudi**的dwd_ds_hudi库中相关表或MySQL中shtd_store中相关表(order_detail、sku_info),计算出与用户id为6708的用户所购买相同商品种类最多的前10位用户(只考虑他俩购买过多少种相同的商品,不考虑相同的商品买了多少次),将10位用户id进行输出,若与多个用户购买的商品种类相同,则输出结果按照用户id升序排序,输出格式如下,将结果截图粘贴至客户端桌面【Release任务C提交结果.docx】中对应的任务序号下;

weixin_44117248的博客 907

Spring Boot 拦截器(Interceptor)

本文深入解析了Spring MVC拦截器(HandlerInterceptor)的实现原理和应用场景。拦截器作为Spring MVC的核心组件,主要用于处理Controller层的横切关注点,如身份认证、日志记录、限流等。文章详细对比了拦截器与Servlet过滤器的关键区别,阐述了拦截器三个核心方法(preHandle、postHandle、afterCompletion)的生命周期和执行顺序,并提供了实现自定义拦截器的完整代码示例。通过ThreadLocal存储请求时间戳的实践,展示了拦截器在请求耗

小李同学的博客 2373

商品标签识别系统:基于YOLO系列的深度学习实现

随着零售行业的快速发展和自动化需求的增长,商品标签识别技术变得越来越重要。本文详细介绍了一个完整的商品标签识别系统,该系统基于YOLO系列目标检测算法(包括YOLOv5、YOLOv8和YOLOv10),采用PySide6构建用户界面,并提供完整的训练代码和数据集处理方案。该系统能够准确识别商品标签中的关键信息,如价格、条形码、生产日期等,为零售自动化、库存管理和智能结算提供技术支持。

YOLO 351

高并发网络爬虫实践(欧赔、亚盘、大小指数数据爬取)

本文通过对一个实战化的高并发网络爬虫脚本进行深度模块化剖析,展示了如何构建一个兼具性能、健壮性和易用性的数据采集工具。核心设计思想总结模块化与单一职责: 每个函数都专注于解决一个特定问题,无论是网络请求、数据解析还是文件操作。并发与效率: 通过ThreadPoolExecutor实现了高效的并发抓取,极大缩短了总耗时。健壮性与容错: 强大的重试机制、细致的异常处理和线程安全的文件写入,保证了程序在复杂网络环境下的稳定运行。断点续传: 精心设计了进度记录与恢复机制,使得大规模抓取任务变得轻松可控。

猫敷雪 499

SpringBoot拦截器HandlerInterceptor实现

HandlerInterceptor简介 拦截器我想大家都并不陌生,最常用的登录拦截、或是权限校验、或是防重复提交、或是根据业务像12306去校验购票时间,总之可以去做很多的事情。 拦截器的实现 两种方式: 1、类实现Spring 的HandlerInterceptor 接口。 例如:类直接实现HandlerInterceptor 或直接实现AsyncHandlerInterceptor 2、类继承实现了HandlerInterceptor 接口的类。 例如: 已经提供的实现了HandlerI

西凉的悲伤博客 3179

Java Swing教程-16. Swing中的图形绘制

这篇教程介绍了Java Swing中的图形绘制功能,主要内容包括: Graphics类的基本使用 - 介绍了如何重写paintComponent方法实现自定义绘制,以及基本图形绘制方法(线条、矩形、椭圆、多边形等) 文本与图片绘制 - 讲解了文本绘制方法、字体设置和图片加载绘制技术 颜色与字体设置 - 包括预定义颜色、RGB自定义颜色、透明色设置以及字体样式控制 案例实现 - 提供了一个简单绘图程序的框架,支持鼠标绘制不同图形、选择工具和自定义颜色等功能 教程通过代码示例详细演示了各种绘图操作,适合Java

无 235

Spring Boot拦截器

在 Spring Boot 中定义拦截器十分的简单,只需要创建一个拦截器类,并实现 HandlerInterceptor 接口即可。HandlerInterceptor 接口中定义以下 3 个方法,如下表。返回值类型方法声明描述booleanServlet该方法在控制器处理请求方法前执行,其返回值表示是否中断后续操作,返回 true 表示继续向下执行,返回 false 表示中断后续操作。void。

xiatianit的博客 1214

廖雪峰Python教程[完整版]

廖雪峰的python教程整理的,已经排好版了,而且还是完整的,适合小白

大中型超市收银系统(可直接运行)

光步前台收银系统系统功能:商品销售、商品退货、挂单、收银员权限、会员销售、单品取消、整单取消、商品查询、脱机销售、脱机数据上传,基本资料下载,开钱箱、小票打印、收款结算,支持多币种付款方式(现金、储值卡、礼券、微信等),支持多种促销。运行环境:.net 4.0登陆信息用户名:1001 密码:123456内置商品信息,商品编码可输入00001000 - 00010000,测试效果相关功能键F5 结算 F9挂单 F11商品查询 F8退货 Insert单品取消 Del整单取消 F12开钱箱F2 会员 Ctrl+Z退出系统 Home 锁屏 相关源码待公开

Spring Boot中的拦截器!

场景:记录请求耗时和用户身份验证。方法:实现HandlerInterceptor接口,重写三个方法。代码@Override// 模拟权限校验@Override@Overrideif (ex!= null) {说明:preHandle校验Token并记录开始时间,afterCompletion计算耗时并记录异常。案例:某微服务用拦截器记录API耗时,发现慢接口,优化后响应时间从500ms降至200ms。实践。

朱雀随云记的博客 2184

Statistics and Machine Learning Toolbox

Statistics and Machine Learning Toolbox(带书签),MATLAB统计学习工具

SpringBoot登录校验(五)拦截器Interceptor

实现HandlerInterceptor接口,并重写其所有方法。

qq_42736179的博客 1544

蓝牙模块HM-10手册

蓝牙模块HM-10手册,该手册对蓝牙模块HM-10进行了详细的介绍和使用方法以及一些AT指令。

上一篇: Spring Boot 全局异常处理:用 @RestControllerAdvice 统一接口错误
爱方舟的爪子
博客等级 码龄2年 0粉丝 12原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值
⌂ 换网址