lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2025-10-21 19:17:25 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: 重构 TokenSign -> SaTerminalInfo

Browse Source
This commit is contained in:
click33
2025-03-08 15:21:40 +08:00
parent 7d2fac7d98
commit 850af6c131
5 changed files with 45 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
sa-token-doc/api/sa-session.md
View File

@@ -21,16 +21,16 @@ session.setCreateTime(createTime); // 写入此 Session 的创建时间（时
```
### 3、TokenSign 相关
### 3、SaTerminalInfo 相关
``` java
session.setTokenSignList(tokenSignList); // 写入此 Session 绑定的 Token 签名列表
session.getTokenSignList(); // 获取此 Session 绑定的 Token 签名列表
session.tokenSignListCopy(); // 获取 Token 签名列表 的拷贝副本
session.tokenSignListCopyByDevice(device); // 返回 Token 签名列表 的拷贝副本，根据 device 筛选
session.getTokenSign(tokenValue); // 查找一个 Token 签名
session.addTokenSign(tokenSign); // 添加一个 Token 签名
session.addTokenSign(tokenValue, device); // 添加一个 Token 签名
session.removeTokenSign(tokenValue); // 移除一个 Token 签名
session.setTerminalList(terminalList); // 写入登录终端信息列表
session.getTerminalList(); // 获取登录终端信息列表
session.terminalListCopy(); // 获取 登录终端信息列表 (拷贝副本)
session.getTerminalListByDeviceType(deviceType); // 获取 登录终端信息列表 (拷贝副本)，根据 deviceType 筛选
session.getTerminal(tokenValue); // 查找一个终端信息，根据 tokenValue
session.addTerminal(terminal); // 添加一个终端信息
session.removeTerminal(tokenValue); // 移除一个终端信息
session.maxTerminalIndex(); // 获取最大的终端索引值，如无返0
```
@@ -38,7 +38,7 @@ session.removeTokenSign(tokenValue); // 移除一个 Token 签名
``` java
session.update(); // 更新Session（从持久库更新刷新一下）
session.logout(); // 注销Session (从持久库删除)
session.logoutByTokenSignCountToZero(); // 当Session上的tokenSign数量为零时，注销会话
session.logoutByTerminalCountToZero(); // 当 Session 上的 SaTerminalInfo 数量为零时，注销会话
session.getTimeout(); // 获取此Session的剩余存活时间 (单位: 秒)
session.updateTimeout(timeout); // 修改此Session的剩余存活时间
session.updateMinTimeout(minTimeout); // 修改此Session的最小剩余存活时间 (只有在 Session 的过期时间低于指定的 minTimeout 时才会进行修改)

23
sa-token-doc/api/stp-util.md
View File

@@ -32,15 +32,20 @@ SaLoginParameter 配置示例：
``` java
// SaLoginParameter 配置登录相关参数
StpUtil.login(10001, new SaLoginParameter()
.setDevice("PC") // 此次登录的客户端设备类型, 用于[同端互斥登录]时指定此次登录的设备类型
.setIsLastingCookie(true) // 是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在）
.setTimeout(60 * 60 * 24 * 7) // 指定此次登录token的有效期, 单位:秒 （如未指定，自动取全局配置的 timeout 值）
.setToken("xxxx-xxxx-xxxx-xxxx") // 预定此次登录生成的Token
.setExtra("name", "zhangsan") // Token挂载的扩展参数 （此方法只有在集成jwt插件时才会生效）
.setIsWriteHeader(false) // 是否在登录后将 Token 写入到响应头
.setActiveTimeout(300) // 指定此次登录token的最低活跃频率, 单位:秒，设置此参数需要在配置文件打开dynamicActiveTimeout=true
.setTokenSignTag("xxx") // 指定此次登录挂载在 TokenSign 上的 tag 值, 任意值
);
.setDeviceType("PC") // 此次登录的客户端设备类型, 一般用于完成 [同端互斥登录] 功能
.setDeviceId("xxxxxxxxx") // 此次登录的客户端设备ID, 登录成功后该设备将标记为可信任设备
.setIsLastingCookie(true) // 是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在）
.setTimeout(60 * 60 * 24 * 7) // 指定此次登录 token 的有效期, 单位:秒，-1=永久有效
.setActiveTimeout(60 * 60 * 24 * 7) // 指定此次登录 token 的最低活跃频率, 单位:秒，-1=不进行活跃检查
.setIsConcurrent(true) // 是否允许同一账号多地同时登录 （为 true 时允许一起登录, 为 false 时新登录挤掉旧登录）
.setIsShare(true) // 在多人登录同一账号时，是否共用一个 token （为 true 时所有登录共用一个token, 为 false 时每次登录新建一个 token）
.setMaxLoginCount(12) // 同一账号最大登录数量，-1代表不限 （只有在 isConcurrent=true, isShare=false 时此配置项才有意义）
.setMaxTryTimes(12) // 在每次创建 token 时的最高循环次数，用于保证 token 唯一性（-1=不循环尝试，直接使用）
.setExtra("key", "value") // 记录在 Token 上的扩展参数（只在 jwt 模式下生效）
.setToken("xxxx-xxxx-xxxx-xxxx") // 预定此次登录的生成的Token
.setIsWriteHeader(false) // 是否在登录后将 Token 写入到响应头
.setTerminalExtra("key", "value")// 本次登录挂载到 SaTerminalInfo 的自定义扩展数据
);
```