Merge pull request #221 from llin6025/fix-issue-220

dyc87112 · web-flow · commit 812ca0b6f76e · 2021-10-08T10:25:51.000+08:00
Fix issue 220
diff --git a/src/main/java/com/spring4all/swagger/DocketConfiguration.java b/src/main/java/com/spring4all/swagger/DocketConfiguration.java
@@ -1,8 +1,8 @@
 package com.spring4all.swagger;
 
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
+import static com.google.common.collect.Lists.newArrayList;
+
+import java.util.*;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
@@ -25,6 +25,7 @@
 import springfox.documentation.schema.ScalarType;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.service.Contact;
+import springfox.documentation.service.ParameterType;
 import springfox.documentation.service.RequestParameter;
 import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
@@ -45,6 +46,9 @@ public class DocketConfiguration implements BeanFactoryAware {
     @Autowired
     private SwaggerProperties swaggerProperties;
 
+    @Autowired
+    private SwaggerAuthorizationConfiguration authConfiguration;
+
     private static final String BEAN_NAME = "spring-boot-starter-swagger-";
 
     @Override
@@ -70,7 +74,11 @@ public void createSpringFoxRestApi() {
 
             Docket docket4Group = (Docket)beanFactory.getBean(beanName);
             ApiInfo apiInfo = apiInfo(swaggerProperties);
-            docket4Group.host(swaggerProperties.getHost()).apiInfo(apiInfo).select()
+            docket4Group.host(swaggerProperties.getHost()).apiInfo(apiInfo)
+                .globalRequestParameters(
+                    assemblyRequestParameters(swaggerProperties.getGlobalOperationParameters(), new ArrayList<>()))
+                .securityContexts(Collections.singletonList(authConfiguration.securityContext()))
+                .securitySchemes(authConfiguration.getSecuritySchemes()).select()
                 .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
                 .paths(paths(swaggerProperties.getBasePath(), swaggerProperties.getExcludePath())).build();
             return;
@@ -124,7 +132,11 @@ public void createSpringFoxRestApi() {
             beanRegistry.registerBeanDefinition(beanName, beanDefinition4Group);
 
             Docket docket4Group = (Docket)beanFactory.getBean(beanName);
-            docket4Group.groupName(groupName).host(docketInfo.getBasePackage()).apiInfo(apiInfo).select()
+            docket4Group.groupName(groupName).host(docketInfo.getBasePackage()).apiInfo(apiInfo)
+                .globalRequestParameters(assemblyRequestParameters(swaggerProperties.getGlobalOperationParameters(),
+                    docketInfo.getGlobalOperationParameters()))
+                .securityContexts(Collections.singletonList(authConfiguration.securityContext()))
+                .securitySchemes(authConfiguration.getSecuritySchemes()).select()
                 .apis(RequestHandlerSelectors.basePackage(docketInfo.getBasePackage()))
                 .paths(paths(docketInfo.getBasePath(), docketInfo.getExcludePath())).build();
         }
@@ -133,19 +145,53 @@ public void createSpringFoxRestApi() {
     /**
      * 全局请求参数
      *
-     * @param swaggerProperties
+     * @param properties
      *            {@link SwaggerProperties}
      * @return RequestParameter {@link RequestParameter}
      */
-    private List<RequestParameter> globalRequestParameters(SwaggerProperties swaggerProperties) {
-        return swaggerProperties.getGlobalOperationParameters().stream()
+    private List<RequestParameter> getRequestParameters(List<SwaggerProperties.GlobalOperationParameter> properties) {
+        return properties.stream()
             .map(param -> new RequestParameterBuilder().name(param.getName()).description(param.getDescription())
-                .in(param.getParameterType()).required(param.getRequired())
-                .query(q -> q.defaultValue(param.getModelRef()))
-                .query(q -> q.model(m -> m.scalarModel(ScalarType.STRING))).build())
+                .in(ParameterType.from(param.getParameterType())).required(param.getRequired())
+                .query(q -> q.defaultValue(param.getType()))
+                .query(q -> q.model(m -> m.scalarModel(!ScalarType.from(param.getType(), param.getFormat()).isPresent()
+                    ? ScalarType.STRING : ScalarType.from(param.getType(), param.getFormat()).get())))
+                .build())
             .collect(Collectors.toList());
     }
 
+    /**
+     * 局部参数按照name覆盖局部参数
+     *
+     * @param globalRequestParameters 全局配置
+     * @param groupRequestParameters Group 的配置
+     * @return 汇总配置
+     */
+    private List<RequestParameter> assemblyRequestParameters(
+        List<SwaggerProperties.GlobalOperationParameter> globalRequestParameters,
+        List<SwaggerProperties.GlobalOperationParameter> groupRequestParameters) {
+
+        if (Objects.isNull(groupRequestParameters) || groupRequestParameters.isEmpty()) {
+            return getRequestParameters(globalRequestParameters);
+        }
+
+        Set<String> paramNames = groupRequestParameters.stream()
+            .map(SwaggerProperties.GlobalOperationParameter::getName).collect(Collectors.toSet());
+
+        List<SwaggerProperties.GlobalOperationParameter> requestParameters = newArrayList();
+
+        if (Objects.nonNull(globalRequestParameters)) {
+            for (SwaggerProperties.GlobalOperationParameter parameter : globalRequestParameters) {
+                if (!paramNames.contains(parameter.getName())) {
+                    requestParameters.add(parameter);
+                }
+            }
+        }
+
+        requestParameters.addAll(groupRequestParameters);
+        return getRequestParameters(requestParameters);
+    }
+
     /**
      * API接口路径选择
      *
diff --git a/src/main/java/com/spring4all/swagger/SwaggerAuthorizationConfiguration.java b/src/main/java/com/spring4all/swagger/SwaggerAuthorizationConfiguration.java
@@ -1,18 +1,16 @@
 package com.spring4all.swagger;
 
+import java.util.Collections;
+import java.util.List;
+
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
+
 import springfox.documentation.builders.PathSelectors;
-import springfox.documentation.service.ApiKey;
-import springfox.documentation.service.AuthorizationScope;
-import springfox.documentation.service.BasicAuth;
-import springfox.documentation.service.SecurityReference;
+import springfox.documentation.service.*;
 import springfox.documentation.spi.service.contexts.SecurityContext;
 import springfox.documentation.swagger.web.ApiKeyVehicle;
 
-import java.util.Collections;
-import java.util.List;
-
 /**
  * securitySchemes 支持方式之一 ApiKey
  *
@@ -24,43 +22,55 @@
 @EnableConfigurationProperties(SwaggerAuthorizationProperties.class)
 public class SwaggerAuthorizationConfiguration {
 
-    public SwaggerAuthorizationProperties swaggerAuthorizationProperties;
+    public SwaggerAuthorizationProperties properties;
 
-    public SwaggerAuthorizationConfiguration(SwaggerAuthorizationProperties swaggerAuthorizationProperties) {
-        this.swaggerAuthorizationProperties = swaggerAuthorizationProperties;
+    public SwaggerAuthorizationConfiguration(SwaggerAuthorizationProperties properties) {
+        this.properties = properties;
     }
 
+    /**
+     * 配置默认的全局鉴权策略的开关，以及通过正则表达式进行匹配
+     *
+     * @return SecurityContext
+     */
     public SecurityContext securityContext() {
         // 配置默认的全局鉴权策略的开关，以及通过正则表达式进行匹配；默认 ^.*$ 匹配所有URL
         // 其中 securityReferences 为配置启用的鉴权策略
         AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
         AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
         authorizationScopes[0] = authorizationScope;
-        List<SecurityReference> defaultAuth = Collections.singletonList(SecurityReference.builder()
-                .reference(swaggerAuthorizationProperties.getName())
-                .scopes(authorizationScopes).build());
+        List<SecurityReference> defaultAuth = Collections.singletonList(
+            SecurityReference.builder().reference(properties.getName()).scopes(authorizationScopes).build());
+
+        return SecurityContext.builder().securityReferences(defaultAuth)
+            .forPaths(PathSelectors.regex(properties.getAuthRegex())).build();
+    }
 
-        return SecurityContext.builder()
-                .securityReferences(defaultAuth)
-                .forPaths(PathSelectors.regex(swaggerAuthorizationProperties.getAuthRegex()))
-                .build();
+    /**
+     * Authorization 配置项
+     *
+     * @return List<SecurityScheme>
+     */
+    public List<SecurityScheme> getSecuritySchemes() {
+        if ("BasicAuth".equalsIgnoreCase(getType())) {
+            return Collections.singletonList(basicAuth());
+        } else if (!"None".equalsIgnoreCase(getType())) {
+            return Collections.singletonList(apiKey());
+        }
+        return null;
     }
 
-    public ApiKey apiKey() {
+    private ApiKey apiKey() {
         // 配置基于 ApiKey 的鉴权对象
-        return new ApiKey(swaggerAuthorizationProperties.getName(),
-                swaggerAuthorizationProperties.getKeyName(),
-                ApiKeyVehicle.HEADER.getValue());
+        return new ApiKey(properties.getName(), properties.getKeyName(), ApiKeyVehicle.HEADER.getValue());
     }
 
-    public BasicAuth basicAuth() {
+    private BasicAuth basicAuth() {
         // 配置基于 BasicAuth 的鉴权对象
-        return new BasicAuth(swaggerAuthorizationProperties.getName());
+        return new BasicAuth(properties.getName());
     }
 
-    public String getType() {
-        return swaggerAuthorizationProperties.getType();
+    private String getType() {
+        return properties.getType();
     }
-
-
 }
diff --git a/src/main/java/com/spring4all/swagger/SwaggerProperties.java b/src/main/java/com/spring4all/swagger/SwaggerProperties.java
@@ -5,6 +5,7 @@
 import java.util.List;
 import java.util.Map;
 
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 import lombok.Data;
@@ -106,7 +107,13 @@ public static class GlobalOperationParameter {
         /**
          * 指定参数类型
          **/
-        private String modelRef;
+        @Value("modelRef")
+        private String type;
+
+        /**
+         * 指定参数类型
+         **/
+        private String format = "";
 
         /**
          * 参数放在哪个地方:header,query,path,formData,cookie,form
@@ -116,7 +123,7 @@ public static class GlobalOperationParameter {
         /**
          * 参数是否必须传
          **/
-        private Boolean required;
+        private Boolean required = false;
 
     }
 
