修复在swagger配置类中无法读取到satoken配置文件的问题

602003139@qq.com

2021-10-21 2489c46a7ffe23a95da201a35c40424f2b79dba2

 ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java

@@ -1,10 +1,13 @@
package com.ruoyi.framework.config;

import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.config.SaTokenConfig;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.utils.spring.SpringUtils;
import com.ruoyi.framework.config.properties.SwaggerProperties;
import io.swagger.annotations.ApiOperation;
import io.swagger.models.auth.In;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
@@ -13,97 +16,105 @@
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import javax.annotation.PostConstruct;
import java.util.ArrayList;
import java.util.List;

/**
 * Swagger2的接口配置
 * Swagger 文档配置
 *
 * @author Lion Li
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {

   @Autowired
   private SwaggerProperties swaggerProperties;
    @Autowired
    private SwaggerProperties swaggerProperties;
    @Autowired
    private SaTokenConfig saTokenConfig;

   /**
    * 创建API
    */
   @Bean
   public Docket createRestApi() {
      return new Docket(DocumentationType.SWAGGER_2)
         .enable(swaggerProperties.getEnabled())
         // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
         .apiInfo(apiInfo())
         // 设置哪些接口暴露给Swagger展示
         .select()
         // 扫描所有有注解的api，用这种方式更灵活
         .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
         // 扫描指定包中的swagger注解
         // .apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
         // 扫描所有 .apis(RequestHandlerSelectors.any())
         .paths(PathSelectors.any())
         .build()
         /* 设置安全模式，swagger可以设置访问token */
         .securitySchemes(securitySchemes())
         .securityContexts(securityContexts())
         .pathMapping(swaggerProperties.getPathMapping());
   }
    /**
     * 创建API
     */
    @PostConstruct
    public void createRestApi() {
      for (SwaggerProperties.Groups group : swaggerProperties.getGroups()) {
         String basePackage = group.getBasePackage();
         Docket docket = new Docket(DocumentationType.OAS_30)
               .enable(swaggerProperties.getEnabled())
               // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）
               .apiInfo(apiInfo())
               // 设置哪些接口暴露给Swagger展示
               .select()
               // 扫描所有有注解的api，用这种方式更灵活
               //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
               // 扫描指定包中的swagger注解
               .apis(RequestHandlerSelectors.basePackage(basePackage))
               // 扫描所有 .apis(RequestHandlerSelectors.any())
               .paths(PathSelectors.any())
               .build()
               .groupName(group.getName())
               // 设置安全模式，swagger可以设置访问token
               .securitySchemes(securitySchemes())
               .securityContexts(securityContexts())
               .pathMapping(swaggerProperties.getPathMapping());
         String beanName = StringUtils.substringAfterLast(basePackage, ".") + "Docket";
         SpringUtils.registerBean(beanName, docket);
      }
    }

   /**
    * 安全模式，这里指定token通过Authorization头请求头传递
    */
   private List<SecurityScheme> securitySchemes() {
      List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();
      apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
      return apiKeyList;
   }
    /**
     * 安全模式，这里指定token通过Authorization头请求头传递
     */
    private List<SecurityScheme> securitySchemes() {
        List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();
        String header = saTokenConfig.getTokenName();
      apiKeyList.add(new ApiKey(header, header, In.HEADER.toValue()));
        return apiKeyList;
    }

   /**
    * 安全上下文
    */
   private List<SecurityContext> securityContexts() {
      List<SecurityContext> securityContexts = new ArrayList<>();
      securityContexts.add(
         SecurityContext.builder()
            .securityReferences(defaultAuth())
            .forPaths(PathSelectors.regex("^(?!auth).*$"))
            .build());
      return securityContexts;
   }
    /**
     * 安全上下文
     */
    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        .operationSelector(o -> o.requestMappingPattern().matches("/.*"))
                        .build());
        return securityContexts;
    }

   /**
    * 默认的安全上引用
    */
   private List<SecurityReference> defaultAuth() {
      AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
      AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
      authorizationScopes[0] = authorizationScope;
      List<SecurityReference> securityReferences = new ArrayList<>();
      securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
      return securityReferences;
   }
    /**
     * 默认的安全上引用
     */
    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference(SaManager.getConfig().getTokenName(), authorizationScopes));
        return securityReferences;
    }

   /**
    * 添加摘要信息
    */
   private ApiInfo apiInfo() {
      // 用ApiInfoBuilder进行定制
      SwaggerProperties.Contact contact = swaggerProperties.getContact();
      return new ApiInfoBuilder()
         // 设置标题
         .title(swaggerProperties.getTitle())
         // 描述
         .description(swaggerProperties.getDescription())
         // 作者信息
         .contact(new Contact(contact.getName(), contact.getUrl(), contact.getEmail()))
         // 版本
         .version(swaggerProperties.getVersion())
         .build();
   }
    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo() {
        // 用ApiInfoBuilder进行定制
        SwaggerProperties.Contact contact = swaggerProperties.getContact();
        return new ApiInfoBuilder()
                // 设置标题
                .title(swaggerProperties.getTitle())
                // 描述
                .description(swaggerProperties.getDescription())
                // 作者信息
                .contact(new Contact(contact.getName(), contact.getUrl(), contact.getEmail()))
                // 版本
                .version(swaggerProperties.getVersion())
                .build();
    }
}