commit：单体工程目录

orange-demo-single/orange-demo-single-service/common/common-swagger/pom.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>common</artifactId>
+        <groupId>com.orange.demo</groupId>
+        <version>1.0.0</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>common-swagger</artifactId>
+    <version>1.0.0</version>
+    <name>common-swagger</name>
+    <packaging>jar</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-spring-boot-starter</artifactId>
+            <version>${knife4j.version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.springframework.plugin</groupId>
+                    <artifactId>spring-plugin-core</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>org.springframework.plugin</groupId>
+                    <artifactId>spring-plugin-metadata</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+        <dependency>
+            <groupId>com.orange.demo</groupId>
+            <artifactId>common-core</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+    </dependencies>
+</project>

orange-demo-single/orange-demo-single-service/common/common-swagger/src/main/java/com/orange/demo/common/swagger/config/SwaggerAutoConfiguration.java

@@ -0,0 +1,56 @@
+package com.orange.demo.common.swagger.config;
+
+import com.orange.demo.common.core.annotation.MyRequestBody;
+import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
+
+/**
+ * 自动加载bean的配置对象。
+ *
+ * @author Jerry
+ * @date 2020-09-24
+ */
+@EnableSwagger2WebMvc
+@EnableKnife4j
+@EnableConfigurationProperties(SwaggerProperties.class)
+@ConditionalOnProperty(prefix = "swagger", name = "enabled")
+public class SwaggerAutoConfiguration {
+
+    @Bean
+    public Docket upmsDocket(SwaggerProperties properties) {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .groupName("1. 用户权限分组接口")
+                .ignoredParameterTypes(MyRequestBody.class)
+                .apiInfo(apiInfo(properties))
+                .select()
+                .apis(RequestHandlerSelectors.basePackage(properties.getBasePackage() + ".upms.controller"))
+                .paths(PathSelectors.any()).build();
+    }
+
+    @Bean
+    public Docket bizDocket(SwaggerProperties properties) {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .groupName("2. 业务应用分组接口")
+                .ignoredParameterTypes(MyRequestBody.class)
+                .apiInfo(apiInfo(properties))
+                .select()
+                .apis(RequestHandlerSelectors.basePackage(properties.getBasePackage() + ".app.controller"))
+                .paths(PathSelectors.any()).build();
+    }
+
+    private ApiInfo apiInfo(SwaggerProperties properties) {
+        return new ApiInfoBuilder()
+                .title(properties.getTitle())
+                .description(properties.getDescription())
+                .version(properties.getVersion()).build();
+    }
+}

orange-demo-single/orange-demo-single-service/common/common-swagger/src/main/java/com/orange/demo/common/swagger/config/SwaggerProperties.java

@@ -0,0 +1,40 @@
+package com.orange.demo.common.swagger.config;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * 配置参数对象。
+ *
+ * @author Jerry
+ * @date 2020-09-24
+ */
+@Data
+@ConfigurationProperties("swagger")
+public class SwaggerProperties {
+
+	/**
+	 * 是否开启Swagger。
+	 */
+	private Boolean enabled;
+
+	/**
+	 * Swagger解析的基础包路径。
+	 **/
+	private String basePackage = "";
+
+	/**
+	 * ApiInfo中的标题。
+	 **/
+	private String title = "";
+
+	/**
+	 * ApiInfo中的描述信息。
+	 **/
+	private String description = "";
+
+	/**
+	 * ApiInfo中的版本信息。
+	 **/
+	private String version = "";
+}

orange-demo-single/orange-demo-single-service/common/common-swagger/src/main/java/com/orange/demo/common/swagger/plugin/ByteBuddyUtil.java

@@ -0,0 +1,85 @@
+package com.orange.demo.common.swagger.plugin;
+
+import cn.hutool.core.lang.Assert;
+import com.orange.demo.common.core.annotation.MyRequestBody;
+import com.github.xiaoymin.knife4j.core.conf.Consts;
+import javassist.*;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
+import springfox.documentation.service.ResolvedMethodParameter;
+
+import java.util.List;
+
+/**
+ * 通过字节码方式动态创建接口参数封装对象。
+ *
+ * @author Jerry
+ * @date 2020-09-24
+ */
+@Slf4j
+public class ByteBuddyUtil {
+    private static final ClassPool CLASS_POOL = ClassPool.getDefault();
+
+    public static Class<?> createDynamicModelClass(String name, List<ResolvedMethodParameter> parameters) {
+        String clazzName = Consts.BASE_PACKAGE_PREFIX + name;
+        try {
+            CtClass tmp = CLASS_POOL.getCtClass(clazzName);
+            if (tmp != null) {
+                tmp.detach();
+            }
+        } catch (NotFoundException e) {
+            // 需要吃掉这个异常。
+        }
+        CtClass ctClass = CLASS_POOL.makeClass(clazzName);
+        try {
+            int fieldCount = 0;
+            for (ResolvedMethodParameter dynamicParameter : parameters) {
+                // 因为在调用这个方法之前，这些参数都包含MyRequestBody注解。
+                MyRequestBody myRequestBody =
+                        dynamicParameter.findAnnotation(MyRequestBody.class).orElse(null);
+                Assert.notNull(myRequestBody);
+                String fieldName = dynamicParameter.defaultName().isPresent()
+                        ? dynamicParameter.defaultName().get() : "parameter";
+                if (StringUtils.isNotBlank(myRequestBody.value())) {
+                    fieldName = myRequestBody.value();
+                }
+                ctClass.addField(createField(dynamicParameter, fieldName, ctClass));
+                fieldCount++;
+            }
+            if (fieldCount > 0) {
+                return ctClass.toClass();
+            }
+        } catch (Throwable e) {
+            log.error(e.getMessage());
+        }
+        return null;
+    }
+
+    private static CtField createField(ResolvedMethodParameter parameter, String parameterName, CtClass ctClass)
+            throws NotFoundException, CannotCompileException {
+        CtField field = new CtField(getFieldType(parameter.getParameterType().getErasedType()), parameterName, ctClass);
+        field.setModifiers(Modifier.PUBLIC);
+        return field;
+    }
+
+    private static CtClass getFieldType(Class<?> propetyType) {
+        CtClass fieldType = null;
+        try {
+            if (!propetyType.isAssignableFrom(Void.class)) {
+                fieldType = CLASS_POOL.get(propetyType.getName());
+            } else {
+                fieldType = CLASS_POOL.get(String.class.getName());
+            }
+        } catch (NotFoundException e) {
+            // 抛异常
+            ClassClassPath path = new ClassClassPath(propetyType);
+            CLASS_POOL.insertClassPath(path);
+            try {
+                fieldType = CLASS_POOL.get(propetyType.getName());
+            } catch (NotFoundException e1) {
+                log.error(e1.getMessage(), e1);
+            }
+        }
+        return fieldType;
+    }
+}

orange-demo-single/orange-demo-single-service/common/common-swagger/src/main/java/com/orange/demo/common/swagger/plugin/DynamicBodyModelPlugin.java

@@ -0,0 +1,61 @@
+package com.orange.demo.common.swagger.plugin;
+
+import com.orange.demo.common.core.annotation.MyRequestBody;
+import com.fasterxml.classmate.TypeResolver;
+import com.google.common.base.CaseFormat;
+import org.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+import springfox.documentation.service.ResolvedMethodParameter;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spi.service.OperationModelsProviderPlugin;
+import springfox.documentation.spi.service.contexts.RequestMappingContext;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+/**
+ * 生成参数包装类的插件。
+ *
+ * @author Jerry
+ * @date 2020-09-24
+ */
+@Component
+@Order(Ordered.HIGHEST_PRECEDENCE + 200)
+@ConditionalOnProperty(prefix = "swagger", name = "enabled")
+public class DynamicBodyModelPlugin implements OperationModelsProviderPlugin {
+
+    private final TypeResolver typeResolver;
+
+    public DynamicBodyModelPlugin(TypeResolver typeResolver) {
+        this.typeResolver = typeResolver;
+    }
+
+    @Override
+    public void apply(RequestMappingContext context) {
+        List<ResolvedMethodParameter> parameterTypes = context.getParameters();
+        if (CollectionUtils.isEmpty(parameterTypes)) {
+            return;
+        }
+        List<ResolvedMethodParameter> bodyParameter = parameterTypes.stream()
+                .filter(p -> p.hasParameterAnnotation(MyRequestBody.class)).collect(Collectors.toList());
+        if (CollectionUtils.isEmpty(bodyParameter)) {
+            return;
+        }
+        String groupName = CaseFormat.LOWER_HYPHEN.to(CaseFormat.UPPER_CAMEL, context.getGroupName());
+        String clazzName = groupName + StringUtils.capitalize(context.getName());
+        Class<?> clazz = ByteBuddyUtil.createDynamicModelClass(clazzName, bodyParameter);
+        if (clazz != null) {
+            context.operationModelsBuilder().addInputParam(typeResolver.resolve(clazz));
+        }
+    }
+
+    @Override
+    public boolean supports(DocumentationType delimiter) {
+        // 支持2.0版本
+        return delimiter == DocumentationType.SWAGGER_2;
+    }
+}

orange-demo-single/orange-demo-single-service/common/common-swagger/src/main/java/com/orange/demo/common/swagger/plugin/DynamicBodyParameterBuilder.java

@@ -0,0 +1,64 @@
+package com.orange.demo.common.swagger.plugin;
+
+import com.orange.demo.common.core.annotation.MyRequestBody;
+import com.google.common.base.CaseFormat;
+import org.apache.commons.collections4.CollectionUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+import springfox.documentation.builders.ParameterBuilder;
+import springfox.documentation.schema.ModelRef;
+import springfox.documentation.service.Parameter;
+import springfox.documentation.service.ResolvedMethodParameter;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spi.service.OperationBuilderPlugin;
+import springfox.documentation.spi.service.contexts.OperationContext;
+import springfox.documentation.spi.service.contexts.ParameterContext;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+/**
+ * 构建操作接口参数对象的插件。
+ *
+ * @author Jerry
+ * @date 2020-09-24
+ */
+@Component
+@Order(Ordered.HIGHEST_PRECEDENCE + 102)
+@ConditionalOnProperty(prefix = "swagger", name = "enabled")
+public class DynamicBodyParameterBuilder implements OperationBuilderPlugin {
+
+    @Override
+    public void apply(OperationContext context) {
+        List<ResolvedMethodParameter> methodParameters = context.getParameters();
+        List<Parameter> parameters = new ArrayList<>();
+        if (CollectionUtils.isNotEmpty(methodParameters)) {
+            List<ResolvedMethodParameter> bodyParameter = methodParameters.stream()
+                    .filter(p -> p.hasParameterAnnotation(MyRequestBody.class)).collect(Collectors.toList());
+            if (CollectionUtils.isNotEmpty(bodyParameter)) {
+                // 构造model
+                String groupName = CaseFormat.LOWER_HYPHEN.to(CaseFormat.UPPER_CAMEL, context.getGroupName());
+                String clazzName = groupName + StringUtils.capitalize(context.getName());
+                ResolvedMethodParameter methodParameter = bodyParameter.get(0);
+                ParameterContext parameterContext = new ParameterContext(methodParameter,
+                        new ParameterBuilder(),
+                        context.getDocumentationContext(),
+                        context.getGenericsNamingStrategy(),
+                        context);
+                Parameter parameter = parameterContext.parameterBuilder()
+                        .parameterType("body").modelRef(new ModelRef(clazzName)).name(clazzName).build();
+                parameters.add(parameter);
+            }
+        }
+        context.operationBuilder().parameters(parameters);
+    }
+
+    @Override
+    public boolean supports(DocumentationType delimiter) {
+        return delimiter == DocumentationType.SWAGGER_2;
+    }
+}

orange-demo-single/orange-demo-single-service/common/common-swagger/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+com.orange.demo.common.swagger.config.SwaggerAutoConfiguration