b2894lxlx/tms-erp-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

init

Browse Source
This commit is contained in:
kk
2026-07-07 18:05:54 +08:00
commit d4ef46bf97
743 changed files with 159169 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
blade-service-api/blade-authority-api/pom.xml Normal file
View File

@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>blade-service-api</artifactId>
<groupId>org.springblade</groupId>
<version>${revision}</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>blade-authority-api</artifactId>
<name>${project.artifactId}</name>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.springblade</groupId>
<artifactId>blade-core-secure</artifactId>
</dependency>
</dependencies>
</project>

98
blade-service-api/blade-authority-api/src/main/java/org/springblade/system/cache/ApiKeyCache.java vendored Normal file
View File

@@ -0,0 +1,98 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.system.cache;
import org.springblade.core.cache.utils.CacheUtil;
import org.springblade.core.secure.BladeUser;
import org.springblade.core.tool.utils.Func;
import org.springblade.core.tool.utils.SpringUtil;
import org.springblade.system.feign.IApiKeyClient;
import java.util.Objects;
import static org.springblade.core.secure.constant.ApiKeyConstant.*;
/**
* API Key 缓存
*
* @author Chill
*/
public class ApiKeyCache {
private static IApiKeyClient apiKeyClient;
private static IApiKeyClient getApiKeyClient() {
if (apiKeyClient == null) {
apiKeyClient = SpringUtil.getBean(IApiKeyClient.class);
}
return apiKeyClient;
}
/**
* 获取用户信息
*
* @param apiKey API Key
* @return BladeUser
*/
public static BladeUser getUser(String apiKey) {
BladeUser bladeUser = CacheUtil.get(API_KEY_CACHE, CACHE_USER_PREFIX, apiKey, BladeUser.class, Boolean.FALSE);
if (bladeUser != null) {
// 若用户ID为空，说明是缓存的空对象标记，返回null防止缓存穿透
return bladeUser.getUserId() != null ? bladeUser : null;
}
bladeUser = getApiKeyClient().getUser(apiKey);
// 动态缓存用户对象，防止缓存穿透
CacheUtil.put(API_KEY_CACHE, CACHE_USER_PREFIX, apiKey, Objects.requireNonNullElseGet(bladeUser, BladeUser::new), Boolean.FALSE);
return bladeUser;
}
/**
* 获取访问路径权限
*
* @param apiKey API Key
* @return apiPath
*/
public static String getApiPath(String apiKey) {
String apiPath = CacheUtil.get(API_KEY_CACHE, CACHE_PATH_PREFIX, apiKey, String.class, Boolean.FALSE);
if (apiPath == null) {
apiPath = getApiKeyClient().getApiPath(apiKey);
// 动态缓存权限路径，防止缓存穿透
CacheUtil.put(API_KEY_CACHE, CACHE_PATH_PREFIX, apiKey, Func.toStrWithEmpty(apiPath, FULL_PATH), Boolean.FALSE);
}
return apiPath;
}
/**
* 移除缓存
*
* @param apiKey API Key
*/
public static void removeCache(String apiKey) {
CacheUtil.evict(API_KEY_CACHE, CACHE_USER_PREFIX, apiKey, Boolean.FALSE);
CacheUtil.evict(API_KEY_CACHE, CACHE_PATH_PREFIX, apiKey, Boolean.FALSE);
}
}

62
blade-service-api/blade-authority-api/src/main/java/org/springblade/system/config/AuthorityConfiguration.java Normal file
View File

@@ -0,0 +1,62 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.system.config;
import lombok.AllArgsConstructor;
import org.springblade.core.launch.props.BladeProperties;
import org.springblade.core.launch.server.ServerInfo;
import org.springblade.core.secure.config.RegistryConfiguration;
import org.springblade.core.secure.handler.IApiKeyHandler;
import org.springblade.core.secure.handler.IApiKeyLogHandler;
import org.springblade.core.secure.props.KeyProperties;
import org.springblade.system.feign.IApiKeyClient;
import org.springblade.system.handler.ApiKeyHandler;
import org.springblade.system.handler.ApiKeyLogHandler;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* 权限认证配置类
*
* @author Chill
*/
@Configuration(proxyBeanMethods = false)
@AllArgsConstructor
@AutoConfigureBefore(RegistryConfiguration.class)
public class AuthorityConfiguration {
@Bean
public IApiKeyLogHandler apiKeyLogHandler(IApiKeyClient apiKeyClient, BladeProperties bladeProperties, ServerInfo serverInfo) {
return new ApiKeyLogHandler(apiKeyClient, bladeProperties, serverInfo);
}
@Bean
public IApiKeyHandler apiKeyHandler(KeyProperties keyProperties, IApiKeyLogHandler apiKeyLogHandler) {
return new ApiKeyHandler(keyProperties, apiKeyLogHandler);
}
}

