Swagger domain Expand Bug -- IBZOperation 最后判断

SLN/%PUBPRJ%-provider/%PUBPRJ%-provider-%SYSAPI_PKGPATH%/pom.xml.ftl

@@ -22,16 +22,6 @@ TARGET=PSSYSSERVICEAPI
             <artifactId>${pub.getCodeName()?lower_case}-core</artifactId>
             <version>${r'${project.version}'}</version>
         </dependency>
-
-        <!--  Swagger2  -->
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger2</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.springfox</groupId>
-            <artifactId>springfox-swagger-ui</artifactId>
-        </dependency>
     </dependencies>
 
 <#if pub.getPSDeployCenter()?? && pub.getPSDeployCenter().getPSRegistryRepo()??>

SLN/%PUBPRJ%-provider/%PUBPRJ%-provider-%SYSAPI_PKGPATH%/src/main/java/%SYS_PKGPATH%/swagger/SwaggerConfiguration.java.ftl

@@ -3,26 +3,35 @@ TARGET=PSDESERVICEAPI
 </#ibiztemplate>
 package ${pub.getPKGCodeName()!''}.swagger;
 
+import ${pub.getPKGCodeName()!''}.security.SpringContextHolder;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 import static com.google.common.base.Predicates.or;
 import static springfox.documentation.builders.PathSelectors.regex;
 
+import org.springframework.plugin.core.PluginRegistry;
+import org.springframework.plugin.core.PluginRegistrySupport;
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.builders.PathSelectors;
 import springfox.documentation.builders.RequestHandlerSelectors;
 import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spi.service.OperationBuilderPlugin;
 import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.spring.web.readers.operation.OperationParameterReader;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.List;
+
 @Configuration
