身份认证与应用安全 / 系统课时
获取当前 Token 状态信息
获取当前 Token 状态信息
排查认证问题时,首先要确认请求携带了哪个 Token、Sa-Token 是否判定它已登录,以及距离失效还剩多久。本节用 StpUtil 读取这些状态,并把它们整理成一个可直接验证的诊断接口。
学习目标
- 使用
StpUtil获取当前请求的 Token 值与登录状态 - 读取 Token 剩余有效期并理解特殊返回值
- 区分“请求带了 Token”和“Token 仍然有效”这两件事
读取当前请求的状态
Sa-Token 把当前请求中的认证信息集中在 StpUtil 上。排查会话时最常用的几个入口如下:
| API | 作用 |
|---|---|
StpUtil.getTokenValue() |
读取当前请求提交的 Token 值 |
StpUtil.isLogin() |
判断当前 Token 是否处于有效登录状态 |
StpUtil.getTokenTimeout() |
获取当前 Token 剩余有效期,单位为秒 |
StpUtil.getTokenInfo() |
一次取得 Token 名称、值、登录状态、登录账号、剩余有效期等信息 |
关键点是:能读到 Token 值不等于已经登录。客户端可能提交了过期、被踢下线或无效的 Token,因此判断认证状态应以 isLogin 或 SaTokenInfo#getIsLogin() 为准。
暴露一个可验证的状态接口
下面的 Controller 可直接加入已经接入 Sa-Token 的 Spring MVC 项目。它保留最关键的三项状态,便于开发阶段检查请求上下文是否符合预期。
package com.example.auth;
import cn.dev33.satoken.stp.SaTokenInfo;
import cn.dev33.satoken.stp.StpUtil;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.LinkedHashMap;
import java.util.Map;
@RestController
@RequestMapping("/debug")
public class TokenStateController {
@GetMapping("/token-state")
public Map<String, Object> tokenState() {
SaTokenInfo info = StpUtil.getTokenInfo();
Map<String, Object> result = new LinkedHashMap<>();
result.put("tokenValue", StpUtil.getTokenValue());
result.put("isLogin", info.getIsLogin());
result.put("tokenTimeout", info.getTokenTimeout());
return result;
}
}预期结果
当请求携带有效 Token 时,响应形态类似:
{"tokenValue":"<TOKEN>","isLogin":true,"tokenTimeout":<SECONDS>}<TOKEN> 和 <SECONDS> 会随实际会话变化。若客户端没有提交有效 Token,isLogin 会表现为未登录,其他字段也应按当前会话真实状态解读,而不是只看 Token 字符串是否存在。
理解剩余有效期
tokenTimeout 的单位是秒。正常登录会话通常得到一个大于等于 0 的剩余秒数;配置为永久有效时返回 -1。在 SaTokenInfo 的超时字段中,-2 表示对应的值不存在,因此诊断页面不要把所有负数都当作“马上过期”。
剩余有效期还会随着请求时间推进而变化。如果项目同时启用了活跃超时等机制,最终是否允许访问仍应交给 Sa-Token 的登录校验逻辑判断,而不是自行用某一个超时数字重复实现认证规则。
生产环境避免暴露原始 Token
原始 Token 本身就是认证凭证。开发阶段可以临时输出它定位 Header、Cookie 或查询参数传递问题,但生产接口不应把完整 Token 返回给普通用户,也不应写入可长期留存的业务日志。
更稳妥的状态接口只返回 isLogin、剩余有效期和必要的登录标识;确实需要展示 Token 时,应限制为内部调试入口并做脱敏。这样既能保留排障能力,也不会把诊断功能变成新的凭证泄露点。