80
blade-service-api/blade-authority-api/src/main/java/org/springblade/system/feign/IApiKeyClient.java Normal file
View File

@@ -0,0 +1,80 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.system.feign;
import org.springblade.core.launch.constant.AppConstant;
import org.springblade.core.secure.BladeUser;
import org.springblade.system.pojo.dto.ApiKeyLogDTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
/**
* API Key Feign接口类
*
* @author Chill
*/
@FeignClient(
value = AppConstant.APPLICATION_SYSTEM_NAME,
fallback = IApiKeyClientFallback.class
)
public interface IApiKeyClient {
String API_PREFIX = "/feign/client/api-key";
String GET_USER = API_PREFIX + "/get-user";
String GET_API_PATH = API_PREFIX + "/get-api-path";
String SAVE_LOG = API_PREFIX + "/save-log";
/**
* 通过 API Key 获取用户信息
*
* @param apiKey API Key
* @return BladeUser
*/
@GetMapping(GET_USER)
BladeUser getUser(@RequestParam("apiKey") String apiKey);
/**
* 获取 API Key 的访问路径权限
*
* @param apiKey API Key
* @return apiPath
*/
@GetMapping(GET_API_PATH)
String getApiPath(@RequestParam("apiKey") String apiKey);
/**
* 保存 API Key 调用日志
*
* @param apiKeyLog API Key 调用日志
* @return 影响行数
*/
@PostMapping(SAVE_LOG)
int saveLog(@RequestBody ApiKeyLogDTO apiKeyLog);
}

57
blade-service-api/blade-authority-api/src/main/java/org/springblade/system/feign/IApiKeyClientFallback.java Normal file
View File

@@ -0,0 +1,57 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.system.feign;
import org.springblade.core.secure.BladeUser;
import org.springblade.core.tool.constant.BladeConstant;
import org.springblade.system.pojo.dto.ApiKeyLogDTO;
import org.springframework.stereotype.Component;
/**
* IApiKeyClientFallback
*
* @author Chill
*/
@Component
public class IApiKeyClientFallback implements IApiKeyClient {
@Override
public BladeUser getUser(String apiKey) {
return null;
}
@Override
public String getApiPath(String apiKey) {
return null;
}
@Override
public int saveLog(ApiKeyLogDTO apiKeyLog) {
// 降级不落库
return BladeConstant.DB_STATUS_0;
}
}

130
blade-service-api/blade-authority-api/src/main/java/org/springblade/system/handler/ApiKeyHandler.java Normal file
View File

