实现根据path规则选择接口生成文档 #200

Author: dyc87112

pom.xml

@@ -94,6 +94,13 @@
             <version>${version.lombok}</version>
             <scope>provided</scope>
         </dependency>
+
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>30.0-jre</version>
+        </dependency>
+
     </dependencies>
 
     <dependencyManagement>

src/main/java/com/spring4all/swagger/DocketConfiguration.java

@@ -1,5 +1,6 @@
 package com.spring4all.swagger;
 
+import com.google.common.base.Predicates;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import springfox.documentation.builders.ApiInfoBuilder;
@@ -9,7 +10,10 @@
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
 
+import java.util.ArrayList;
 import java.util.Collections;
+import java.util.List;
+import java.util.function.Predicate;
 
 /**
  * @author 翟永超
@@ -51,30 +55,41 @@ public Docket createRestApi() {
         // 需要生成文档的接口目标配置
         Docket docket = builder.select()
                 .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))  // 通过扫描包选择接口
-//                .paths(paths(swaggerProperties))  // TODO 通过路径匹配选择接口
+                .paths(paths(swaggerProperties))  // 通过路径匹配选择接口
                 .build();
 
         return docket;
     }
 
     /**
-     * TODO API接口路径选择
+     * API接口路径选择
      *
      * @param swaggerProperties
      * @return
      */
-//    private Predicate paths(SwaggerProperties swaggerProperties) {
-    // TODO 原来的方式不能用了
-//        return or(
-//                regex("/business.*"),
-//                regex("/some.*"),
-//                regex("/contacts.*"),
-//                regex("/pet.*"),
-//                regex("/springsRestController.*"),
-//                regex("/test.*")
-//        );
-//        return null;
-//    }
+
+    private Predicate paths(SwaggerProperties swaggerProperties) {
+        // base-path处理
+        // 当没有配置任何path的时候，解析/**
+        if (swaggerProperties.getBasePath().isEmpty()) {
+            swaggerProperties.getBasePath().add("/**");
+        }
+        List<com.google.common.base.Predicate<String>> basePath = new ArrayList();
+        for (String path : swaggerProperties.getBasePath()) {
+            basePath.add(PathSelectors.ant(path));
+        }
+
+        // exclude-path处理
+        List<com.google.common.base.Predicate<String>> excludePath = new ArrayList();
+        for (String path : swaggerProperties.getExcludePath()) {
+            excludePath.add(PathSelectors.ant(path));
+        }
+
+        return Predicates.and(
+                Predicates.not(Predicates.or(excludePath)),
+                Predicates.or(basePath)
+        );
+    }
 
     /**
      * API文档基本信息

src/main/java/com/spring4all/swagger/PathSelectors.java

@@ -0,0 +1,60 @@
+package com.spring4all.swagger;
+
+import com.google.common.base.Predicate;
+import com.google.common.base.Predicates;
+import org.springframework.util.AntPathMatcher;
+
+public class PathSelectors {
+  private PathSelectors() {
+    throw new UnsupportedOperationException();
+  }
+
+  /**
+   * Any path satisfies this condition
+   *
+   * @return predicate that is always true
+   */
+  public static Predicate<String> any() {
+    return Predicates.alwaysTrue();
+  }
+
+  /**
+   * No path satisfies this condition
+   *
+   * @return predicate that is always false
+   */
+  public static Predicate<String> none() {
+    return Predicates.alwaysFalse();
+  }
+
+  /**
+   * Predicate that evaluates the supplied regular expression
+   *
+   * @param pathRegex - regex
+   * @return predicate that matches a particular regex
+   */
+  public static Predicate<String> regex(final String pathRegex) {
+    return new Predicate<String>() {
+      @Override
+      public boolean apply(String input) {
+        return input.matches(pathRegex);
+      }
+    };
+  }
+
+  /**
+   * Predicate that evaluates the supplied ant pattern
+   *
+   * @param antPattern - ant Pattern
+   * @return predicate that matches a particular ant pattern
+   */
+  public static Predicate<String> ant(final String antPattern) {
+    return new Predicate<String>() {
+      @Override
+      public boolean apply(String input) {
+        AntPathMatcher matcher = new AntPathMatcher();
+        return matcher.match(antPattern, input);
+      }
+    };
+  }
+}