sa-token/sa-token-doc/sso/sso-custom-api.md

127 lines
3.1 KiB
Markdown
Raw Normal View History

# SSO整合-自定义 API 路由
---
### 方式一:修改全局变量
在之前的章节中我们演示了如何搭建一个SSO认证中心
``` java
/**
* Sa-Token-SSO Server端 Controller
*/
@RestController
public class SsoServerController {
// SSO-Server端处理所有SSO相关请求
@RequestMapping("/sso/*")
public Object ssoRequest() {
2024-05-01 11:33:17 +08:00
return SaSsoServerProcessor.instance.dister();
}
// ... 其它代码
}
```
这种写法集成简单但却不够灵活。例如认证中心地址只能是:`http://{host}:{port}/sso/auth`如果我们想要自定义其API地址应该怎么做呢
打开SSO模块相关源码有关 API 的设计都定义在:
[ApiName.java](https://gitee.com/dromara/sa-token/blob/master/sa-token-plugin/sa-token-sso/src/main/java/cn/dev33/satoken/sso/name/ApiName.java)
中,我们可以对其进行二次修改。
例如,我们可以在 Main 方法启动类或者 SSO 配置方法中修改变量值:
``` java
// 配置SSO相关参数
@Autowired
2025-05-08 20:52:52 +08:00
private void configSso(SaSsoServerTemplate ssoServerTemplate) {
// 自定义API地址
2024-05-01 11:33:17 +08:00
SaSsoServerProcessor.instance.ssoServerTemplate.apiName.ssoAuth = "/sso/auth2";
// ...
}
```
启动项目,统一认证地址就被我们修改成了:`http://{host}:{port}/sso/auth2`
### 方式二:拆分路由入口
根据上述路由入口:`@RequestMapping("/sso/*")`,我们给它起一个合适的名字 —— 聚合式路由。
与之对应的,我们可以将其修改为拆分式路由:
``` java
/**
* Sa-Token-SSO Server端 Controller
*/
@RestController
public class SsoServerController {
// SSO-Server统一认证地址
@RequestMapping("/sso/auth")
public Object ssoAuth() {
2024-05-01 11:33:17 +08:00
return SaSsoServerProcessor.instance.ssoAuth();
}
// SSO-ServerRestAPI 登录接口
@RequestMapping("/sso/doLogin")
public Object ssoDoLogin() {
2024-05-01 11:33:17 +08:00
return SaSsoServerProcessor.instance.ssoDoLogin();
}
2025-05-08 20:52:52 +08:00
// SSO-Server接收推送消息地址
@RequestMapping("/sso/pushS")
public Object ssoPushS() {
return SaSsoServerProcessor.instance.ssoPushS();
}
// SSO-Server单点注销
@RequestMapping("/sso/signout")
public Object ssoSignout() {
2024-05-01 11:33:17 +08:00
return SaSsoServerProcessor.instance.ssoSignout();
}
// ... 其它方法
}
```
拆分式路由 与 聚合式路由 在功能上完全等价,且提供了更为细致的路由管控。
2025-05-08 20:52:52 +08:00
### SSO-Client 端拆分路由入口示例
``` java
/**
* Sa-Token-SSO Client端 Controller
*/
@RestController
public class SsoClientController {
// SSO-Client登录地址
@RequestMapping("/sso/login")
public Object ssoLogin() {
return SaSsoClientProcessor.instance.ssoLogin();
}
// SSO-Client单点注销地址
@RequestMapping("/sso/logout")
public Object ssoLogout() {
return SaSsoClientProcessor.instance.ssoLogout();
}
// SSO-Client单点注销回调
@RequestMapping("/sso/logoutCall")
public Object ssoLogoutCall() {
return SaSsoClientProcessor.instance.ssoLogoutCall();
}
// SSO-Client接收消息推送地址
@RequestMapping("/sso/ssoPushC")
public Object ssoPushC() {
return SaSsoClientProcessor.instance.ssoPushC();
}
// ... 其它方法
}
```