From 23855599412c4d61b38d78f0f3abd3430a48b5b1 Mon Sep 17 00:00:00 2001
From: zhangherong <571457620@qq.com>
Date: 星期三, 25 六月 2025 11:51:38 +0800
Subject: [PATCH] Merge branch 'mdc_hyjs_master'
---
lxzn-boot-base-core/src/main/java/org/jeecg/config/Swagger2Config.java | 300 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 300 insertions(+), 0 deletions(-)
diff --git a/lxzn-boot-base-core/src/main/java/org/jeecg/config/Swagger2Config.java b/lxzn-boot-base-core/src/main/java/org/jeecg/config/Swagger2Config.java
new file mode 100644
index 0000000..3bb8a8c
--- /dev/null
+++ b/lxzn-boot-base-core/src/main/java/org/jeecg/config/Swagger2Config.java
@@ -0,0 +1,300 @@
+package org.jeecg.config;
+
+import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
+import io.swagger.annotations.ApiOperation;
+import org.jeecg.common.constant.CommonConstant;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+import org.springframework.util.ReflectionUtils;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
+import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.ParameterBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.schema.ModelRef;
+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 springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+/**
+ * @Author scott
+ */
+@Configuration
+@EnableSwagger2 //寮�鍚� Swagger2
+@EnableKnife4j //寮�鍚� knife4j锛屽彲浠ヤ笉鍐�
+@Import(BeanValidatorPluginsConfiguration.class)
+public class Swagger2Config implements WebMvcConfigurer {
+
+ /**
+ *
+ * 鏄剧ずswagger-ui.html鏂囨。灞曠ず椤碉紝杩樺繀椤绘敞鍏wagger璧勬簮锛�
+ *
+ * @param registry
+ */
+ @Override
+ public void addResourceHandlers(ResourceHandlerRegistry registry) {
+ registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
+ registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
+ registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
+ }
+
+ /**
+ * swagger2鐨勯厤缃枃浠讹紝杩欓噷鍙互閰嶇疆swagger2鐨勪竴浜涘熀鏈殑鍐呭锛屾瘮濡傛壂鎻忕殑鍖呯瓑绛�
+ *
+ * @return Docket
+ */
+ @Bean(value = "defaultApi2")
+ public Docket defaultApi2() {
+ return new Docket(DocumentationType.SWAGGER_2)
+ .apiInfo(apiInfo())
+ .select()
+ //姝ゅ寘璺緞涓嬬殑绫伙紝鎵嶇敓鎴愭帴鍙ｆ枃妗�
+ .apis(RequestHandlerSelectors.basePackage("org.jeecg"))
+ //鍔犱簡ApiOperation娉ㄨВ鐨勭被锛屾墠鐢熸垚鎺ュ彛鏂囨。
+ .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ .paths(PathSelectors.any())
+ .build()
+ .securitySchemes(Collections.singletonList(securityScheme()))
+ .securityContexts(securityContexts())
+ .globalOperationParameters(setHeaderToken())
+ .groupName("default");
+ }
+
+ /**
+ * swagger2鐨勯厤缃枃浠讹紝杩欓噷鍙互閰嶇疆swagger2鐨勪竴浜涘熀鏈殑鍐呭锛屾瘮濡傛壂鎻忕殑鍖呯瓑绛� 锛圡DC锛�
+ *
+ * @return Docket
+ */
+ @Bean(value = "defaultApi")
+ public Docket defaultApi() {
+ return new Docket(DocumentationType.SWAGGER_2)
+ .apiInfo(apiInfo())
+ .select()
+ //姝ゅ寘璺緞涓嬬殑绫伙紝鎵嶇敓鎴愭帴鍙ｆ枃妗�
+ .apis(RequestHandlerSelectors.basePackage("org.jeecg.modules.mdc"))
+ //鍔犱簡ApiOperation娉ㄨВ鐨勭被锛屾墠鐢熸垚鎺ュ彛鏂囨。
+ .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ .paths(PathSelectors.any())
+ .build()
+ .securitySchemes(Collections.singletonList(securityScheme()))
+ .securityContexts(securityContexts())
+ .globalOperationParameters(setHeaderToken())
+ .groupName("MDC");
+ }
+
+ /**
+ * swagger2鐨勯厤缃枃浠讹紝杩欓噷鍙互閰嶇疆swagger2鐨勪竴浜涘熀鏈殑鍐呭锛屾瘮濡傛壂鎻忕殑鍖呯瓑绛� 锛圖NC锛�
+ *
+ * @return Docket
+ */
+ @Bean(value = "defaultApiDnc")
+ public Docket defaultApi3() {
+ return new Docket(DocumentationType.SWAGGER_2)
+ .apiInfo(apiInfo())
+ .select()
+ //姝ゅ寘璺緞涓嬬殑绫伙紝鎵嶇敓鎴愭帴鍙ｆ枃妗�
+ .apis(RequestHandlerSelectors.basePackage("org.jeecg.modules.dnc"))
+ //鍔犱簡ApiOperation娉ㄨВ鐨勭被锛屾墠鐢熸垚鎺ュ彛鏂囨。
+ .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ .paths(PathSelectors.any())
+ .build()
+ .securitySchemes(Collections.singletonList(securityScheme()))
+ .securityContexts(securityContexts())
+ .globalOperationParameters(setHeaderToken())
+ .groupName("DNC");
+ }
+
+ @Bean(value = "defaultApiAct")
+ public Docket activitiApi() {
+ return new Docket(DocumentationType.SWAGGER_2)
+ .apiInfo(apiInfo())
+ .select()
+ //姝ゅ寘璺緞涓嬬殑绫伙紝鎵嶇敓鎴愭帴鍙ｆ枃妗�
+ .apis(RequestHandlerSelectors.basePackage("org.jeecg.modules.flowable"))
+ //鍔犱簡ApiOperation娉ㄨВ鐨勭被锛屾墠鐢熸垚鎺ュ彛鏂囨。
+ .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ .paths(PathSelectors.any())
+ .build()
+ .securitySchemes(Collections.singletonList(securityScheme()))
+ .securityContexts(securityContexts())
+ .globalOperationParameters(setHeaderToken())
+ .groupName("Flowable妯″潡");
+ }
+
+ @Bean(value = "defaultApiMsi")
+ public Docket activitiApiMsi() {
+ return new Docket(DocumentationType.SWAGGER_2)
+ .apiInfo(apiInfo())
+ .select()
+ //姝ゅ寘璺緞涓嬬殑绫伙紝鎵嶇敓鎴愭帴鍙ｆ枃妗�
+ .apis(RequestHandlerSelectors.basePackage("org.jeecg.modules.msi"))
+ //鍔犱簡ApiOperation娉ㄨВ鐨勭被锛屾墠鐢熸垚鎺ュ彛鏂囨。
+ .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ .paths(PathSelectors.any())
+ .build()
+ .securitySchemes(Collections.singletonList(securityScheme()))
+ .securityContexts(securityContexts())
+ .globalOperationParameters(setHeaderToken())
+ .groupName("闆嗘垚");
+ }
+
+ @Bean(value = "defaultApiEam")
+ public Docket activitiApiEam() {
+ return new Docket(DocumentationType.SWAGGER_2)
+ .apiInfo(apiInfo())
+ .select()
+ //姝ゅ寘璺緞涓嬬殑绫伙紝鎵嶇敓鎴愭帴鍙ｆ枃妗�
+ .apis(RequestHandlerSelectors.basePackage("org.jeecg.modules.eam"))
+ //鍔犱簡ApiOperation娉ㄨВ鐨勭被锛屾墠鐢熸垚鎺ュ彛鏂囨。
+ .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ .paths(PathSelectors.any())
+ .build()
+ .securitySchemes(Collections.singletonList(securityScheme()))
+ .securityContexts(securityContexts())
+ .globalOperationParameters(setHeaderToken())
+ .groupName("eam");
+ }
+
+ @Bean(value = "defaultApiBoard")
+ public Docket activitiApiBoard() {
+ return new Docket(DocumentationType.SWAGGER_2)
+ .apiInfo(apiInfo())
+ .select()
+ //姝ゅ寘璺緞涓嬬殑绫伙紝鎵嶇敓鎴愭帴鍙ｆ枃妗�
+ .apis(RequestHandlerSelectors.basePackage("org.jeecg.modules.board"))
+ //鍔犱簡ApiOperation娉ㄨВ鐨勭被锛屾墠鐢熸垚鎺ュ彛鏂囨。
+ .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
+ .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
+ .paths(PathSelectors.any())
+ .build()
+ .securitySchemes(Collections.singletonList(securityScheme()))
+ .securityContexts(securityContexts())
+ .globalOperationParameters(setHeaderToken())
+ .groupName("鏁板瓧瀛敓鐪嬫澘");
+ }
+
+ /***
+ * oauth2閰嶇疆
+ * 闇�瑕佸鍔爏wagger鎺堟潈鍥炶皟鍦板潃
+ * http://localhost:8888/webjars/springfox-swagger-ui/o2c.html
+ * @return
+ */
+ @Bean
+ SecurityScheme securityScheme() {
+ return new ApiKey(CommonConstant.X_ACCESS_TOKEN, CommonConstant.X_ACCESS_TOKEN, "header");
+ }
+ /**
+ * JWT token
+ * @return
+ */
+ private List<Parameter> setHeaderToken() {
+ ParameterBuilder tokenPar = new ParameterBuilder();
+ List<Parameter> pars = new ArrayList<>();
+ tokenPar.name(CommonConstant.X_ACCESS_TOKEN).description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
+ pars.add(tokenPar.build());
+ return pars;
+ }
+
+ /**
+ * api鏂囨。鐨勮缁嗕俊鎭嚱鏁�,娉ㄦ剰杩欓噷鐨勬敞瑙ｅ紩鐢ㄧ殑鏄摢涓�
+ *
+ * @return
+ */
+ private ApiInfo apiInfo() {
+ return new ApiInfoBuilder()
+ // //澶ф爣棰�
+ .title("JeecgBoot 鍚庡彴鏈嶅姟API鎺ュ彛鏂囨。")
+ // 鐗堟湰鍙�
+ .version("1.0")
+// .termsOfServiceUrl("NO terms of service")
+ // 鎻忚堪
+ .description("鍚庡彴API鎺ュ彛")
+ // 浣滆��
+ .contact(new Contact("鍖椾含鍥界偓淇℃伅鎶�鏈湁闄愬叕鍙�","www.jeccg.com","jeecgos@163.com"))
+ .license("The Apache License, Version 2.0")
+ .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
+ .build();
+ }
+
+ /**
+ * 鏂板 securityContexts 淇濇寔鐧诲綍鐘舵��
+ */
+ private List<SecurityContext> securityContexts() {
+ return new ArrayList(
+ Collections.singleton(SecurityContext.builder()
+ .securityReferences(defaultAuth())
+ .forPaths(PathSelectors.regex("^(?!auth).*$"))
+ .build())
+ );
+ }
+
+ private List<SecurityReference> defaultAuth() {
+ AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
+ AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
+ authorizationScopes[0] = authorizationScope;
+ return new ArrayList(
+ Collections.singleton(new SecurityReference(CommonConstant.X_ACCESS_TOKEN, authorizationScopes)));
+ }
+
+ /**
+ * 瑙ｅ喅springboot2.6 鍜宻pringfox涓嶅吋瀹归棶棰�
+ * @return
+ */
+ @Bean
+ public static 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;
+ }
+
+ private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
+ List<T> copy = mappings.stream()
+ .filter(mapping -> mapping.getPatternParser() == null)
+ .collect(Collectors.toList());
+ mappings.clear();
+ mappings.addAll(copy);
+ }
+
+ @SuppressWarnings("unchecked")
+ 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);
+ }
+ }
+ };
+ }
+
+
+}
--
Gitblit v1.9.3