@@ -0,0 +1,130 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.system.handler;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import org.springblade.core.secure.BladeUser;
import org.springblade.core.secure.KeyCrypto;
import org.springblade.core.secure.handler.IApiKeyHandler;
import org.springblade.core.secure.handler.IApiKeyLogHandler;
import org.springblade.core.secure.props.KeyProperties;
import org.springblade.core.tool.utils.Func;
import org.springblade.core.tool.utils.StringPool;
import org.springblade.core.tool.utils.WebUtil;
import org.springblade.system.cache.ApiKeyCache;
import org.springframework.util.AntPathMatcher;
import org.springframework.util.PathMatcher;
import static org.springblade.core.secure.constant.ApiKeyConstant.DETAIL_API_KEY_ID;
import static org.springblade.core.secure.constant.ApiKeyConstant.FULL_PATH;
/**
* API Key 处理器微服务实现
*
* @author Chill
*/
@RequiredArgsConstructor
public class ApiKeyHandler implements IApiKeyHandler {
/**
* 路径匹配器
*/
private static final PathMatcher PATH_MATCHER = new AntPathMatcher();
private final KeyProperties keyProperties;
private final IApiKeyLogHandler apiKeyLogHandler;
@Override
public BladeUser getUser(String apiKey) {
long startTime = System.currentTimeMillis();
// 检查功能是否启用
if (!keyProperties.getEnabled()) {
return null;
}
// 检查令牌格式是否合法
String parseKey = KeyCrypto.parseKey(apiKey, keyProperties.getCryptoKey());
if (Func.isBlank(parseKey)) {
return null;
}
// 加载用户信息
BladeUser bladeUser = ApiKeyCache.getUser(apiKey);
if (bladeUser == null) {
return null;
}
// 验证访问路径权限
HttpServletRequest request = WebUtil.getRequest();
if (request != null) {
// api_path 按完整路径配置，补全服务前缀后匹配
String requestPath = keyProperties.getPathPrefix().concat(request.getRequestURI());
if (!validateApiPath(apiKey, requestPath)) {
return null;
}
}
// 异步保存 API Key 调用日志
long apiKeyId = Func.toLong(bladeUser.getDetail().get(DETAIL_API_KEY_ID));
if (apiKeyId > 0L) {
long time = System.currentTimeMillis() - startTime;
apiKeyLogHandler.saveLog(bladeUser, apiKeyId, time, request);
}
return bladeUser;
}
@Override
public void removeCache(String apiKey) {
ApiKeyCache.removeCache(apiKey);
}
@Override
public String generateKey() {
return KeyCrypto.generateKey(keyProperties.getCryptoKey());
}
/**
* 验证请求路径是否有访问权限
*
* @param apiKey API Key
* @param requestPath 请求路径
* @return true 有权限，false 无权限
*/
private boolean validateApiPath(String apiKey, String requestPath) {
String apiPath = ApiKeyCache.getApiPath(apiKey);
// 如果未配置访问权限，默认允许所有访问
if (Func.isBlank(apiPath) || FULL_PATH.equals(apiPath)) {
return true;
}
// 解析逗号分隔的路径并匹配
String[] paths = apiPath.split(StringPool.COMMA);
for (String path : paths) {
String trimmedPath = path.trim();
if (Func.isNotBlank(trimmedPath) && PATH_MATCHER.match(trimmedPath, requestPath)) {
return true;
}
}
return false;
}
}

111
blade-service-api/blade-authority-api/src/main/java/org/springblade/system/handler/ApiKeyLogHandler.java Normal file
View File

