mirror of
https://github.com/jeecgboot/JeecgBoot.git
synced 2025-12-30 00:32:26 +08:00
knife4j升级4.3.0注解改造
This commit is contained in:
@ -1,160 +1,160 @@
|
||||
package org.jeecg.handler.swagger;
|
||||
|
||||
import cn.hutool.core.util.ArrayUtil;
|
||||
import cn.hutool.core.util.ObjectUtil;
|
||||
import com.alibaba.nacos.api.naming.NamingFactory;
|
||||
import com.alibaba.nacos.api.naming.NamingService;
|
||||
import com.alibaba.nacos.api.naming.pojo.Instance;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.cloud.gateway.route.RouteLocator;
|
||||
import org.springframework.context.annotation.Primary;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import springfox.documentation.swagger.web.SwaggerResource;
|
||||
import springfox.documentation.swagger.web.SwaggerResourcesProvider;
|
||||
|
||||
import java.util.*;
|
||||
|
||||
/**
|
||||
* 聚合各个服务的swagger接口
|
||||
* @author zyf
|
||||
* @date: 2022/4/21 10:55
|
||||
*/
|
||||
@Component
|
||||
@Slf4j
|
||||
@Primary
|
||||
public class MySwaggerResourceProvider implements SwaggerResourcesProvider {
|
||||
/**
|
||||
* swagger2默认的url后缀
|
||||
*/
|
||||
private static final String SWAGGER2URL = "/v2/api-docs";
|
||||
|
||||
/**
|
||||
* 网关路由
|
||||
*/
|
||||
private final RouteLocator routeLocator;
|
||||
/**
|
||||
* Nacos名字服务
|
||||
*/
|
||||
private NamingService naming;
|
||||
|
||||
/**
|
||||
* nacos服务地址
|
||||
*/
|
||||
@Value("${spring.cloud.nacos.discovery.server-addr}")
|
||||
private String serverAddr;
|
||||
/**
|
||||
* nacos namespace
|
||||
*/
|
||||
@Value("${spring.cloud.nacos.discovery.namespace:#{null}}")
|
||||
private String namespace;
|
||||
|
||||
/**
|
||||
* nacos groupName
|
||||
*/
|
||||
@Value("${spring.cloud.nacos.config.group:DEFAULT_GROUP:#{null}}")
|
||||
private String group;
|
||||
|
||||
/**
|
||||
* nacos username
|
||||
*/
|
||||
@Value("${spring.cloud.nacos.discovery.username:#{null}}")
|
||||
private String username;
|
||||
/**
|
||||
* nacos password
|
||||
*/
|
||||
@Value("${spring.cloud.nacos.discovery.password:#{null}}")
|
||||
private String password;
|
||||
|
||||
/**
|
||||
* Swagger中需要排除的服务
|
||||
*/
|
||||
private String[] excludeServiceIds=new String[]{"jeecg-cloud-monitor"};
|
||||
|
||||
|
||||
/**
|
||||
* 网关应用名称
|
||||
*/
|
||||
@Value("${spring.application.name}")
|
||||
private String self;
|
||||
|
||||
@Autowired
|
||||
public MySwaggerResourceProvider(RouteLocator routeLocator) {
|
||||
this.routeLocator = routeLocator;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<SwaggerResource> get() {
|
||||
List<SwaggerResource> resources = new ArrayList<>();
|
||||
List<String> routeHosts = new ArrayList<>();
|
||||
// 获取所有可用的host:serviceId
|
||||
routeLocator.getRoutes().filter(route -> route.getUri().getHost() != null)
|
||||
.filter(route -> !self.equals(route.getUri().getHost()))
|
||||
.subscribe(route ->{
|
||||
//update-begin---author:zyf ---date:20220413 for:过滤掉无效路由,避免接口文档报错无法打开
|
||||
boolean hasRoute=checkRoute(route.getId());
|
||||
if(hasRoute){
|
||||
routeHosts.add(route.getUri().getHost());
|
||||
}
|
||||
//update-end---author:zyf ---date:20220413 for:过滤掉无效路由,避免接口文档报错无法打开
|
||||
});
|
||||
|
||||
// 记录已经添加过的server,存在同一个应用注册了多个服务在nacos上
|
||||
Set<String> dealed = new HashSet<>();
|
||||
routeHosts.forEach(instance -> {
|
||||
// 拼接url
|
||||
String url = "/" + instance.toLowerCase() + SWAGGER2URL;
|
||||
if (!dealed.contains(url)) {
|
||||
dealed.add(url);
|
||||
log.info(" Gateway add SwaggerResource: {}",url);
|
||||
SwaggerResource swaggerResource = new SwaggerResource();
|
||||
swaggerResource.setUrl(url);
|
||||
swaggerResource.setSwaggerVersion("2.0");
|
||||
swaggerResource.setName(instance);
|
||||
//Swagger排除不展示的服务
|
||||
if(!ArrayUtil.contains(excludeServiceIds,instance)){
|
||||
resources.add(swaggerResource);
|
||||
}
|
||||
}
|
||||
});
|
||||
return resources;
|
||||
}
|
||||
|
||||
/**
|
||||
* 检测nacos中是否有健康实例
|
||||
* @param routeId
|
||||
* @return
|
||||
*/
|
||||
private Boolean checkRoute(String routeId) {
|
||||
Boolean hasRoute = false;
|
||||
try {
|
||||
//修复使用带命名空间启动网关swagger看不到接口文档的问题
|
||||
Properties properties=new Properties();
|
||||
properties.setProperty("serverAddr",serverAddr);
|
||||
if(namespace!=null && !"".equals(namespace)){
|
||||
log.info("nacos.discovery.namespace = {}", namespace);
|
||||
properties.setProperty("namespace",namespace);
|
||||
}
|
||||
if(username!=null && !"".equals(username)){
|
||||
properties.setProperty("username",username);
|
||||
}
|
||||
if(password!=null && !"".equals(password)){
|
||||
properties.setProperty("password",password);
|
||||
}
|
||||
//【issues/5115】因swagger文档导致gateway内存溢出
|
||||
if (this.naming == null) {
|
||||
this.naming = NamingFactory.createNamingService(properties);
|
||||
}
|
||||
log.info(" config.group : {}", group);
|
||||
List<Instance> list = this.naming.selectInstances(routeId, group , true);
|
||||
if (ObjectUtil.isNotEmpty(list)) {
|
||||
hasRoute = true;
|
||||
}
|
||||
} catch (Exception e) {
|
||||
e.printStackTrace();
|
||||
}
|
||||
return hasRoute;
|
||||
}
|
||||
}
|
||||
//package org.jeecg.handler.swagger;
|
||||
//
|
||||
//import cn.hutool.core.util.ArrayUtil;
|
||||
//import cn.hutool.core.util.ObjectUtil;
|
||||
//import com.alibaba.nacos.api.naming.NamingFactory;
|
||||
//import com.alibaba.nacos.api.naming.NamingService;
|
||||
//import com.alibaba.nacos.api.naming.pojo.Instance;
|
||||
//import lombok.extern.slf4j.Slf4j;
|
||||
//import org.springframework.beans.factory.annotation.Autowired;
|
||||
//import org.springframework.beans.factory.annotation.Value;
|
||||
//import org.springframework.cloud.gateway.route.RouteLocator;
|
||||
//import org.springframework.context.annotation.Primary;
|
||||
//import org.springframework.stereotype.Component;
|
||||
//
|
||||
//import springfox.documentation.swagger.web.SwaggerResource;
|
||||
//import springfox.documentation.swagger.web.SwaggerResourcesProvider;
|
||||
//
|
||||
//import java.util.*;
|
||||
//
|
||||
///**
|
||||
// * 聚合各个服务的swagger接口
|
||||
// * @author zyf
|
||||
// * @date: 2022/4/21 10:55
|
||||
// */
|
||||
//@Component
|
||||
//@Slf4j
|
||||
//@Primary
|
||||
//public class MySwaggerResourceProvider implements SwaggerResourcesProvider {
|
||||
// /**
|
||||
// * swagger2默认的url后缀
|
||||
// */
|
||||
// private static final String SWAGGER2URL = "/v2/api-docs";
|
||||
//
|
||||
// /**
|
||||
// * 网关路由
|
||||
// */
|
||||
// private final RouteLocator routeLocator;
|
||||
// /**
|
||||
// * Nacos名字服务
|
||||
// */
|
||||
// private NamingService naming;
|
||||
//
|
||||
// /**
|
||||
// * nacos服务地址
|
||||
// */
|
||||
// @Value("${spring.cloud.nacos.discovery.server-addr}")
|
||||
// private String serverAddr;
|
||||
// /**
|
||||
// * nacos namespace
|
||||
// */
|
||||
// @Value("${spring.cloud.nacos.discovery.namespace:#{null}}")
|
||||
// private String namespace;
|
||||
//
|
||||
// /**
|
||||
// * nacos groupName
|
||||
// */
|
||||
// @Value("${spring.cloud.nacos.config.group:DEFAULT_GROUP:#{null}}")
|
||||
// private String group;
|
||||
//
|
||||
// /**
|
||||
// * nacos username
|
||||
// */
|
||||
// @Value("${spring.cloud.nacos.discovery.username:#{null}}")
|
||||
// private String username;
|
||||
// /**
|
||||
// * nacos password
|
||||
// */
|
||||
// @Value("${spring.cloud.nacos.discovery.password:#{null}}")
|
||||
// private String password;
|
||||
//
|
||||
// /**
|
||||
// * Swagger中需要排除的服务
|
||||
// */
|
||||
// private String[] excludeServiceIds=new String[]{"jeecg-cloud-monitor"};
|
||||
//
|
||||
//
|
||||
// /**
|
||||
// * 网关应用名称
|
||||
// */
|
||||
// @Value("${spring.application.name}")
|
||||
// private String self;
|
||||
//
|
||||
// @Autowired
|
||||
// public MySwaggerResourceProvider(RouteLocator routeLocator) {
|
||||
// this.routeLocator = routeLocator;
|
||||
// }
|
||||
//
|
||||
// @Override
|
||||
// public List<SwaggerResource> get() {
|
||||
// List<SwaggerResource> resources = new ArrayList<>();
|
||||
// List<String> routeHosts = new ArrayList<>();
|
||||
// // 获取所有可用的host:serviceId
|
||||
// routeLocator.getRoutes().filter(route -> route.getUri().getHost() != null)
|
||||
// .filter(route -> !self.equals(route.getUri().getHost()))
|
||||
// .subscribe(route ->{
|
||||
// //update-begin---author:zyf ---date:20220413 for:过滤掉无效路由,避免接口文档报错无法打开
|
||||
// boolean hasRoute=checkRoute(route.getId());
|
||||
// if(hasRoute){
|
||||
// routeHosts.add(route.getUri().getHost());
|
||||
// }
|
||||
// //update-end---author:zyf ---date:20220413 for:过滤掉无效路由,避免接口文档报错无法打开
|
||||
// });
|
||||
//
|
||||
// // 记录已经添加过的server,存在同一个应用注册了多个服务在nacos上
|
||||
// Set<String> dealed = new HashSet<>();
|
||||
// routeHosts.forEach(instance -> {
|
||||
// // 拼接url
|
||||
// String url = "/" + instance.toLowerCase() + SWAGGER2URL;
|
||||
// if (!dealed.contains(url)) {
|
||||
// dealed.add(url);
|
||||
// log.info(" Gateway add SwaggerResource: {}",url);
|
||||
// SwaggerResource swaggerResource = new SwaggerResource();
|
||||
// swaggerResource.setUrl(url);
|
||||
// swaggerResource.setSwaggerVersion("2.0");
|
||||
// swaggerResource.setName(instance);
|
||||
// //Swagger排除不展示的服务
|
||||
// if(!ArrayUtil.contains(excludeServiceIds,instance)){
|
||||
// resources.add(swaggerResource);
|
||||
// }
|
||||
// }
|
||||
// });
|
||||
// return resources;
|
||||
// }
|
||||
//
|
||||
// /**
|
||||
// * 检测nacos中是否有健康实例
|
||||
// * @param routeId
|
||||
// * @return
|
||||
// */
|
||||
// private Boolean checkRoute(String routeId) {
|
||||
// Boolean hasRoute = false;
|
||||
// try {
|
||||
// //修复使用带命名空间启动网关swagger看不到接口文档的问题
|
||||
// Properties properties=new Properties();
|
||||
// properties.setProperty("serverAddr",serverAddr);
|
||||
// if(namespace!=null && !"".equals(namespace)){
|
||||
// log.info("nacos.discovery.namespace = {}", namespace);
|
||||
// properties.setProperty("namespace",namespace);
|
||||
// }
|
||||
// if(username!=null && !"".equals(username)){
|
||||
// properties.setProperty("username",username);
|
||||
// }
|
||||
// if(password!=null && !"".equals(password)){
|
||||
// properties.setProperty("password",password);
|
||||
// }
|
||||
// //【issues/5115】因swagger文档导致gateway内存溢出
|
||||
// if (this.naming == null) {
|
||||
// this.naming = NamingFactory.createNamingService(properties);
|
||||
// }
|
||||
// log.info(" config.group : {}", group);
|
||||
// List<Instance> list = this.naming.selectInstances(routeId, group , true);
|
||||
// if (ObjectUtil.isNotEmpty(list)) {
|
||||
// hasRoute = true;
|
||||
// }
|
||||
// } catch (Exception e) {
|
||||
// e.printStackTrace();
|
||||
// }
|
||||
// return hasRoute;
|
||||
// }
|
||||
//}
|
||||
@ -1,41 +1,41 @@
|
||||
package org.jeecg.handler.swagger;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
import springfox.documentation.swagger.web.*;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* swagger聚合接口,三个接口都是 doc.html需要访问的接口
|
||||
* @author zyf
|
||||
* @date: 2022/4/21 10:55
|
||||
*/
|
||||
@RestController
|
||||
@RequestMapping("/swagger-resources")
|
||||
public class SwaggerResourceController {
|
||||
private MySwaggerResourceProvider swaggerResourceProvider;
|
||||
|
||||
@Autowired
|
||||
public SwaggerResourceController(MySwaggerResourceProvider swaggerResourceProvider) {
|
||||
this.swaggerResourceProvider = swaggerResourceProvider;
|
||||
}
|
||||
|
||||
@RequestMapping(value = "/configuration/security")
|
||||
public ResponseEntity<SecurityConfiguration> securityConfiguration() {
|
||||
return new ResponseEntity<>(SecurityConfigurationBuilder.builder().build(), HttpStatus.OK);
|
||||
}
|
||||
|
||||
@RequestMapping(value = "/configuration/ui")
|
||||
public ResponseEntity<UiConfiguration> uiConfiguration() {
|
||||
return new ResponseEntity<>(UiConfigurationBuilder.builder().build(), HttpStatus.OK);
|
||||
}
|
||||
|
||||
@RequestMapping
|
||||
public ResponseEntity<List<SwaggerResource>> swaggerResources() {
|
||||
return new ResponseEntity<>(swaggerResourceProvider.get(), HttpStatus.OK);
|
||||
}
|
||||
}
|
||||
//package org.jeecg.handler.swagger;
|
||||
//
|
||||
//import org.springframework.beans.factory.annotation.Autowired;
|
||||
//import org.springframework.http.HttpStatus;
|
||||
//import org.springframework.http.ResponseEntity;
|
||||
//import org.springframework.web.bind.annotation.RequestMapping;
|
||||
//import org.springframework.web.bind.annotation.RestController;
|
||||
//import springfox.documentation.swagger.web.*;
|
||||
//
|
||||
//import java.util.List;
|
||||
//
|
||||
///**
|
||||
// * swagger聚合接口,三个接口都是 doc.html需要访问的接口
|
||||
// * @author zyf
|
||||
// * @date: 2022/4/21 10:55
|
||||
// */
|
||||
//@RestController
|
||||
//@RequestMapping("/swagger-resources")
|
||||
//public class SwaggerResourceController {
|
||||
// private MySwaggerResourceProvider swaggerResourceProvider;
|
||||
//
|
||||
// @Autowired
|
||||
// public SwaggerResourceController(MySwaggerResourceProvider swaggerResourceProvider) {
|
||||
// this.swaggerResourceProvider = swaggerResourceProvider;
|
||||
// }
|
||||
//
|
||||
// @RequestMapping(value = "/configuration/security")
|
||||
// public ResponseEntity<SecurityConfiguration> securityConfiguration() {
|
||||
// return new ResponseEntity<>(SecurityConfigurationBuilder.builder().build(), HttpStatus.OK);
|
||||
// }
|
||||
//
|
||||
// @RequestMapping(value = "/configuration/ui")
|
||||
// public ResponseEntity<UiConfiguration> uiConfiguration() {
|
||||
// return new ResponseEntity<>(UiConfigurationBuilder.builder().build(), HttpStatus.OK);
|
||||
// }
|
||||
//
|
||||
// @RequestMapping
|
||||
// public ResponseEntity<List<SwaggerResource>> swaggerResources() {
|
||||
// return new ResponseEntity<>(swaggerResourceProvider.get(), HttpStatus.OK);
|
||||
// }
|
||||
//}
|
||||
@ -9,10 +9,9 @@ import com.alibaba.nacos.api.NacosFactory;
|
||||
import com.alibaba.nacos.api.config.ConfigService;
|
||||
import com.alibaba.nacos.api.config.listener.Listener;
|
||||
import com.alibaba.nacos.api.exception.NacosException;
|
||||
import com.alibaba.nacos.common.utils.StringUtils;
|
||||
import com.google.common.collect.Lists;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.apache.commons.lang3.ObjectUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.jeecg.common.base.BaseMap;
|
||||
import org.jeecg.common.constant.CacheConstant;
|
||||
import org.jeecg.common.util.RedisUtil;
|
||||
@ -32,6 +31,7 @@ import org.springframework.context.ApplicationEventPublisher;
|
||||
import org.springframework.context.ApplicationEventPublisherAware;
|
||||
import org.springframework.context.annotation.DependsOn;
|
||||
import org.springframework.stereotype.Component;
|
||||
import org.springframework.util.ObjectUtils;
|
||||
import reactor.core.publisher.Mono;
|
||||
|
||||
import java.net.URI;
|
||||
@ -170,9 +170,9 @@ public class DynamicRouteLoader implements ApplicationEventPublisherAware {
|
||||
dynamicRouteService.add(definition);
|
||||
}
|
||||
}
|
||||
if(ObjectUtils.isNotEmpty(baseMap)){
|
||||
if(!ObjectUtils.isEmpty(baseMap)){
|
||||
String delRouterId = baseMap.get("delRouterId");
|
||||
if (ObjectUtils.isNotEmpty(delRouterId)) {
|
||||
if (!ObjectUtils.isEmpty(delRouterId)) {
|
||||
dynamicRouteService.delete(delRouterId);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user