若依集成BladeX单点登录的令牌管理与api请求流程

在这里插入图片描述

概述

本文档详细说明若依系统如何实现与BladeX的单点登录集成，包括令牌管理和接口调用的完整流程。整个集成采用基于OAuth2的授权码流程，允许用户通过BladeX账号登录若依系统，并使用BladeX令牌访问BladeX的各类API。

系统架构

整个单点登录与令牌管理系统主要包含以下组件：

前端组件

BladeCallback.vue：处理BladeX认证回调的前端页面
/src/api/blade/apiTest.js：BladeX API封装

后端服务

BladeAuthController：处理BladeX认证回调和token获取
BladeApiController：提供BladeX API代理接口
BladeTokenManager：管理BladeX令牌的存储和检索
BladeApiClient：调用BladeX API的客户端
BladeAuthUtil：提供BladeX认证工具方法

数据存储

Redis：存储BladeX令牌与若依用户ID的映射关系

单点登录流程

详细步骤

发起BladeX授权：用户在登录页点击"使用BladeX登录"按钮，前端将用户重定向到BladeX授权页面。
BladeX认证：用户在BladeX系统中完成登录和授权，BladeX认证服务生成授权码并重定向回若依系统的回调URL。
处理授权回调：
- 前端：BladeCallback.vue组件接收授权码，并调用后端接口
- 后端：BladeAuthController.getTokenInfo方法处理授权码
获取BladeX令牌：
- BladeAuthUtil.getTokenByCode方法向BladeX认证服务发送请求，交换授权码获取访问令牌
- 解析响应，获取访问令牌、过期时间、用户信息等
查找对应若依用户：
- 根据BladeX返回的用户名(account)或username在若依系统中查找对应用户
- 如未找到匹配用户，返回错误信息
创建若依登录会话：
- 使用与原生登录完全相同的流程创建LoginUser对象
- 记录登录IP和时间
- 使用TokenService生成若依系统的JWT令牌
- 保存登录状态到Redis
保存BladeX令牌：
- 使用BladeTokenManager将BladeX访问令牌存入Redis
- 将令牌与若依用户ID建立映射关系
- 设置与BladeX令牌相同的过期时间
返回登录结果：
- 前端接收若依JWT令牌并保存
- 获取用户信息和路由
- 跳转到系统首页

令牌管理机制

BladeX令牌的管理由BladeTokenManager类负责，主要功能包括：

令牌保存：
- 将BladeX令牌信息封装为BladeToken对象存储在Redis中
- 使用"blade_tokens:userId"作为Redis键名
- 设置与BladeX原始令牌相同的过期时间
令牌获取：
- 通过用户ID快速检索对应的BladeX令牌
- 提供访问令牌（access_token）的便捷获取方法
令牌验证：
- 检查用户是否拥有有效的BladeX令牌
- 令牌自动随Redis过期机制失效
令牌删除：
- 在用户登出或手动清除令牌时删除Redis中的对应记录

令牌数据结构

BladeToken类包含以下字段：

userId：若依系统用户ID
userName：用户名
accessToken：BladeX访问令牌
loginTime：令牌获取时间（毫秒时间戳）
expireTime：令牌过期时间（毫秒时间戳）

接口调用流程

详细步骤

前端发起请求：
- 前端调用若依系统API，例如/blade/api/getUserInfo
获取BladeX令牌：
- BladeApiController从SecurityUtils获取当前登录用户ID
- 调用BladeTokenManager.getAccessToken(userId)获取令牌
构建API请求：
- BladeApiClient负责构建请求并添加必要的请求头
- 添加"Blade-Auth: bearer {accessToken}"头
- 添加Basic认证头用于API身份验证
发送API请求：
- 使用RestTemplate发送HTTP请求到BladeX API
- 处理各类响应和异常
错误处理：
- 当遇到401未授权响应时，识别为令牌过期
- 提示用户令牌已过期，需要重新登录

关键代码实现

保存BladeX令牌

// BladeAuthController.java
String accessToken = (String) tokenInfo.get("access_token");
Integer expiresIn = (Integer) tokenInfo.get("expires_in");
if (accessToken != null && expiresIn != null) {bladeTokenManager.setBladeToken(user.getUserId(), user.getUserName(), accessToken, expiresIn);log.info("成功保存用户BladeX令牌, userId={}, expiresIn={}秒", user.getUserId(), expiresIn);
}

令牌保存实现

// BladeTokenManager.java
public void setBladeToken(Long userId, String userName, String accessToken, int expiresIn) {BladeToken bladeToken = new BladeToken();bladeToken.setUserId(userId);bladeToken.setUserName(userName);bladeToken.setAccessToken(accessToken);bladeToken.setLoginTime(System.currentTimeMillis());bladeToken.setExpireTime(bladeToken.getLoginTime() + expiresIn * 1000L);// 存储到Redis，过期时间设置为令牌有效期String tokenKey = getTokenKey(userId);redisCache.setCacheObject(tokenKey, bladeToken, expiresIn, TimeUnit.SECONDS);
}

API调用示例

// BladeApiClient.java
public <T> T callBladeApi(Long userId, String url, HttpMethod method, Object requestBody, Class<T> responseType) {// 获取用户的访问令牌String accessToken = tokenManager.getAccessToken(userId);if (StringUtils.isEmpty(accessToken)) {throw new ServiceException("用户没有有效的BladeX访问令牌，请重新登录");}// 构建请求头HttpHeaders headers = new HttpHeaders();headers.set("Blade-Auth", "bearer " + accessToken);headers.set("Blade-Requested-With", "BladeHttpRequest");// 添加Basic认证String auth = clientId + ":" + clientSecret;byte[] encodedAuth = Base64.getEncoder().encode(auth.getBytes());String authHeader = "Basic " + new String(encodedAuth);headers.set("Authorization", authHeader);// 构建请求实体HttpEntity<?> requestEntity = new HttpEntity<>(requestBody, headers);// 发送请求并返回结果ResponseEntity<T> response = restTemplate.exchange(url, method, requestEntity, responseType);return response.getBody();
}

数据结构

配置参数

在application.yml中配置BladeX相关参数：

blade:auth:# BladeX认证服务地址url: https://auth.we-safer.net/oauth/token# 客户端IDclient-id: chem_ruoyi# 客户端密钥client-secret: chem_ruoyi_secret# 重定向URIredirect-uri: http://192.168.100.106:81/auth/blade-callbackapi:# BladeX API基础地址base-url: https://we-safer.net/api