完善文档

This commit is contained in:
click33
2023-01-10 19:02:11 +08:00
parent a917da0b72
commit fc903cf296
6 changed files with 28 additions and 4 deletions

View File

@@ -1,6 +1,24 @@
# 更新日志
### 2023-1-10 @v1.34.0
- 新增:新增 `SpringBoot3.x` 集成插件,感谢 `@jry` 提供的参考思路。 **[重要]**
- 新增:新增 `sa-token-dao-redisson-jackson` 插件,感谢 `@疯狂的狮子Li` 提交的pr。 **[重要]**
- 新增Alone-Redis 新增集群配置能力,感谢 `@appleOfGray` 提交的pr。 **[重要]**
- 升级:升级 Sign 签名模块,增加部分重载方法。
- 重构:`SaSignTemplate#joinParams` 更名为 `joinParamsDictSort`**[不向下兼容]**
- 升级:升级临时 Token 认证模块,可指定 service 参数。
- 删除:彻底删除过期类 `SaAnnotationInterceptor``SaRouteInterceptor`
- 删除SSO 模块移除过期类 `SaSsoHandle` 类。
- 新增SSO 模块增加 ticket 的 client 锁定功能,解决部分场景下的 ticket 劫持问题。 **[重要]**
- 修复:修复 SSO 模式2在 client 端配置 `is-share=false` 时无法单点注销的问题。
- 修复:修复 SSO 模式3 部分场景下注销时无法正常回退页面的问题。
- 修复:修复 OAuth2 模块示例 getClientModel 方法 clientId 写错的问题。
- 重构:使用 jwt-simple 模式后 is-share 恒等于 false无论是否有设定 `setExtra` 数据。
- 修复:修复源码注释和文档的部分不合适之处。
### 2022-11-16 @v1.33.0
- 重构:重构异常状态码机制。 **[重要]**
- 重构:重构 sa-token-sso 模块异常码改为 300 开头sa-token-jwt 异常码改为 302 开头。 **[不向下兼容]**

View File

@@ -57,7 +57,7 @@ public class SaOAuth2TemplateImpl extends SaOAuth2Template {
// 此为模拟数据,真实环境需要从数据库查询
if("1001".equals(clientId)) {
return new SaClientModel()
.setClientId("10001")
.setClientId("1001")
.setClientSecret("aaaa-bbbb-cccc-dddd-eeee")
.setAllowUrl("*")
.setContractScope("userinfo")

View File

@@ -19,6 +19,7 @@
<version>${sa.top.version}</version>
</dependency>
```
注:如果你使用的 `SpringBoot 3.x`,只需要将 `sa-token-spring-boot-starter` 修改为 `sa-token-spring-boot3-starter` 即可。
<!------------- tab:WebFlux环境 Reactor ------------->
注:如果你使用的框架基于 Reactor 模型构建Netty、WebFlux、ShenYu、SC Gateway等请引入此包
@@ -30,6 +31,7 @@
<version>${sa.top.version}</version>
</dependency>
```
注:如果你使用的 `SpringBoot 3.x`,只需要将 `sa-token-reactor-spring-boot-starter` 修改为 `sa-token-reactor-spring-boot3-starter` 即可。
<!------------- tab:Solon 集成 ------------->
参考:[Solon官网](https://solon.noear.org/)

View File

@@ -30,6 +30,8 @@ implementation 'cn.dev33:sa-token-spring-boot-starter:${sa.top.version}'
```
<!---------------------------- tabs:end ---------------------------->
注:如果你使用的 `SpringBoot 3.x`,只需要将 `sa-token-spring-boot-starter` 修改为 `sa-token-spring-boot3-starter` 即可。
Maven依赖一直无法加载成功[参考解决方案](https://sa-token.cc/doc.html#/start/maven-pull)
更多内测版本了解:[Sa-Token最新版本](https://gitee.com/dromara/sa-token/blob/dev/sa-token-doc/start/new-version.md)

View File

@@ -33,6 +33,7 @@ implementation 'cn.dev33:sa-token-reactor-spring-boot-starter:${sa.top.version}'
```
<!---------------------------- tabs:end ------------------------------>
注:如果你使用的 `SpringBoot 3.x`,只需要将 `sa-token-reactor-spring-boot-starter` 修改为 `sa-token-reactor-spring-boot3-starter` 即可。

View File

@@ -176,6 +176,7 @@ Client 端配置:
| ssoLogoutCall | String | null | 配置当前 Client 端的单点注销回调URL (为空时自动获取) |
| secretkey | String | null | 接口调用秘钥 用于SSO模式三单点注销的接口通信身份校验 |
| serverUrl | String | null | 配置 Server 端主机总地址,拼接在 `authUrl`、`checkTicketUrl`、`userinfoUrl`、`sloUrl` 属性前面,用以简化各种 url 配置,[详解](/use/config?id=配置项详解serverUrl) |
| client | String | "" | 当前 Client 名称标识,用于和 ticket 码的互相锁定 |
配置示例: