优化文档结构样式

This commit is contained in:
click33
2024-07-29 00:43:55 +08:00
parent 1224397981
commit ae67ad6a02
38 changed files with 551 additions and 156 deletions

View File

@@ -37,7 +37,8 @@ StpUtil.checkDisable(10001);
StpUtil.login(10001);
```
!> 旧版本在 `StpUtil.login()` 时会自动校验账号是否被封禁v1.31.0 之后将 校验封禁 和 登录 两个动作分离成两个方法,不再自动校验,请注意其中的逻辑更改。
> [!ATTENTION| label:升级注意:]
> 旧版本在 `StpUtil.login()` 时会自动校验账号是否被封禁v1.31.0 之后将 校验封禁 和 登录 两个动作分离成两个方法,不再自动校验,请注意其中的逻辑更改。
此模块所有方法:
``` java

View File

@@ -73,10 +73,10 @@ public class SaTokenConfigure {
}
```
##### 注意事项:
- 在`[认证函数]`里,你可以写和拦截器里一致的代码,进行路由匹配鉴权,参考:[路由拦截鉴权](/use/route-check)。
- 由于过滤器中抛出的异常不进入全局异常处理,所以你必须提供`[异常处理函数]`来处理`[认证函数]`里抛出的异常。
- 在`[异常处理函数]`里的返回值,将作为字符串输出到前端,如果需要定制化返回数据,请注意其中的格式转换。
> [!WARNING| label:注意事项:]
> - 在`[认证函数]`里,你可以写和拦截器里一致的代码,进行路由匹配鉴权,参考:[路由拦截鉴权](/use/route-check)。
> - 由于过滤器中抛出的异常不进入全局异常处理,所以你必须提供`[异常处理函数]`来处理`[认证函数]`里抛出的异常。
> - 在`[异常处理函数]`里的返回值,将作为字符串输出到前端,如果需要定制化返回数据,请注意其中的格式转换。
改写 `setError` 函数的响应格式示例:
``` java

View File

@@ -69,13 +69,13 @@ public SaResult openSafe(String password) {
}
```
调用步骤:
1. 前端调用 `deleteProject` 接口,尝试删除仓库。
2. 后端校验会话尚未完成二级认证,返回: `仓库删除失败,请完成二级认证后再次访问接口`。
3. 前端将信息提示给用户,用户输入密码,调用 `openSafe` 接口。
4. 后端比对用户输入的密码完成二级认证有效期为120秒。
5. 前端在 120 秒内再次调用 `deleteProject` 接口,尝试删除仓库。
6. 后端校验会话已完成二级认证,返回:`仓库删除成功`。
> [!NOTE| label:调用步骤:]
> 1. 前端调用 `deleteProject` 接口,尝试删除仓库。
> 2. 后端校验会话尚未完成二级认证,返回: `仓库删除失败,请完成二级认证后再次访问接口`。
> 3. 前端将信息提示给用户,用户输入密码,调用 `openSafe` 接口。
> 4. 后端比对用户输入的密码完成二级认证有效期为120秒。
> 5. 前端在 120 秒内再次调用 `deleteProject` 接口,尝试删除仓库。
> 6. 后端校验会话已完成二级认证,返回:`仓库删除成功`。
### 指定业务标识进行二级认证

View File

@@ -83,6 +83,7 @@ for (String sessionId : sessionIdList) {
请根据业务实际水平合理调用API。
> [!WARNING| label:注意]
> 基于活动 Token 的统计方式会比实际情况略有延迟,如果需要精确统计实时在线用户信息建议采用 WebSocket。

View File

@@ -32,9 +32,8 @@ sa-token.token-prefix=Bearer
此时 Sa-Token 便可在读取 Token 时裁剪掉 `Bearer`,成功获取`xxxx-xxxx-xxxx-xxxx`。
### 注意点
1. Token前缀 与 Token值 之间必须有一个空格
2. 一旦配置 Token前缀,则前端提交 `Token` 时,必须带有前缀,否则会导致框架无法读取 Token
3. 由于`Cookie`中无法存储空格字符,也就意味配置 Token 前缀后Cookie 鉴权方式将会失效,此时只能将 Token 提交到`header`里进行传输。
> [!WARNING| label:注意点]
> 1. Token前缀 与 Token值 之间必须有一个空格。
> 2. 一旦配置了 Token前缀则前端提交 `Token` 时,必须带有前缀,否则会导致框架无法读取 Token
> 3. 由于`Cookie`中无法存储空格字符,所以配置 Token 前缀Cookie 模式将会失效,此时只能将 Token 提交到`header`里进行传输

View File

@@ -63,5 +63,6 @@ public class SaTokenConfigure {
gfuPSwZsnUhwgz08GTCH4wOgasWtc3odP4HLwXJ7NDGOximTvT4OlW19zeLH
```
!> **更改了 token 生成策略但是不生效?**<br> 把 Redis 中的旧数据清除掉再试试
> [!WARNING| label:更改了 token 生成策略但是不生效?]
> 把 Redis 中的旧数据清除掉再试试