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

26 lines
795 B
Markdown
Raw Normal View History

2020-02-06 00:52:49 +08:00
# 踢人下线
2021-02-06 13:53:46 +08:00
所谓踢人下线,核心操作就是找到其指定`loginId`对应的`token`,并设置其失效
2020-02-06 00:52:49 +08:00
2021-03-11 01:06:27 +08:00
![踢下线](../static/kickout.png)
2021-01-02 04:00:49 +08:00
---
2020-02-06 00:52:49 +08:00
## 具体API
2020-09-07 02:21:35 +08:00
#### StpUtil.logoutByLoginId(Object loginId)
2021-01-02 04:00:49 +08:00
让指定loginId的会话注销登录踢人下线例如
2020-02-06 00:52:49 +08:00
2021-01-02 04:00:49 +08:00
``` java
2021-01-31 23:28:42 +08:00
// 使账号id为10001的会话注销登录待到10001再次访问系统时会抛出`NotLoginException`异常,场景值为-5
StpUtil.logoutByLoginId(10001);
2021-01-02 04:00:49 +08:00
```
2020-02-06 00:52:49 +08:00
#### StpUtil.logoutByTokenValue(String tokenValue);
你还可以让指定token的会话注销登录 (此方法直接删除了`token->uid`的映射关系,对方再次访问时提示:`token无效`,场景值为-2)
``` java
// 使账号id为10001的会话注销登录
StpUtil.logoutByTokenValue("xxxx-xxxx-xxxx-xxxx-xxxx");
```