From e1141ef942d1775801566c273730a40f5ba86678 Mon Sep 17 00:00:00 2001 From: click33 <2393584716@qq.com> Date: Wed, 28 Aug 2024 02:05:02 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BC=98=E5=8C=96=E6=96=87=E6=A1=A3SSO?= =?UTF-8?q?=E9=9B=86=E6=88=90=E6=B5=81=E7=A8=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../java/com/pj/sso/SsoClientController.java | 6 +- sa-token-doc/sso/sso-type2.md | 121 +----------------- sa-token-doc/sso/sso-type3.md | 106 ++++++++++++++- 3 files changed, 111 insertions(+), 122 deletions(-) diff --git a/sa-token-demo/sa-token-demo-sso/sa-token-demo-sso2-client/src/main/java/com/pj/sso/SsoClientController.java b/sa-token-demo/sa-token-demo-sso/sa-token-demo-sso2-client/src/main/java/com/pj/sso/SsoClientController.java index 4eeed193..361d1cfb 100644 --- a/sa-token-demo/sa-token-demo-sso/sa-token-demo-sso2-client/src/main/java/com/pj/sso/SsoClientController.java +++ b/sa-token-demo/sa-token-demo-sso/sa-token-demo-sso2-client/src/main/java/com/pj/sso/SsoClientController.java @@ -1,5 +1,6 @@ package com.pj.sso; +import cn.dev33.satoken.sso.SaSsoManager; import cn.dev33.satoken.sso.config.SaSsoClientConfig; import cn.dev33.satoken.sso.processor.SaSsoClientProcessor; import cn.dev33.satoken.stp.StpUtil; @@ -20,10 +21,11 @@ public class SsoClientController { // 首页 @RequestMapping("/") public String index() { + String solUrl = SaSsoManager.getClientConfig().splicingSloUrl(); String str = "

Sa-Token SSO-Client 应用端

" + "

当前会话是否登录：" + StpUtil.isLogin() + "

" + - "

登录 " + - "注销

"; + "

登录 " + + "注销

"; + "

登录 " + + " - -Forest 是一个轻量级 http 请求工具，详情参考：[Forest](https://forest.dtflyx.com/) - -因为我们已经在控制台手动打印 url 请求日志了，所以此处 `forest.log-enabled=false` 关闭 Forest 框架自身的日志打印，这不是必须的，你可以将其打开。 - - -#### 5.2、SSO-Client 端新增配置：API调用秘钥 - -在 `application.yml` 增加： - - - -``` yaml -sa-token: - sign: - # API 接口调用秘钥 - secret-key: kQwIOrYvnXmSDkwEiFngrKidMcdrgKor - -forest: - # 关闭 forest 请求日志打印 - log-enabled: false -``` - -``` properties -# 接口调用秘钥 -sa-token.sign.secret-key=kQwIOrYvnXmSDkwEiFngrKidMcdrgKor - -# 关闭 forest 请求日志打印 -forest.log-enabled=false -``` - - -注意 secretkey 秘钥需要与SSO认证中心的一致 - -#### 5.3、SSO-Client 配置 http 请求处理器 -``` java -// 配置SSO相关参数 -@Autowired -private void configSso(SaSsoClientConfig ssoClient) { - // 配置Http请求处理器 - ssoClient.sendHttp = url -> { - System.out.println("------ 发起请求：" + url); - String resStr = Forest.get(url).executeAsString(); - System.out.println("------ 请求结果：" + resStr); - return resStr; - }; -} -``` - -#### 5.3、启动测试 -重启项目，依次登录三个 client： -- [http://sa-sso-client1.com:9001/](http://sa-sso-client1.com:9001/) -- [http://sa-sso-client2.com:9001/](http://sa-sso-client2.com:9001/) -- [http://sa-sso-client3.com:9001/](http://sa-sso-client3.com:9001/) - -![sso-type3-client-index.png](https://oss.dev33.cn/sa-token/doc/sso/sso-type3-client-index.png 's-w-sh') - -在任意一个 client 里，点击 **`[注销]`** 按钮，即可单点注销成功（打开另外两个client，刷新一下页面，登录态丢失）。 - - - -![sso-type3-slo-index.png](https://oss.dev33.cn/sa-token/doc/sso/sso-type3-slo-index.png 's-w-sh') - -PS：这里我们为了方便演示，使用的是超链接跳页面的形式，正式项目中使用 Ajax 调用接口即可做到无刷单点登录退出。 - -例如，我们使用 [Apifox 接口测试工具](https://www.apifox.cn/) 可以做到同样的效果： - -![sso-slo-apifox.png](https://oss.dev33.cn/sa-token/doc/sso/sso-slo-apifox.png 's-w-sh') - -测试完毕！ - - -### 6、跨 Redis 的单点登录 +### 5、跨 Redis 的单点登录 以上流程解决了跨域模式下的单点登录，但是后端仍然采用了共享Redis来同步会话，如果我们的架构设计中Client端与Server端无法共享Redis，又该怎么完成单点登录？ 这就要采用模式三了，且往下看：[SSO模式三：Http请求获取会话](/sso/sso-type3) diff --git a/sa-token-doc/sso/sso-type3.md b/sa-token-doc/sso/sso-type3.md index 39fe8c4a..5ec4ea98 100644 --- a/sa-token-doc/sso/sso-type3.md +++ b/sa-token-doc/sso/sso-type3.md @@ -22,7 +22,32 @@ ### 2、在Client 端更改 Ticket 校验方式 -在 application.yml 新增配置： + +#### 2.1、增加 pom.xml 配置 + + + +``` xml + + + com.dtflys.forest + forest-spring-boot-starter + 1.5.26 + +``` + +``` gradle +// Http请求工具 +implementation 'com.dtflys.forest:forest-spring-boot-starter:1.5.26' +``` + + +Forest 是一个轻量级 http 请求工具，详情参考：[Forest](https://forest.dtflyx.com/) + + +#### 2.2、SSO-Client 端新增配置：API调用秘钥 + +在 `application.yml` 增加： @@ -31,14 +56,47 @@ sa-token: sso-client: # 打开模式三（使用Http请求校验ticket） is-http: true + sign: + # API 接口调用秘钥 + secret-key: kQwIOrYvnXmSDkwEiFngrKidMcdrgKor + +forest: + # 关闭 forest 请求日志打印 + log-enabled: false ``` ``` properties # 打开模式三（使用Http请求校验ticket） sa-token.sso-client.is-http=true +# 接口调用秘钥 +sa-token.sign.secret-key=kQwIOrYvnXmSDkwEiFngrKidMcdrgKor + +# 关闭 forest 请求日志打印 +forest.log-enabled=false ``` +因为我们已经在控制台手动打印 url 请求日志了，所以此处 `forest.log-enabled=false` 关闭 Forest 框架自身的日志打印，这不是必须的，你可以将其打开。 + +注意 secretkey 秘钥需要与SSO认证中心的一致 + +#### 2.3、SSO-Client 配置 http 请求处理器 +``` java +// 配置SSO相关参数 +@Autowired +private void configSso(SaSsoClientConfig ssoClient) { + // 配置Http请求处理器 + ssoClient.sendHttp = url -> { + System.out.println("------ 发起请求：" + url); + String resStr = Forest.get(url).executeAsString(); + System.out.println("------ 请求结果：" + resStr); + return resStr; + }; +} +``` + + +#### 2.4、测试 重启项目，访问测试： - [http://sa-sso-client1.com:9001/](http://sa-sso-client1.com:9001/) @@ -49,6 +107,10 @@ sa-token.sso-client.is-http=true > 注：如果已测试运行模式二，可先将Redis中的数据清空，以防旧数据对测试造成干扰 + + + + ### 3、获取 UserInfo 除了账号id，我们可能还需要将用户的昵称、头像等信息从 Server端 带到 Client端，即：用户资料的拉取。 @@ -192,10 +254,10 @@ public Object getFansList(Long loginId) { 访问测试：[http://sa-sso-client1.com:9001/sso/myFansList](http://sa-sso-client1.com:9001/sso/myFansList) +### 5、无刷单点注销 -### 5、单点注销 +有了单点登录，就必然伴随着单点注销（一处注销，全端下线） -有关 SSO 单点注销的步骤，在上一章节的“无刷单点注销”部分已讲解完毕（模式二和模式三通用），所以此处就不再赘述了。 此处简单介绍一下 SSO 模式三的单点注销链路过程： @@ -212,6 +274,44 @@ public Object getFansList(Long loginId) { 这些逻辑 Sa-Token 内部已经封装完毕，你只需按照文档步骤集成即可。 +#### 5.1、更改注销方案 + +将 sso-client 首页路由方法里的注销链接换成 `/sso/logout` 接口： +``` java +// SSO-Client端：首页 +@RequestMapping("/") +public String index() { + String str = "

Sa-Token SSO-Client 应用端

" + + "

当前会话是否登录：" + StpUtil.isLogin() + "

" + + "

登录" + + " 注销

"; + return str; +} +``` + +#### 5.2、启动测试 +重启项目，依次登录三个 client： +- [http://sa-sso-client1.com:9001/](http://sa-sso-client1.com:9001/) +- [http://sa-sso-client2.com:9001/](http://sa-sso-client2.com:9001/) +- [http://sa-sso-client3.com:9001/](http://sa-sso-client3.com:9001/) + +![sso-type3-client-index.png](https://oss.dev33.cn/sa-token/doc/sso/sso-type3-client-index.png 's-w-sh') + +在任意一个 client 里，点击 **`[注销]`** 按钮，即可单点注销成功（打开另外两个client，刷新一下页面，登录态丢失）。 + + + +![sso-type3-slo-index.png](https://oss.dev33.cn/sa-token/doc/sso/sso-type3-slo-index.png 's-w-sh') + +PS：这里我们为了方便演示，使用的是超链接跳页面的形式，正式项目中使用 Ajax 调用接口即可做到无刷单点登录退出。 + +例如，我们使用 [Apifox 接口测试工具](https://www.apifox.cn/) 可以做到同样的效果： + +![sso-slo-apifox.png](https://oss.dev33.cn/sa-token/doc/sso/sso-slo-apifox.png 's-w-sh') + +测试完毕！ + + ### 6、后记 当我们熟读三种模式的单点登录之后，其实不难发现：所谓单点登录，其本质就是多个系统之间的会话共享。