身份认证与应用安全 / 系统课时

配置 Sa-Token 路由拦截器

配置 Sa-Token 路由拦截器

当业务接口越来越多时,在每个 Controller 方法里重复调用登录校验既容易遗漏,也会让认证逻辑散落。通过 SaInterceptor 接入 Spring MVC 拦截链,可以让指定路由在进入 Controller 前统一执行 StpUtil.checkLogin()。

学习目标

  • 在 Spring MVC 中注册 SaInterceptor
  • 使用包含与排除路径控制哪些请求需要登录
  • 理解未登录请求为何不会进入目标 Controller

注册登录校验拦截器

片段示例:下面配置依赖项目已经接入 Sa-Token 与 Spring MVC,并且该配置类位于 Spring Boot 可扫描的包中。

java
package com.example.auth;

import cn.dev33.satoken.interceptor.SaInterceptor;
import cn.dev33.satoken.stp.StpUtil;
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 SaTokenConfigure implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new SaInterceptor(handler -> StpUtil.checkLogin()))
                .addPathPatterns("/**")
                .excludePathPatterns("/auth/login");
    }
}

预期结果

text
/auth/login:跳过登录校验,可用于建立登录会话
其他匹配 /** 的请求:先执行 StpUtil.checkLogin(),校验通过后才进入 Controller
未登录请求:在拦截阶段抛出 NotLoginException,目标 Controller 不会执行

这里的 addPathPatterns("/**") 决定拦截器参与哪些请求,excludePathPatterns("/auth/login") 再从中排除公开入口。异常最终转换成什么 HTTP 状态码和响应体,取决于项目自己的全局异常处理规则,拦截器本身不应被理解成固定返回某个状态码。

请求在进入 Controller 前发生什么

Spring MVC 会先做路径匹配,再调用已注册的拦截器。只有 StpUtil.checkLogin() 正常返回,请求才继续进入目标 Controller;未登录时抛出的 NotLoginException 会中断这条调用链。

Sa-Token 路由拦截的请求执行路径

这也是路由拦截比“每个方法手写校验”更可靠的原因:认证成为请求入口处的统一规则,而不是依赖开发者记得在每个业务方法开头补一行代码。

设计放行路径

登录接口必须被放行,否则未登录用户连建立会话的入口都无法访问。验证码、健康检查或确实公开的静态资源也可以按业务需要加入排除列表,但不要为了省事排除过宽的路径。

如果应用配置了 context-path,Spring MVC 的排除规则通常仍写应用内部路径,例如 /auth/login,不要把上下文前缀重复拼进去。路径规则较多时,应优先维护少量清晰的公开入口,而不是堆叠大量互相覆盖的匹配条件。

验证拦截链是否生效

验证时选择一个确定受保护的业务接口,先在未登录状态访问:正确现象是 Controller 内的业务代码没有执行,并出现 NotLoginException 对应的统一错误响应。随后完成登录,再携带同一会话的 Token 请求该接口,业务方法应能正常执行。

SaInterceptor 解决的是 Spring MVC 请求进入 Controller 前的统一认证问题。只要包含路径、公开路径和异常处理三者边界明确,后续角色或权限校验也可以在同一拦截链中继续扩展,而不必把认证逻辑重新散回每个接口。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

配置 Sa-Token 路由拦截器

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通