增加循环依赖检测. 支持非连通依赖图的循环依赖检测

Author: lvyahui8

spring-boot-data-aggregator-autoconfigure/src/main/java/io/github/lvyahui8/spring/autoconfigure/BeanAggregateAutoConfiguration.java

@@ -6,6 +6,7 @@
 import io.github.lvyahui8.spring.aggregate.interceptor.AggregateQueryInterceptor;
 import io.github.lvyahui8.spring.aggregate.interceptor.AggregateQueryInterceptorChain;
 import io.github.lvyahui8.spring.aggregate.interceptor.impl.AggregateQueryInterceptorChainImpl;
+import io.github.lvyahui8.spring.aggregate.model.DataConsumeDefinition;
 import io.github.lvyahui8.spring.aggregate.model.DataProvideDefinition;
 import io.github.lvyahui8.spring.aggregate.repository.DataProviderRepository;
 import io.github.lvyahui8.spring.aggregate.repository.impl.DataProviderRepositoryImpl;
@@ -14,6 +15,7 @@
 import io.github.lvyahui8.spring.aggregate.util.DefinitionUtils;
 import io.github.lvyahui8.spring.annotation.DataProvider;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
 import org.reflections.Reflections;
 import org.reflections.scanners.MethodAnnotationsScanner;
 import org.springframework.beans.BeansException;
@@ -30,7 +32,6 @@
 import org.springframework.core.annotation.Order;
 import org.springframework.scheduling.concurrent.CustomizableThreadFactory;
 import org.springframework.util.Assert;
-import org.springframework.util.StringUtils;
 
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
@@ -39,6 +40,7 @@
 import java.util.concurrent.LinkedBlockingDeque;
 import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
 
 /**
  * @author lvyahui ([email protected],[email protected])
@@ -65,11 +67,44 @@ public DataBeanAggregateQueryFacade dataBeanAggregateQueryFacade(
         return new DataBeanAggregateQueryFacadeImpl(dataBeanAggregateQueryService(dataProviderRepository));
     }
 
+    private void checkCycle(Map<String,Set<String>> graphAdjMap) {
+        Map<String,Integer> visitStatusMap = new HashMap<>(graphAdjMap.size() * 2);
+        Stack<String> stack = new Stack<>();
+        for (Map.Entry<String, Set<String>> item : graphAdjMap.entrySet()) {
+            if (visitStatusMap.containsKey(item.getKey())) {
+                continue;
+            }
+            dfs(graphAdjMap,visitStatusMap,item.getKey());
+        }
+    }
+
+    private void dfs(Map<String,Set<String>> graphAdjMap,Map<String,Integer> visitStatusMap, String node) {
+        if (visitStatusMap.containsKey(node)) {
+            if(visitStatusMap.get(node) == 1) {
+                List<String> relatedNodes = new ArrayList<>();
+                for (Map.Entry<String,Integer> item : visitStatusMap.entrySet()) {
+                    if (item.getValue() == 1) {
+                        relatedNodes.add(item.getKey());
+                    }
+                }
+                throw new IllegalStateException("There are loops in the dependency graph. Related nodes:" + StringUtils.join(relatedNodes));
+            }
+            return ;
+        }
+        visitStatusMap.put(node,1);
+        log.info("visited:{}", node);
+        for (String relateNode : graphAdjMap.get(node)) {
+            dfs(graphAdjMap,visitStatusMap,relateNode);
+        }
+        visitStatusMap.put(node,2);
+    }
+
     @Bean
     @ConditionalOnMissingBean
     public DataBeanAggregateQueryService dataBeanAggregateQueryService (
             @Qualifier("dataProviderRepository") DataProviderRepository dataProviderRepository) {
         if(properties.getBasePackages() != null) {
+            Map<String,Set<String>> provideDependMap = new HashMap<>();
             for (String basePackage : properties.getBasePackages()) {
                 Reflections reflections = new Reflections(basePackage, new MethodAnnotationsScanner());
                 Set<Method> providerMethods = reflections.getMethodsAnnotatedWith(DataProvider.class);
@@ -80,13 +115,18 @@ public DataBeanAggregateQueryService dataBeanAggregateQueryService (
                     Assert.isTrue(Modifier.isPublic(method.getModifiers()),"data provider method must be public");
                     Assert.isTrue(! StringUtils.isEmpty(dataId),"data id must be not null!");
                     DataProvideDefinition provider = DefinitionUtils.getProvideDefinition(method);
+
                     provider.setId(dataId);
                     provider.setIdempotent(beanProvider.idempotent());
                     provider.setTimeout(beanProvider.timeout() > 0 ? beanProvider.timeout() : properties.getDefaultTimeout());
+                    Assert.isTrue(! dataProviderRepository.contains(dataId), "Data providers with the same name are not allowed. dataId: " + dataId);
+                    provideDependMap.put(dataId,provider.getDepends().stream().map(DataConsumeDefinition::getId).collect(Collectors.toSet()));
                     dataProviderRepository.put(provider);
                 }
             }
+            checkCycle(provideDependMap);
         }
+
         DataBeanAggregateQueryServiceImpl service = new DataBeanAggregateQueryServiceImpl();
         RuntimeSettings runtimeSettings = new RuntimeSettings();
         runtimeSettings.setEnableLogging(properties.getEnableLogging() != null

spring-boot-data-aggregator-example/src/main/java/io/github/lvyahui8/spring/example/service/CategoryService.java

@@ -14,4 +14,8 @@ public interface CategoryService {
     String getCategoryTitle(Category category, List<String> topCategoryNames);
 
     List<String> getTopCategoryNames();
+
+    Object cycleDependA(Object dependB);
+
+    Object cycleDependB(Object dependA);
 }

spring-boot-data-aggregator-example/src/main/java/io/github/lvyahui8/spring/example/service/impl/CategoryServiceImpl.java

@@ -49,4 +49,17 @@ public List<String> getTopCategoryNames() {
         return Stream.of("feego", "figo", "sam").map(item -> item+r.nextInt(1000))
                 .collect(Collectors.toList());
     }
+
+
+    /// @DataProvider("cycleDependA")
+    @Override
+    public Object cycleDependA(@DataConsumer("cycleDependB") Object dependB) {
+        return null;
+    }
+
+    /// @DataProvider("cycleDependB")
+    @Override
+    public Object cycleDependB(@DataConsumer("cycleDependA") Object dependA) {
+        return null;
+    }
 }