add 整合 springdoc 移除 knife4j

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

@@ -1,33 +1,15 @@
 package com.ruoyi.framework.config;
 
-import cn.dev33.satoken.config.SaTokenConfig;
-import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
-import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
-import com.ruoyi.common.utils.StringUtils;
-import com.ruoyi.common.utils.spring.SpringUtils;
 import com.ruoyi.framework.config.properties.SwaggerProperties;
-import io.swagger.models.auth.In;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
 import lombok.RequiredArgsConstructor;
-import org.springframework.beans.BeansException;
-import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springdoc.core.SpringDocConfiguration;
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.util.ReflectionUtils;
-import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
-import springfox.documentation.builders.ApiInfoBuilder;
-import springfox.documentation.builders.PathSelectors;
-import springfox.documentation.builders.RequestHandlerSelectors;
-import springfox.documentation.service.*;
-import springfox.documentation.spi.DocumentationType;
-import springfox.documentation.spi.service.contexts.SecurityContext;
-import springfox.documentation.spring.web.plugins.Docket;
-import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
-import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
-
-import javax.annotation.PostConstruct;
-import java.lang.reflect.Field;
-import java.util.ArrayList;
-import java.util.List;
 
 /**
  * Swagger 文档配置
@@ -36,125 +18,36 @@ import java.util.List;
  */
 @RequiredArgsConstructor
 @Configuration
-@EnableKnife4j
+@AutoConfigureBefore(SpringDocConfiguration.class)
+@ConditionalOnProperty(name = "swagger.enabled", havingValue = "true", matchIfMissing = true)
 public class SwaggerConfig {
 
     private final SwaggerProperties swaggerProperties;
-    private final SaTokenConfig saTokenConfig;
-    private final OpenApiExtensionResolver openApiExtensionResolver;
 
-    /**
-     * 用于适配springboot 2.6
-     */
     @Bean
-    @SuppressWarnings("all")
-    public BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
-        return new BeanPostProcessor() {
-            @Override
-            public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
-                if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {
-                    customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
-                }
-                return bean;
-            }
+    @ConditionalOnMissingBean(OpenAPI.class)
+    public OpenAPI openApi() {
+        OpenAPI openApi = new OpenAPI();
+        // 文档基本信息
+        SwaggerProperties.InfoProperties infoProperties = swaggerProperties.getInfo();
+        Info info = convertInfo(infoProperties);
+        openApi.info(info);
+        // 扩展文档信息
+        openApi.externalDocs(swaggerProperties.getExternalDocs());
+        openApi.tags(swaggerProperties.getTags());
+        openApi.paths(swaggerProperties.getPaths());
+        openApi.components(swaggerProperties.getComponents());
 
-            private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
-                mappings.removeIf(mapping -> mapping.getPatternParser() != null);
-            }
-
-            private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
-                try {
-                    Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
-                    field.setAccessible(true);
-                    return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
-                } catch (IllegalArgumentException | IllegalAccessException e) {
-                    throw new IllegalStateException(e);
-                }
-            }
-        };
+        return openApi;
     }
 
-    /**
-     * 创建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())
-                .extensions(openApiExtensionResolver.buildExtensions(group.getName()))
-                .pathMapping(swaggerProperties.getPathMapping());
-            String beanName = StringUtils.substringAfterLast(basePackage, ".") + "Docket";
-            SpringUtils.registerBean(beanName, docket);
-        }
-    }
-
-    /**
-     * 安全模式，这里指定token通过Authorization头请求头传递
-     */
-    private List<SecurityScheme> securitySchemes() {
-        List<SecurityScheme> apiKeyList = new ArrayList<>();
-        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())
-                .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(saTokenConfig.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 Info convertInfo(SwaggerProperties.InfoProperties infoProperties) {
+        Info info = new Info();
+        info.setTitle(infoProperties.getTitle());
+        info.setDescription(infoProperties.getDescription());
+        info.setContact(infoProperties.getContact());
+        info.setLicense(infoProperties.getLicense());
+        info.setVersion(infoProperties.getVersion());
+        return info;
     }
 }

ruoyi-framework/src/main/java/com/ruoyi/framework/config/properties/SwaggerProperties.java

@@ -1,8 +1,14 @@
 package com.ruoyi.framework.config.properties;
 
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.ExternalDocumentation;
+import io.swagger.v3.oas.models.Paths;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.tags.Tag;
 import lombok.Data;
-import lombok.NoArgsConstructor;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.NestedConfigurationProperty;
 import org.springframework.stereotype.Component;
 
 import java.util.List;
@@ -18,74 +24,77 @@ import java.util.List;
 public class SwaggerProperties {
 
     /**
-     * 文档开关
+     * 是否开启 openApi 文档
      */
-    private Boolean enabled;
+    private Boolean enabled = true;
 
     /**
-     * 设置请求的统一前缀
+     * 文档基本信息
      */
-    private String pathMapping;
+    @NestedConfigurationProperty
+    private InfoProperties info = new InfoProperties();
 
     /**
-     * 标头
+     * 扩展文档地址
      */
-    private String title;
+    @NestedConfigurationProperty
+    private ExternalDocumentation externalDocs;
 
     /**
-     * 描述
+     * 标签
      */
-    private String description;
+    private List<Tag> tags = null;
 
     /**
-     * 项目版本
+     * 路径
      */
-    private String version;
+    @NestedConfigurationProperty
+    private Paths paths = null;
 
     /**
-     * 联系方式
+     * 组件
      */
-    private Contact contact;
+    @NestedConfigurationProperty
+    private Components components = null;
 
     /**
-     * 组配置
+     * <p>
+     * 文档的基础属性信息
+     * </p>
+     *
+     * @see io.swagger.v3.oas.models.info.Info
+     *
+     * 为了 springboot 自动生产配置提示信息，所以这里复制一个类出来
      */
-    private List<Groups> groups;
-
     @Data
-    @NoArgsConstructor
-    public static class Contact {
+    public static class InfoProperties {
 
         /**
-         * 联系人
+         * 标题
          */
-        private String name;
+        private String title = null;
 
         /**
-         * 联系人url
+         * 描述
          */
-        private String url;
+        private String description = null;
 
         /**
-         * 联系人email
+         * 联系人信息
          */
-        private String email;
-
-    }
-
-    @Data
-    @NoArgsConstructor
-    public static class Groups {
+        @NestedConfigurationProperty
+        private Contact contact = null;
 
         /**
-         * 组名
+         * 许可证
          */
-        private String name;
+        @NestedConfigurationProperty
+        private License license = null;
 
         /**
-         * 基础包路径
+         * 版本
          */
-        private String basePackage;
+        private String version = null;
 
     }