-//@EnableSwagger2
+@EnableSwagger2
 public class SwaggerConfiguration {
 
     @Bean
     public Docket docket() {
-        return new Docket(DocumentationType.SWAGGER_2)
+        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                 .groupName("DEFAULT")
                 .pathMapping("/")
                 .apiInfo(
@@ -36,6 +45,8 @@ public class SwaggerConfiguration {
 				.paths(PathSelectors.any())
                 .build()
                 ;
+		removeDefaultPlugin();
+		return docket ;
     }
 
     <#if sys.getAllPSSysServiceAPIs()??>
@@ -61,4 +72,27 @@ public class SwaggerConfiguration {
         </#list>
     </#if>
 
+	
+	private void removeDefaultPlugin() {
+		// 从spring容器中获取swagger插件注册表
+		PluginRegistry<OperationBuilderPlugin, DocumentationType> pluginRegistry = SpringContextHolder.getBean("operationBuilderPluginRegistry");
+		// 插件集合
+		List<OperationBuilderPlugin> plugins = pluginRegistry.getPlugins();
+		// 从spring容器中获取需要删除的插件
+		OperationParameterReader operationParameterReader = SpringContextHolder.getBean(OperationParameterReader.class);
+		if(operationParameterReader==null)
+			return ;
+		// 原plugins集合不能修改，创建新集合，通过反射替换
+		if (pluginRegistry.contains(operationParameterReader)) {
+			List<OperationBuilderPlugin> plugins_new = new ArrayList<OperationBuilderPlugin>(plugins);
+			plugins_new.remove(operationParameterReader);
+			try {
+				Field field = PluginRegistrySupport.class.getDeclaredField("plugins");
+				field.setAccessible(true);
+				field.set(pluginRegistry, plugins_new);
+			} catch (Exception e) {
+				e.printStackTrace();
+			}
+		}
+	}
 }

SLN/%PUBPRJ%-util/pom.xml.ftl

@@ -78,5 +78,15 @@ TARGET=PSSYSTEM
             <artifactId>commons-pool2</artifactId>
         </dependency>
 
+        <!--  Swagger2  -->
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+        </dependency>
+
     </dependencies>
 </project>

SLN/%PUBPRJ%-util/src/main/java/%SYS_PKGPATH%/util/web/IBZOperationParameterReader.java.ftl

+<#ibiztemplate>
+TARGET=PSSYSTEM
+</#ibiztemplate>
+package ${pub.getPKGCodeName()}.util.web;
+
+import cn.ibizlab.ftc.util.filter.SearchContextBase;
+import com.fasterxml.classmate.ResolvedType;
+import com.google.common.base.Predicate;
+import com.google.common.collect.FluentIterable;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Primary;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RequestPart;
+import springfox.documentation.builders.ParameterBuilder;
+import springfox.documentation.service.Parameter;
+import springfox.documentation.service.ResolvedMethodParameter;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spi.schema.EnumTypeDeterminer;
+import springfox.documentation.spi.service.OperationBuilderPlugin;
+import springfox.documentation.spi.service.contexts.OperationContext;
+import springfox.documentation.spi.service.contexts.ParameterContext;
+import springfox.documentation.spring.web.plugins.DocumentationPluginsManager;
+import springfox.documentation.spring.web.readers.parameter.ExpansionContext;
+import springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander;
+
+import java.lang.annotation.Annotation;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static com.google.common.base.Predicates.*;
+import static com.google.common.collect.Lists.*;
+import static springfox.documentation.schema.Collections.*;
+import static springfox.documentation.schema.Maps.*;
+import static springfox.documentation.schema.Types.*;
+
+@Component
+@Order(Ordered.HIGHEST_PRECEDENCE)
+public class IBZOperationParameterReader implements OperationBuilderPlugin {
+  private final ModelAttributeParameterExpander expander;
+  private final EnumTypeDeterminer enumTypeDeterminer;
+
+  @Autowired
+  private DocumentationPluginsManager pluginsManager;
+
+  @Autowired
+  public UsrOperationParameterReader(
+      ModelAttributeParameterExpander expander,
+      EnumTypeDeterminer enumTypeDeterminer) {
+    this.expander = expander;
+    this.enumTypeDeterminer = enumTypeDeterminer;
+  }
+
+  @Override
+  public void apply(OperationContext context) {
+    context.operationBuilder().parameters(context.getGlobalOperationParameters());
+    context.operationBuilder().parameters(readParameters(context));
+  }
+
+  @Override
+  public boolean supports(DocumentationType delimiter) {
+    return true;
+  }
+
+  private List<Parameter> readParameters(final OperationContext context) {
+
+    List<ResolvedMethodParameter> methodParameters = context.getParameters();
+    List<Parameter> parameters = newArrayList();
+
+    for (ResolvedMethodParameter methodParameter : methodParameters) {
+      ResolvedType alternate = context.alternateFor(methodParameter.getParameterType());
+      if (!shouldIgnore(methodParameter, alternate, context.getIgnorableParameterTypes())) {
+
+        ParameterContext parameterContext = new ParameterContext(methodParameter,
+            new ParameterBuilder(),
+            context.getDocumentationContext(),
+            context.getGenericsNamingStrategy(),
+            context);
+
+        if (shouldExpand(methodParameter, alternate)) {
+          parameters.addAll(
+              expander.expand(
+                  new ExpansionContext("", alternate, context)));
+        } else {
+          parameters.add(pluginsManager.parameter(parameterContext));
+        }
+      }
+    }
+    return FluentIterable.from(parameters).filter(not(hiddenParams())).toList();
+  }
+
+  private Predicate<Parameter> hiddenParams() {
+    return new Predicate<Parameter>() {
+      @Override
+      public boolean apply(Parameter input) {
+        return input.isHidden();
+      }
+    };
+  }
+
+  private boolean shouldIgnore(
+      final ResolvedMethodParameter parameter,
+      ResolvedType resolvedParameterType,
+      final Set<Class> ignorableParamTypes) {
+
+    if (ignorableParamTypes.contains(resolvedParameterType.getErasedType())) {
+      return true;
+    }
+    return FluentIterable.from(ignorableParamTypes)
+        .filter(isAnnotation())
+        .filter(parameterIsAnnotatedWithIt(parameter)).size() > 0;
+
+  }
+
+  private Predicate<Class> parameterIsAnnotatedWithIt(final ResolvedMethodParameter parameter) {
+    return new Predicate<Class>() {
+      @Override
+      public boolean apply(Class input) {
+        return parameter.hasParameterAnnotation(input);
+      }
+    };
+  }
+
+  private Predicate<Class> isAnnotation() {
+    return new Predicate<Class>() {
+      @Override
+      public boolean apply(Class input) {
+        return Annotation.class.isAssignableFrom(input);
+      }
+    };
+  }
+
+  private boolean shouldExpand(final ResolvedMethodParameter parameter, ResolvedType resolvedParamType) {
+    return !parameter.hasParameterAnnotation(RequestBody.class)
+        && !parameter.hasParameterAnnotation(RequestPart.class)
+        && !parameter.hasParameterAnnotation(RequestParam.class)
+        && !parameter.hasParameterAnnotation(PathVariable.class)
+        && !isBaseType(typeNameFor(resolvedParamType.getErasedType()))
+        && !enumTypeDeterminer.isEnum(resolvedParamType.getErasedType())
+        && !isContainerType(resolvedParamType)
+        && !isMapType(resolvedParamType)
+            && !SearchContextBase.class.isAssignableFrom(resolvedParamType.getErasedType());
+
+  }
+
+}