mirror of
https://gitee.com/dromara/sa-token.git
synced 2025-05-03 12:17:57 +08:00
289 lines
9.3 KiB
Markdown
289 lines
9.3 KiB
Markdown
# 搭建统一认证中心 SSO-Server
|
||
|
||
在开始SSO三种模式的对接之前，我们必须先搭建一个 SSO-Server 认证中心
|
||
|
||
> 搭建示例在官方仓库的 `/sa-token-demo/sa-token-demo-sso-server/`，如遇到难点可结合源码进行测试学习，demo里有制作好的登录页面
|
||
|
||
---
|
||
|
||
### 1、添加依赖
|
||
创建 SpringBoot 项目 `sa-token-demo-sso-server`，引入依赖：
|
||
|
||
<!---------------------------- tabs:start ---------------------------->
|
||
<!-------- tab:Maven 方式 -------->
|
||
``` xml
|
||
<!-- Sa-Token 权限认证，在线文档：https://sa-token.cc -->
|
||
<dependency>
|
||
<groupId>cn.dev33</groupId>
|
||
<artifactId>sa-token-spring-boot-starter</artifactId>
|
||
<version>${sa.top.version}</version>
|
||
</dependency>
|
||
|
||
<!-- Sa-Token 插件：整合SSO -->
|
||
<dependency>
|
||
<groupId>cn.dev33</groupId>
|
||
<artifactId>sa-token-sso</artifactId>
|
||
<version>${sa.top.version}</version>
|
||
</dependency>
|
||
|
||
<!-- Sa-Token 整合 Redis (使用 jackson 序列化方式) -->
|
||
<dependency>
|
||
<groupId>cn.dev33</groupId>
|
||
<artifactId>sa-token-dao-redis-jackson</artifactId>
|
||
<version>${sa.top.version}</version>
|
||
</dependency>
|
||
<dependency>
|
||
<groupId>org.apache.commons</groupId>
|
||
<artifactId>commons-pool2</artifactId>
|
||
</dependency>
|
||
|
||
<!-- 视图引擎（在前后端不分离模式下提供视图支持） -->
|
||
<dependency>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-starter-thymeleaf</artifactId>
|
||
</dependency>
|
||
|
||
<!-- Http请求工具（在模式三的单点注销功能下用到，如不需要可以注释掉） -->
|
||
<dependency>
|
||
<groupId>com.dtflys.forest</groupId>
|
||
<artifactId>forest-spring-boot-starter</artifactId>
|
||
<version>1.5.26</version>
|
||
</dependency>
|
||
```
|
||
<!-------- tab:Gradle 方式 -------->
|
||
``` gradle
|
||
// Sa-Token 权限认证，在线文档：https://sa-token.cc
|
||
implementation 'cn.dev33:sa-token-spring-boot-starter:${sa.top.version}'
|
||
|
||
// Sa-Token 插件：整合SSO
|
||
implementation 'cn.dev33:sa-token-sso:${sa.top.version}'
|
||
|
||
// Sa-Token 整合 Redis (使用 jackson 序列化方式)
|
||
implementation 'cn.dev33:sa-token-dao-redis-jackson:${sa.top.version}'
|
||
implementation 'org.apache.commons:commons-pool2'
|
||
|
||
// 视图引擎（在前后端不分离模式下提供视图支持）
|
||
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
|
||
|
||
// Http请求工具（在模式三的单点注销功能下用到，如不需要可以注释掉）
|
||
implementation 'com.dtflys.forest:forest-spring-boot-starter:1.5.26'
|
||
```
|
||
<!---------------------------- tabs:end ---------------------------->
|
||
|
||
|
||
|
||
除了 `sa-token-spring-boot-starter` 和 `sa-token-sso` 以外，其它包都是可选的：
|
||
- 在 SSO 模式三时 Redis 相关包是可选的
|
||
- 在前后端分离模式下可以删除 thymeleaf 相关包
|
||
- 在不需要 SSO 模式三单点注销的情况下可以删除 http 工具包
|
||
|
||
建议先完整测试三种模式之后再对pom依赖进行酌情删减。
|
||
|
||
|
||
### 2、开放认证接口
|
||
新建 `SsoServerController`，用于对外开放接口：
|
||
|
||
``` java
|
||
/**
|
||
* Sa-Token-SSO Server端 Controller
|
||
*/
|
||
@RestController
|
||
public class SsoServerController {
|
||
|
||
/*
|
||
* SSO-Server端：处理所有SSO相关请求 (下面的章节我们会详细列出开放的接口)
|
||
*/
|
||
@RequestMapping("/sso/*")
|
||
public Object ssoRequest() {
|
||
return SaSsoProcessor.instance.serverDister();
|
||
}
|
||
|
||
/**
|
||
* 配置SSO相关参数
|
||
*/
|
||
@Autowired
|
||
private void configSso(SaSsoConfig sso) {
|
||
// 配置：未登录时返回的View
|
||
sso.setNotLoginView(() -> {
|
||
String msg = "当前会话在SSO-Server端尚未登录，请先访问"
|
||
+ "<a href='/sso/doLogin?name=sa&pwd=123456' target='_blank'> doLogin登录 </a>"
|
||
+ "进行登录之后，刷新页面开始授权";
|
||
return msg;
|
||
});
|
||
|
||
// 配置：登录处理函数
|
||
sso.setDoLoginHandle((name, pwd) -> {
|
||
// 此处仅做模拟登录，真实环境应该查询数据进行登录
|
||
if("sa".equals(name) && "123456".equals(pwd)) {
|
||
StpUtil.login(10001);
|
||
return SaResult.ok("登录成功！").setData(StpUtil.getTokenValue());
|
||
}
|
||
return SaResult.error("登录失败！");
|
||
});
|
||
|
||
// 配置 Http 请求处理器 （在模式三的单点注销功能下用到，如不需要可以注释掉）
|
||
sso.setSendHttp(url -> {
|
||
try {
|
||
// 发起 http 请求
|
||
System.out.println("------ 发起请求：" + url);
|
||
return Forest.get(url).executeAsString();
|
||
} catch (Exception e) {
|
||
e.printStackTrace();
|
||
return null;
|
||
}
|
||
});
|
||
}
|
||
|
||
}
|
||
```
|
||
|
||
注意：
|
||
- 在`setDoLoginHandle`函数里如果要获取name, pwd以外的参数，可通过`SaHolder.getRequest().getParam("xxx")`来获取
|
||
- 在 `setSendHttp` 函数中，使用 `try-catch` 是为了提高整个注销流程的容错性，避免在一些极端情况下注销失败（例如：某个 Client 端上线之后又下线，导致 http 请求无法调用成功，从而阻断了整个注销流程）
|
||
|
||
全局异常处理：
|
||
``` java
|
||
@RestControllerAdvice
|
||
public class GlobalExceptionHandler {
|
||
// 全局异常拦截
|
||
@ExceptionHandler
|
||
public SaResult handlerException(Exception e) {
|
||
e.printStackTrace();
|
||
return SaResult.error(e.getMessage());
|
||
}
|
||
}
|
||
```
|
||
|
||
|
||
### 3、application.yml配置
|
||
|
||
<!---------------------------- tabs:start ---------------------------->
|
||
|
||
<!------------- tab:yaml 风格 ------------->
|
||
``` yml
|
||
# 端口
|
||
server:
|
||
port: 9000
|
||
|
||
# Sa-Token 配置
|
||
sa-token:
|
||
# ------- SSO-模式一相关配置 (非模式一不需要配置)
|
||
# cookie:
|
||
# 配置 Cookie 作用域
|
||
# domain: stp.com
|
||
|
||
# ------- SSO-模式二相关配置
|
||
sso:
|
||
# Ticket有效期 (单位: 秒)，默认五分钟
|
||
ticket-timeout: 300
|
||
# 所有允许的授权回调地址
|
||
allow-url: "*"
|
||
|
||
# ------- SSO-模式三相关配置 （下面的配置在使用SSO模式三时打开）
|
||
# 是否打开模式三
|
||
is-http: true
|
||
sign:
|
||
# API 接口调用秘钥
|
||
secret-key: kQwIOrYvnXmSDkwEiFngrKidMcdrgKor
|
||
# ---- 除了以上配置项，你还需要为 Sa-Token 配置http请求处理器（文档有步骤说明）
|
||
|
||
spring:
|
||
# Redis配置 （SSO模式一和模式二使用Redis来同步会话）
|
||
redis:
|
||
# Redis数据库索引（默认为0）
|
||
database: 1
|
||
# Redis服务器地址
|
||
host: 127.0.0.1
|
||
# Redis服务器连接端口
|
||
port: 6379
|
||
# Redis服务器连接密码（默认为空）
|
||
password:
|
||
|
||
forest:
|
||
# 关闭 forest 请求日志打印
|
||
log-enabled: false
|
||
```
|
||
<!------------- tab:properties 风格 ------------->
|
||
``` properties
|
||
# 端口
|
||
server.port=9000
|
||
|
||
################## Sa-Token 配置 ##################
|
||
# ------- SSO-模式一相关配置 (非模式一不需要配置)
|
||
# 配置 Cookie 作用域
|
||
# sa-token.cookie.domain=stp.com
|
||
|
||
# ------- SSO-模式二相关配置
|
||
# Ticket有效期 (单位: 秒)，默认五分钟
|
||
sa-token.sso.ticket-timeout=300
|
||
# 所有允许的授权回调地址
|
||
sa-token.sso.allow-url=*
|
||
|
||
# ------- SSO-模式三相关配置 （下面的配置在使用SSO模式三时打开）
|
||
# 是否打开模式三
|
||
sa-token.sso.is-http=true
|
||
# API 接口调用秘钥
|
||
sa-token.sign.secret-key=kQwIOrYvnXmSDkwEiFngrKidMcdrgKor
|
||
|
||
# ---- 除了以上配置项，你还需要为 Sa-Token 配置http请求处理器（文档有步骤说明）
|
||
|
||
################## Redis配置 （SSO模式一和模式二使用Redis来同步会话） ##################
|
||
# Redis数据库索引（默认为0）
|
||
spring.redis.database=1
|
||
# Redis服务器地址
|
||
spring.redis.host=127.0.0.1
|
||
# Redis服务器连接端口
|
||
spring.redis.port=6379
|
||
# Redis服务器连接密码（默认为空）
|
||
spring.redis.password=
|
||
|
||
# 关闭 forest 请求日志打印
|
||
forest.log-enabled: false
|
||
```
|
||
|
||
<!---------------------------- tabs:end ---------------------------->
|
||
|
||
注意点：`sa-token.sso.allow-url`为了方便测试配置为`*`，线上生产环境一定要配置为详细URL地址 （之后的章节我们会详细阐述此配置项）
|
||
|
||
|
||
### 4、创建启动类
|
||
``` java
|
||
@SpringBootApplication
|
||
public class SaSsoServerApplication {
|
||
public static void main(String[] args) {
|
||
SpringApplication.run(SaSsoServerApplication.class, args);
|
||
System.out.println("\n------ Sa-Token-SSO 认证中心启动成功");
|
||
}
|
||
}
|
||
```
|
||
|
||
启动项目，不出意外的情况下我们将看到如下输出：
|
||
|
||
|
||
|
||
访问统一授权地址：
|
||
- [http://localhost:9000/sso/auth](http://localhost:9000/sso/auth)
|
||
|
||
|
||
|
||
可以看到这个页面目前非常简陋，这是因为我们以上的代码示例，主要目标是为了带大家从零搭建一个可用的SSO认证服务端，所以就对一些不太必要的步骤做了简化。
|
||
|
||
大家可以下载运行一下官方仓库里的示例`/sa-token-demo/sa-token-demo-sso-server/`，里面有制作好的登录页面：
|
||
|
||
|
||
|
||
默认账号密码为：`sa / 123456`，先别着急点击登录，因为我们还没有搭建对应的 Client 端项目，
|
||
真实项目中我们是不会直接从浏览器访问 `/sso/auth` 授权地址的，我们需要在 Client 端点击登录按钮重定向而来。
|
||
|
||
|
||
---
|
||
|
||
现在我们先来看看除了 `/sso/auth` 统一授权地址，这个 SSO-Server 认证中心还开放了哪些API：[SSO-Server 认证中心开放接口](/sso/sso-apidoc)。
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|