身份认证与应用安全 / 系统课时
在代码中检查登录状态
在代码中检查登录状态
有些接口必须登录才能继续,有些接口只想根据登录状态返回不同内容。Sa-Token 的 checkLogin() 与 isLogin() 正好对应这两类需求:前者用于强制校验,后者只查询当前状态。本节重点区分它们的控制流语义和适用位置。
学习目标
- 区分
checkLogin()与isLogin()的返回和异常行为。 - 在强制登录与可选登录场景中选择正确 API。
- 避免把状态查询误当成安全校验。
两个 API 的语义不同
StpUtil.isLogin() 返回布尔值,不会替你终止后续业务;StpUtil.checkLogin() 不返回登录状态,当前会话未登录时会抛出 NotLoginException,登录正常时则继续向下执行。
| API | 已登录 | 未登录 | 典型用途 |
|---|---|---|---|
StpUtil.isLogin() |
返回 true |
返回 false |
可选个性化、游客与用户分支 |
StpUtil.checkLogin() |
正常通过 | 抛出 NotLoginException |
必须登录的业务操作 |
因此,“查询状态”和“阻止未登录请求”不是同一件事。安全边界需要失败即停止时,应优先使用 checkLogin()。
在业务代码中选择合适方式
片段示例:以下 Controller 依赖已经集成 Sa-Token 的 Spring Boot 项目,并假设登录流程已经能够正确创建会话。
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;
@RestController
@RequestMapping("/account")
public class AccountController {
@GetMapping("/profile")
public String profile() {
// 这是强制登录边界:未登录时直接终止当前业务流程。
StpUtil.checkLogin();
return "profile";
}
@GetMapping("/welcome")
public String welcome() {
// 这里只查询状态,游客也允许继续访问。
if (StpUtil.isLogin()) {
return "welcome back";
}
return "welcome guest";
}
}生效行为与验证方法如下:未登录访问 /account/profile 时,checkLogin() 会抛出 NotLoginException;登录后访问会返回 profile。未登录访问 /account/welcome 返回 welcome guest,登录后返回 welcome back。NotLoginException 最终映射成什么 HTTP 状态码和响应体,由项目的全局异常处理策略决定。
为什么强制校验不要只写 isLogin
如果必须登录的接口只调用 isLogin(),开发者还要自己处理 false 分支。一旦漏写 return、抛异常或其他终止逻辑,敏感代码仍可能继续执行。checkLogin() 把“未登录立即失败”直接表达在一行代码里,更适合作为保护边界。
相反,首页欢迎语、商品详情中的会员提示、可匿名浏览但登录后增加个性化信息等场景,不应因为未登录就抛异常,此时 isLogin() 更合适。
让异常在统一位置收口
checkLogin() 的正常用法通常不是在每个业务方法里捕获 NotLoginException,而是让异常继续上抛,由统一异常处理器转换成项目约定的响应格式。这样 Controller 只表达“这里必须登录”,错误码、消息和 HTTP 状态可以集中维护。
选择 API 时只需判断一个问题:未登录是否应该立即终止当前流程。答案是“是”就用 checkLogin();答案是“否,只需要知道状态”就用 isLogin()。