@@ -0,0 +1,111 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.system.handler;
import jakarta.servlet.http.HttpServletRequest;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springblade.core.launch.props.BladeProperties;
import org.springblade.core.launch.server.ServerInfo;
import org.springblade.core.secure.BladeUser;
import org.springblade.core.secure.handler.IApiKeyLogHandler;
import org.springblade.core.tool.constant.BladeConstant;
import org.springblade.core.tool.support.IdGenerator;
import org.springblade.core.tool.utils.Func;
import org.springblade.core.tool.utils.StringPool;
import org.springblade.core.tool.utils.UrlUtil;
import org.springblade.core.tool.utils.WebUtil;
import org.springblade.system.feign.IApiKeyClient;
import org.springblade.system.pojo.dto.ApiKeyLogDTO;
import org.springframework.lang.Nullable;
import java.util.Date;
import java.util.concurrent.CompletableFuture;
/**
* API Key 调用日志处理器微服务实现。
*
* @author Chill
*/
@Slf4j
@RequiredArgsConstructor
public class ApiKeyLogHandler implements IApiKeyLogHandler {
private final IApiKeyClient apiKeyClient;
private final BladeProperties bladeProperties;
private final ServerInfo serverInfo;
@Override
public void saveLog(BladeUser bladeUser, Long apiKeyId, long time, @Nullable HttpServletRequest request) {
// 主线程采集上下文, 仅远程落库交由异步执行
ApiKeyLogDTO apiKeyLog = buildLog(bladeUser, apiKeyId, time, request);
CompletableFuture.runAsync(() -> {
try {
apiKeyClient.saveLog(apiKeyLog);
} catch (Exception logException) {
log.error("API Key日志保存失败: {}", logException.getMessage());
}
});
}
/**
* 构建 API Key 调用日志
*
* @param bladeUser 认证用户
* @param apiKeyId API Key 主键ID
* @param time 认证耗时(ms)
* @param request 当前请求对象
* @return API Key 调用日志传输对象
*/
private ApiKeyLogDTO buildLog(BladeUser bladeUser, Long apiKeyId, long time, @Nullable HttpServletRequest request) {
ApiKeyLogDTO apiKeyLog = new ApiKeyLogDTO();
apiKeyLog.setId(IdGenerator.getId());
apiKeyLog.setTenantId(Func.toStrWithEmpty(bladeUser.getTenantId(), BladeConstant.ADMIN_TENANT_ID));
apiKeyLog.setServiceId(bladeProperties.getName());
apiKeyLog.setServerIp(serverInfo.getIpWithPort());
apiKeyLog.setServerHost(serverInfo.getHostName());
apiKeyLog.setEnv(bladeProperties.getEnv());
apiKeyLog.setApiKeyId(apiKeyId);
apiKeyLog.setTime(time);
apiKeyLog.setCreateBy(Func.toStrWithEmpty(bladeUser.getAccount(), bladeUser.getUserName()));
apiKeyLog.setCreateTime(new Date());
// 请求信息 (默认空串, 防止匿名/无请求上下文时落库空值)
apiKeyLog.setRequestUri(StringPool.EMPTY);
apiKeyLog.setMethod(StringPool.EMPTY);
apiKeyLog.setRemoteIp(StringPool.EMPTY);
apiKeyLog.setUserAgent(StringPool.EMPTY);
apiKeyLog.setParams(StringPool.EMPTY);
if (request != null) {
apiKeyLog.setRequestUri(UrlUtil.getPath(request.getRequestURI()));
apiKeyLog.setMethod(request.getMethod());
apiKeyLog.setRemoteIp(WebUtil.getIP(request));
apiKeyLog.setUserAgent(Func.toStr(request.getHeader(WebUtil.USER_AGENT_HEADER)));
apiKeyLog.setParams(WebUtil.getRequestContent(request));
}
return apiKeyLog;
}
}

95
blade-service-api/blade-authority-api/src/main/java/org/springblade/system/pojo/dto/ApiKeyLogDTO.java Normal file
View File

@@ -0,0 +1,95 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.system.pojo.dto;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import java.io.Serial;
import java.io.Serializable;
import java.util.Date;
/**
* API Key 调用日志传输对象。
* <p>
* 由认证服务在主请求线程采集调用上下文 (含调用方服务标识与登录态), 经 Feign 远程发往 blade-system 落库,
* 故所有字段在调用端填充, 服务端不依赖其自身上下文。
*
* @author Chill
*/
@Data
@Schema(description = "API Key 调用日志传输对象")
public class ApiKeyLogDTO implements Serializable {
@Serial
private static final long serialVersionUID = 1L;
@Schema(description = "主键")
private Long id;
@Schema(description = "租户ID")
private String tenantId;
@Schema(description = "调用服务名")
private String serviceId;
@Schema(description = "服务器IP")
private String serverIp;
@Schema(description = "服务器主机名")
private String serverHost;
@Schema(description = "环境标识")
private String env;
@Schema(description = "API Key 主键ID")
private Long apiKeyId;
@Schema(description = "请求地址")
private String requestUri;
@Schema(description = "请求方法")
private String method;
@Schema(description = "请求IP")
private String remoteIp;
@Schema(description = "用户代理")
private String userAgent;
@Schema(description = "请求参数")
private String params;
@Schema(description = "认证耗时(ms)")
private Long time;
@Schema(description = "创建人")
private String createBy;
@Schema(description = "创建时间")
private Date createTime;
}

6
blade-service-api/blade-authority-api/src/main/java/org/springblade/system/pojo/vo/package-info.java Normal file
View File

@@ -0,0 +1,6 @@
/**
* Created by Blade.
*
* @author zhuangqian
*/
package org.springblade.system.pojo.vo;