sa-token/sa-token-doc/use/kick.md

51 lines
1.9 KiB
Markdown
Raw Normal View History

2020-02-06 00:52:49 +08:00
# 踢人下线
2022-10-15 01:57:34 +08:00
2022-06-29 08:14:58 +08:00
所谓踢人下线,核心操作就是找到指定 `loginId` 对应的 `Token`,并设置其失效。
2020-02-06 00:52:49 +08:00
2021-07-23 00:19:58 +08:00
![踢下线](https://oss.dev33.cn/sa-token/doc/kickout.png)
2021-03-11 01:06:27 +08:00
2021-01-02 04:00:49 +08:00
---
2020-02-06 00:52:49 +08:00
2021-10-11 01:09:28 +08:00
### 1、强制注销
2021-01-02 04:00:49 +08:00
``` java
2021-10-11 01:09:28 +08:00
StpUtil.logout(10001); // 强制指定账号注销下线
StpUtil.logout(10001, "PC"); // 强制指定账号指定端注销下线
StpUtil.logoutByTokenValue("token"); // 强制指定 Token 注销下线
2021-01-02 04:00:49 +08:00
```
2020-02-06 00:52:49 +08:00
2021-10-11 01:09:28 +08:00
### 2、踢人下线
``` java
2021-10-11 01:09:28 +08:00
StpUtil.kickout(10001); // 将指定账号踢下线
StpUtil.kickout(10001, "PC"); // 将指定账号指定端踢下线
StpUtil.kickoutByTokenValue("token"); // 将指定 Token 踢下线
```
2021-10-11 01:09:28 +08:00
强制注销 和 踢人下线 的区别在于:
- 强制注销等价于对方主动调用了注销方法再次访问会提示Token无效。
- 踢人下线不会清除Token信息而是将其打上特定标记再次访问会提示Token已被踢下线。
2022-05-09 17:35:29 +08:00
<button class="show-img" img-src="https://oss.dev33.cn/sa-token/doc/g/g3--kickout.gif">加载动态演示图</button>
2025-03-19 12:53:11 +08:00
### 3、顶人下线
“顶人下线” 操作发生在框架登录时顶退旧登录设备,属于框架内部操作,一般情形下你不会调用到此 API
``` java
StpUtil.replaced(10001); // 将指定账号顶下线
StpUtil.replaced(10001, "PC"); // 将指定账号指定端顶下线
StpUtil.replacedByTokenValue("token"); // 将指定 Token 顶下线
```
2022-10-11 18:00:47 +08:00
---
2022-10-17 00:25:28 +08:00
<a class="case-btn" href="https://gitee.com/dromara/sa-token/blob/master/sa-token-demo/sa-token-demo-case/src/main/java/com/pj/cases/use/KickoutController.java"
target="_blank">
2024-05-06 12:01:07 +08:00
本章代码示例Sa-Token 踢人下线 —— [ KickoutController.java ]
2022-10-17 00:25:28 +08:00
</a>
2022-10-11 18:00:47 +08:00
<a class="dt-btn" href="https://www.wenjuan.ltd/s/MFNN7bK/" target="_blank">本章小练习Sa-Token 基础 - 踢人下线,章节测试</a>
2021-04-13 15:38:58 +08:00