清理多租户

2026-03-12 19:45:27 +08:00
parent f0649cb888
commit 8cef3227f3
40 changed files with 123 additions and 753 deletions
--- a/rdms-framework/rdms-spring-boot-starter-web/src/main/java/com/njcn/rdms/framework/swagger/config/RdmsSwaggerAutoConfiguration.java
+++ b/rdms-framework/rdms-spring-boot-starter-web/src/main/java/com/njcn/rdms/framework/swagger/config/RdmsSwaggerAutoConfiguration.java
@@ -6,7 +6,6 @@ import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Contact;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.info.License;
-import io.swagger.v3.oas.models.media.IntegerSchema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.security.SecurityRequirement;
@@ -34,42 +33,24 @@ import java.util.List;
 import java.util.Map;
 import java.util.Optional;

-import static com.njcn.rdms.framework.web.core.util.WebFrameworkUtils.HEADER_TENANT_ID;
-
-/**
- * Swagger 自动配置类，基于 OpenAPI + Springdoc 实现。
- *
- * 友情提示：
- * 1. Springdoc 文档地址：<a href="https://github.com/springdoc/springdoc-openapi">仓库</a>
- * 2. Swagger 规范，于 2015 更名为 OpenAPI 规范，本质是一个东西
- *
- * @author hongawen
- */
-@AutoConfiguration(before = Knife4jAutoConfiguration.class) // before 原因，保证覆写的 Knife4jOpenApiCustomizer 先生效！相关 https://github.com/YunaiV/ruoyi-vue-pro/issues/954 讨论
+@AutoConfiguration(before = Knife4jAutoConfiguration.class)
@ConditionalOnClass({OpenAPI.class})
@EnableConfigurationProperties(SwaggerProperties.class)
-@ConditionalOnProperty(prefix = "springdoc.api-docs", name = "enabled", havingValue = "true", matchIfMissing = true) // 设置为 false 时，禁用
+@ConditionalOnProperty(prefix = "springdoc.api-docs", name = "enabled", havingValue = "true", matchIfMissing = true)
@Import(Knife4jOpenApiCustomizer.class)
 public class RdmsSwaggerAutoConfiguration {

-    // ========== 全局 OpenAPI 配置 ==========
-
    @Bean
    public OpenAPI createApi(SwaggerProperties properties) {
        Map<String, SecurityScheme> securitySchemas = buildSecuritySchemes();
        OpenAPI openAPI = new OpenAPI()
-                // 接口信息
                .info(buildInfo(properties))
-                // 接口安全配置
                .components(new Components().securitySchemes(securitySchemas))
                .addSecurityItem(new SecurityRequirement().addList(HttpHeaders.AUTHORIZATION));
        securitySchemas.keySet().forEach(key -> openAPI.addSecurityItem(new SecurityRequirement().addList(key)));
        return openAPI;
    }

-    /**
-     * API 摘要信息
-     */
    private Info buildInfo(SwaggerProperties properties) {
        return new Info()
                .title(properties.getTitle())
@@ -79,24 +60,18 @@ public class RdmsSwaggerAutoConfiguration {
                .license(new License().name(properties.getLicense()).url(properties.getLicenseUrl()));
    }

-    /**
-     * 安全模式，这里配置通过请求头 Authorization 传递 token 参数
-     */
    private Map<String, SecurityScheme> buildSecuritySchemes() {
        Map<String, SecurityScheme> securitySchemes = new HashMap<>();
        SecurityScheme securityScheme = new SecurityScheme()
-                .type(SecurityScheme.Type.APIKEY) // 类型
-                .name(HttpHeaders.AUTHORIZATION) // 请求头的 name
-                .in(SecurityScheme.In.HEADER); // token 所在位置
+                .type(SecurityScheme.Type.APIKEY)
+                .name(HttpHeaders.AUTHORIZATION)
+                .in(SecurityScheme.In.HEADER);
        securitySchemes.put(HttpHeaders.AUTHORIZATION, securityScheme);
        return securitySchemes;
    }

-    /**
-     * 自定义 OpenAPI 处理器
-     */
    @Bean
-    @Primary // 目的：以我们创建的 OpenAPIService Bean 为主，避免一键改包后，启动报错！
+    @Primary
    public OpenAPIService openApiBuilder(Optional<OpenAPI> openAPI,
                                         SecurityService securityParser,
                                         SpringDocConfigProperties springDocConfigProperties,
@@ -108,11 +83,6 @@ public class RdmsSwaggerAutoConfiguration {
                propertyResolverUtils, openApiBuilderCustomizers, serverBaseUrlCustomizers, javadocProvider);
    }

-    // ========== 分组 OpenAPI 配置 ==========
-
-    /**
-     * 所有模块的 API 分组
-     */
    @Bean
    public GroupedOpenApi allGroupedOpenApi() {
        return buildGroupedOpenApi("all", "");
@@ -127,60 +97,29 @@ public class RdmsSwaggerAutoConfiguration {
                .group(group)
                .pathsToMatch("/admin-api/" + path + "/**", "/app-api/" + path + "/**")
                .addOperationCustomizer((operation, handlerMethod) -> operation
-                        .addParametersItem(buildTenantHeaderParameter())
                        .addParametersItem(buildSecurityHeaderParameter()))
                .addOperationCustomizer(buildOperationIdCustomizer())
                .build();
    }

-    /**
-     * 构建 Tenant 租户编号请求头参数
-     *
-     * @return 多租户参数
-     */
-    private static Parameter buildTenantHeaderParameter() {
-        return new Parameter()
-                .name(HEADER_TENANT_ID) // header 名
-                .description("租户编号") // 描述
-                .in(String.valueOf(SecurityScheme.In.HEADER)) // 请求 header
-                .schema(new IntegerSchema()._default(1L).name(HEADER_TENANT_ID).description("租户编号")); // 默认：使用租户编号为 1
-    }
-
-    /**
-     * 构建 Authorization 认证请求头参数
-     *
-     * 解决 Knife4j <a href="https://gitee.com/xiaoym/knife4j/issues/I69QBU">Authorize 未生效，请求header里未包含参数</a>
-     *
-     * @return 认证参数
-     */
    private static Parameter buildSecurityHeaderParameter() {
        return new Parameter()
-                .name(HttpHeaders.AUTHORIZATION) // header 名
-                .description("认证 Token") // 描述
-                .in(String.valueOf(SecurityScheme.In.HEADER)) // 请求 header
-                .schema(new StringSchema()._default("Bearer test1").name(HEADER_TENANT_ID).description("认证 Token")); // 默认：使用用户编号为 1
+                .name(HttpHeaders.AUTHORIZATION)
+                .description("认证 Token")
+                .in(String.valueOf(SecurityScheme.In.HEADER))
+                .schema(new StringSchema()._default("Bearer test1")
+                        .name(HttpHeaders.AUTHORIZATION)
+                        .description("认证 Token"));
    }

-    /**
-     * 核心：自定义OperationId生成规则，组合「类名前缀 + 方法名」
-     *
-     * @see <a href="https://github.com/YunaiV/ruoyi-vue-pro/issues/957">app-api 前缀不生效，都是使用 admin-api</a>
-     */
    private static OperationCustomizer buildOperationIdCustomizer() {
        return (operation, handlerMethod) -> {
-            // 1. 获取控制器类名（如 UserController）
            String className = handlerMethod.getBeanType().getSimpleName();
-            // 2. 提取类名前缀（去除 Controller 后缀，如 UserController -> User）
            String classPrefix = className.replaceAll("Controller$", "");
-            // 3. 获取方法名（如 list）
            String methodName = handlerMethod.getMethod().getName();
-            // 4. 组合生成 operationId（如 User_list）
-            String operationId = classPrefix + "_" + methodName;
-            // 5. 设置自定义 operationId
-            operation.setOperationId(operationId);
+            operation.setOperationId(classPrefix + "_" + methodName);
            return operation;
        };
    }

 }
-
--- a/rdms-framework/rdms-spring-boot-starter-web/src/main/java/com/njcn/rdms/framework/web/core/util/WebFrameworkUtils.java
+++ b/rdms-framework/rdms-spring-boot-starter-web/src/main/java/com/njcn/rdms/framework/web/core/util/WebFrameworkUtils.java
@@ -12,26 +12,12 @@ import org.springframework.web.context.request.RequestAttributes;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;

-/**
- * 专属于 web 包的工具类
- *
- * @author hongawen
- */
 public class WebFrameworkUtils {

    private static final String REQUEST_ATTRIBUTE_LOGIN_USER_ID = "login_user_id";
    private static final String REQUEST_ATTRIBUTE_LOGIN_USER_TYPE = "login_user_type";
-
    private static final String REQUEST_ATTRIBUTE_COMMON_RESULT = "common_result";

-    public static final String HEADER_TENANT_ID = "tenant-id";
-    public static final String HEADER_VISIT_TENANT_ID = "visit-tenant-id";
-
-    /**
-     * 终端的 Header
-     *
-     * @see TerminalEnum
-     */
    public static final String HEADER_TERMINAL = "terminal";

    private static WebProperties properties;
@@ -40,51 +26,14 @@ public class WebFrameworkUtils {
        WebFrameworkUtils.properties = webProperties;
    }

-    /**
-     * 获得租户编号，从 header 中
-     * 考虑到其它 framework 组件也会使用到租户编号，所以不得不放在 WebFrameworkUtils 统一提供
-     *
-     * @param request 请求
-     * @return 租户编号
-     */
-    public static Long getTenantId(HttpServletRequest request) {
-        String tenantId = request.getHeader(HEADER_TENANT_ID);
-        return NumberUtil.isNumber(tenantId) ? Long.valueOf(tenantId) : null;
-    }
-
-    /**
-     * 获得访问的租户编号，从 header 中
-     * 考虑到其它 framework 组件也会使用到租户编号，所以不得不放在 WebFrameworkUtils 统一提供
-     *
-     * @param request 请求
-     * @return 租户编号
-     */
-    public static Long getVisitTenantId(HttpServletRequest request) {
-        String tenantId = request.getHeader(HEADER_VISIT_TENANT_ID);
-        return NumberUtil.isNumber(tenantId)? Long.valueOf(tenantId) : null;
-    }
-
    public static void setLoginUserId(ServletRequest request, Long userId) {
        request.setAttribute(REQUEST_ATTRIBUTE_LOGIN_USER_ID, userId);
    }

-    /**
-     * 设置用户类型
-     *
-     * @param request 请求
-     * @param userType 用户类型
-     */
    public static void setLoginUserType(ServletRequest request, Integer userType) {
        request.setAttribute(REQUEST_ATTRIBUTE_LOGIN_USER_TYPE, userType);
    }

-    /**
-     * 获得当前用户的编号，从请求中
-     * 注意：该方法仅限于 framework 框架使用！！！
-     *
-     * @param request 请求
-     * @return 用户编号
-     */
    public static Long getLoginUserId(HttpServletRequest request) {
        if (request == null) {
            return null;
@@ -92,23 +41,14 @@ public class WebFrameworkUtils {
        return (Long) request.getAttribute(REQUEST_ATTRIBUTE_LOGIN_USER_ID);
    }

-    /**
-     * 获得当前用户的类型
-     * 注意：该方法仅限于 web 相关的 framework 组件使用！！！
-     *
-     * @param request 请求
-     * @return 用户编号
-     */
    public static Integer getLoginUserType(HttpServletRequest request) {
        if (request == null) {
            return null;
        }
-        // 1. 优先，从 Attribute 中获取
        Integer userType = (Integer) request.getAttribute(REQUEST_ATTRIBUTE_LOGIN_USER_TYPE);
        if (userType != null) {
            return userType;
        }
-        // 2. 其次，基于 URL 前缀的约定
        if (request.getServletPath().startsWith(properties.getAdminApi().getPrefix())) {
            return UserTypeEnum.ADMIN.getValue();
        }
@@ -119,13 +59,11 @@ public class WebFrameworkUtils {
    }

    public static Integer getLoginUserType() {
-        HttpServletRequest request = getRequest();
-        return getLoginUserType(request);
+        return getLoginUserType(getRequest());
    }

    public static Long getLoginUserId() {
-        HttpServletRequest request = getRequest();
-        return getLoginUserId(request);
+        return getLoginUserId(getRequest());
    }

    public static Integer getTerminal() {
@@ -155,24 +93,10 @@ public class WebFrameworkUtils {
        return servletRequestAttributes.getRequest();
    }

-    /**
-     * 判断是否为 RPC 请求
-     *
-     * @param request 请求
-     * @return 是否为 RPC 请求
-     */
    public static boolean isRpcRequest(HttpServletRequest request) {
        return request.getRequestURI().startsWith(RpcConstants.RPC_API_PREFIX);
    }

-    /**
-     * 判断是否为 RPC 请求
-     *
-     * 约定大于配置，只要以 Api 结尾，都认为是 RPC 接口
-     *
-     * @param className 类名
-     * @return 是否为 RPC 请求
-     */
    public static boolean isRpcRequest(String className) {
        return className.endsWith("Api");
    }