fix：【framework 框架】修改配置会导致 TenantIgnore 注解的 controller 接口过滤失效，https://gitee.com/z…

…hijiantianya/yudao-cloud/issues/ICUQL9

fix：【framework 框架】修改配置会导致 TenantIgnore 注解的 controller 接口过滤失效，https://gitee.com/z…
…hijiantianya/yudao-cloud/issues/ICUQL9
YunaiV
1 parent 040899d8
Showing 2 changed files with 54 additions and 38 deletions
yudao-framework/yudao-spring-boot-starter-biz-tenant/src/main/java/cn/iocoder/yudao/framework/tenant/config/YudaoTenantAutoConfiguration.java
yudao-framework/yudao-spring-boot-starter-biz-tenant/src/main/java/cn/iocoder/yudao/framework/tenant/core/security/TenantSecurityWebFilter.java
@@ -44,8 +44,7 @@ import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
 import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
 import org.springframework.web.util.pattern.PathPattern;
-import java.util.Map;
-import java.util.Objects;
+import java.util.*;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertList;
@@ -84,41 +83,13 @@ public class YudaoTenantAutoConfiguration {
     // ========== WEB ==========
     @Bean
-    public FilterRegistrationBean<TenantContextWebFilter> tenantContextWebFilter(TenantProperties tenantProperties) {
+    public FilterRegistrationBean<TenantContextWebFilter> tenantContextWebFilter() {
         FilterRegistrationBean<TenantContextWebFilter> registrationBean = new FilterRegistrationBean<>();
         registrationBean.setFilter(new TenantContextWebFilter());
         registrationBean.setOrder(WebFilterOrderEnum.TENANT_CONTEXT_FILTER);
-        addIgnoreUrls(tenantProperties);
         return registrationBean;
     }
-    /**
-     * 如果 Controller 接口上，有 {@link TenantIgnore} 注解，那么添加到忽略的 URL 中
-     *
-     * @param tenantProperties 租户配置
-     */
-    private void addIgnoreUrls(TenantProperties tenantProperties) {
-        // 获得接口对应的 HandlerMethod 集合
-        RequestMappingHandlerMapping requestMappingHandlerMapping = (RequestMappingHandlerMapping)
-                applicationContext.getBean("requestMappingHandlerMapping");
-        Map<RequestMappingInfo, HandlerMethod> handlerMethodMap = requestMappingHandlerMapping.getHandlerMethods();
-        // 获得有 @TenantIgnore 注解的接口
-        for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethodMap.entrySet()) {
-            HandlerMethod handlerMethod = entry.getValue();
-            if (!handlerMethod.hasMethodAnnotation(TenantIgnore.class)) {
-                continue;
-            }
-            // 添加到忽略的 URL 中
-            if (entry.getKey().getPatternsCondition() != null) {
-                tenantProperties.getIgnoreUrls().addAll(entry.getKey().getPatternsCondition().getPatterns());
-            }
-            if (entry.getKey().getPathPatternsCondition() != null) {
-                tenantProperties.getIgnoreUrls().addAll(
-                        convertList(entry.getKey().getPathPatternsCondition().getPatterns(), PathPattern::getPatternString));
-            }
-        }
-    }
-
     @Bean
     public TenantVisitContextInterceptor tenantVisitContextInterceptor(TenantProperties tenantProperties,
                                                                        SecurityFrameworkService securityFrameworkService) {
@@ -146,12 +117,41 @@ public class YudaoTenantAutoConfiguration {
                                                                                    GlobalExceptionHandler globalExceptionHandler,
                                                                                    TenantFrameworkService tenantFrameworkService) {
         FilterRegistrationBean<TenantSecurityWebFilter> registrationBean = new FilterRegistrationBean<>();
-        registrationBean.setFilter(new TenantSecurityWebFilter(tenantProperties, webProperties,
+        registrationBean.setFilter(new TenantSecurityWebFilter(webProperties, tenantProperties, getTenantIgnoreUrls(),
                 globalExceptionHandler, tenantFrameworkService));
         registrationBean.setOrder(WebFilterOrderEnum.TENANT_SECURITY_FILTER);
         return registrationBean;
     }
+    /**
+     * 如果 Controller 接口上，有 {@link TenantIgnore} 注解，则添加到忽略租户的 URL 集合中
+     *
+     * @return 忽略租户的 URL 集合
+     */
+    private Set<String> getTenantIgnoreUrls() {
+        Set<String> ignoreUrls = new HashSet<>();
+        // 获得接口对应的 HandlerMethod 集合
+        RequestMappingHandlerMapping requestMappingHandlerMapping = (RequestMappingHandlerMapping)
+                applicationContext.getBean("requestMappingHandlerMapping");
+        Map<RequestMappingInfo, HandlerMethod> handlerMethodMap = requestMappingHandlerMapping.getHandlerMethods();
+        // 获得有 @TenantIgnore 注解的接口
+        for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethodMap.entrySet()) {
+            HandlerMethod handlerMethod = entry.getValue();
+            if (!handlerMethod.hasMethodAnnotation(TenantIgnore.class)) {
+                continue;
+            }
+            // 添加到忽略的 URL 中
+            if (entry.getKey().getPatternsCondition() != null) {
+                ignoreUrls.addAll(entry.getKey().getPatternsCondition().getPatterns());
+            }
+            if (entry.getKey().getPathPatternsCondition() != null) {
+                ignoreUrls.addAll(
+                        convertList(entry.getKey().getPathPatternsCondition().getPatterns(), PathPattern::getPatternString));
+            }
+        }
+        return ignoreUrls;
+    }
+
     // ========== MQ ==========
     @Bean
@@ -12,15 +12,16 @@ import cn.iocoder.yudao.framework.tenant.core.service.TenantFrameworkService;
 import cn.iocoder.yudao.framework.web.config.WebProperties;
 import cn.iocoder.yudao.framework.web.core.filter.ApiRequestFilter;
 import cn.iocoder.yudao.framework.web.core.handler.GlobalExceptionHandler;
-import lombok.extern.slf4j.Slf4j;
-import org.springframework.util.AntPathMatcher;
-
 import jakarta.servlet.FilterChain;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.util.AntPathMatcher;
+
 import java.io.IOException;
 import java.util.Objects;
+import java.util.Set;
 /**
  * 多租户 Security Web 过滤器
@@ -35,17 +36,26 @@ public class TenantSecurityWebFilter extends ApiRequestFilter {
     private final TenantProperties tenantProperties;
+    /**
+     * 允许忽略租户的 URL 列表
+     *
+     * 目的：解决 <a href="https://gitee.com/zhijiantianya/yudao-cloud/issues/ICUQL9">修改配置会导致 @TenantIgnore Controller 接口过滤失效</>
+     */
+    private final Set<String> ignoreUrls;
+
     private final AntPathMatcher pathMatcher;
     private final GlobalExceptionHandler globalExceptionHandler;
     private final TenantFrameworkService tenantFrameworkService;
-    public TenantSecurityWebFilter(TenantProperties tenantProperties,
-                                   WebProperties webProperties,
+    public TenantSecurityWebFilter(WebProperties webProperties,
+                                   TenantProperties tenantProperties,
+                                   Set<String> ignoreUrls,
                                    GlobalExceptionHandler globalExceptionHandler,
                                    TenantFrameworkService tenantFrameworkService) {
         super(webProperties);
         this.tenantProperties = tenantProperties;
+        this.ignoreUrls = ignoreUrls;
         this.pathMatcher = new AntPathMatcher();
         this.globalExceptionHandler = globalExceptionHandler;
         this.tenantFrameworkService = tenantFrameworkService;
@@ -103,7 +113,8 @@ public class TenantSecurityWebFilter extends ApiRequestFilter {
     private boolean isIgnoreUrl(HttpServletRequest request) {
         String apiUri = request.getRequestURI().substring(request.getContextPath().length());
         // 快速匹配，保证性能
-        if (CollUtil.contains(tenantProperties.getIgnoreUrls(), apiUri)) {
+        if (CollUtil.contains(tenantProperties.getIgnoreUrls(), apiUri)
+            || CollUtil.contains(ignoreUrls, apiUri)) {
             return true;
         }
         // 逐个 Ant 路径匹配
@@ -112,6 +123,11 @@ public class TenantSecurityWebFilter extends ApiRequestFilter {
                 return true;
             }
         }
+        for (String url : ignoreUrls) {
+            if (pathMatcher.match(url, apiUri)) {
+                return true;
+            }
+        }
         return false;
     }