完善文档

This commit is contained in:
click33 2022-08-11 01:52:28 +08:00
parent 08ba8a0b52
commit 055f2c9aa2
2 changed files with 9 additions and 5 deletions

View File

@ -11,13 +11,13 @@ Sa-Token提供以下API助你直接操作会话列表
``` java
// 查询所有token
StpUtil.searchTokenValue(String keyword, int start, int size);
StpUtil.searchTokenValue(String keyword, int start, int size, boolean sortType);
// 查询所有账号Session会话
StpUtil.searchSessionId(String keyword, int start, int size);
StpUtil.searchSessionId(String keyword, int start, int size, boolean sortType);
// 查询所有令牌Session会话
StpUtil.searchTokenSessionId(String keyword, int start, int size);
StpUtil.searchTokenSessionId(String keyword, int start, int size, boolean sortType);
```
@ -25,11 +25,12 @@ StpUtil.searchTokenSessionId(String keyword, int start, int size);
- `keyword`: 查询关键字,只有包括这个字符串的 token 值才会被查询出来。
- `start`: 数据开始处索引, 值为-1时代表一次性取出所有数据。
- `size`: 要获取的数据条数。
- `sortType`: 排序方式true=正序false=反序)。
使用示例:
``` java
// 查询value包括1000的所有token结果集从第0条开始返回10条
List<String> tokenList = StpUtil.searchTokenValue("1000", 0, 10);
List<String> tokenList = StpUtil.searchTokenValue("1000", 0, 10, true);
for (String token : tokenList) {
System.out.println(token);
}

View File

@ -233,7 +233,10 @@ sa-token:
这样就保证了伪造的 Token 是无法获取 `Token-Session` 对象的。
但是 —— 有的场景下我们又确实需要关闭这个校验功能,这时候就把配置项 `tokenSessionCheckLogin` 值改为 `false` 即可。
但是 —— 有的场景下我们又确实需要在登录之前就使用 Token-Session 对象,这时候就把配置项 `tokenSessionCheckLogin` 值改为 `false` 即可。
需要注意的一点是:此时如果前端提交的 Token 是一个无效 Token 的话,框架将不会根据此 Token 创建 `Token-Session` 对象,
而是随机一个新的 Token 值来创建 `Token-Session` 对象,此 Token 值可以通过 `StpUtil.getTokenValue()` 获取到。
#### isAutoMode