✨ Introducing new features. #1899 up swagger 3.0 重构 common-swagger 模块

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/PigxGatewayApplication.java

@@ -20,6 +20,7 @@
 package com.pig4cloud.pigx.gateway;
 
 import com.pig4cloud.pigx.common.gateway.annotation.EnablePigxDynamicRoute;
+import com.pig4cloud.pigx.common.swagger.annotation.EnablePigxSwagger2;
 import org.springframework.boot.SpringApplication;
 import org.springframework.cloud.client.SpringCloudApplication;
 
@@ -27,6 +28,7 @@ import org.springframework.cloud.client.SpringCloudApplication;
  * @author lengleng
  * @date 2018年06月21日 网关应用
  */
+@EnablePigxSwagger2
 @EnablePigxDynamicRoute
 @SpringCloudApplication
 public class PigxGatewayApplication {

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/config/FilterIgnorePropertiesConfig.java

@@ -1,44 +0,0 @@
-/*
- *    Copyright (c) 2018-2025, lengleng All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * Neither the name of the pig4cloud.com developer nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- * Author: lengleng (wangiegie@gmail.com)
- */
-
-package com.pig4cloud.pigx.gateway.config;
-
-import lombok.Data;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
-import org.springframework.boot.context.properties.ConfigurationProperties;
-import org.springframework.cloud.context.config.annotation.RefreshScope;
-import org.springframework.context.annotation.Configuration;
-
-import java.util.ArrayList;
-import java.util.List;
-
-/**
- * @author lengleng
- * @date 2018/7/22 网关不校验终端配置
- */
-@Data
-@Configuration
-@RefreshScope
-@ConditionalOnExpression("!'${ignore}'.isEmpty()")
-@ConfigurationProperties(prefix = "ignore")
-public class FilterIgnorePropertiesConfig {
-
-	private List<String> clients = new ArrayList<>();
-
-	private List<String> swaggerProviders = new ArrayList<>();
-
-}

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/config/GatewayConfigProperties.java

@@ -0,0 +1,32 @@
+package com.pig4cloud.pigx.gateway.config;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.cloud.context.config.annotation.RefreshScope;
+import org.springframework.stereotype.Component;
+
+import java.util.List;
+
+/**
+ * @author lengleng
+ * @date 2020/10/2
+ * <p>
+ * 网关通用配置文件
+ */
+@Data
+@Component
+@RefreshScope
+@ConfigurationProperties("gateway")
+public class GatewayConfigProperties {
+
+	/**
+	 * 网关解密登录前端密码 秘钥 {@link com.pig4cloud.pigx.gateway.filter.PasswordDecoderFilter}
+	 */
+	public String encodeKey;
+
+	/**
+	 * 网关不需要校验验证码的客户端 {@link com.pig4cloud.pigx.gateway.filter.ValidateCodeGatewayFilter}
+	 */
+	public List<String> ignoreClient;
+
+}

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/config/RouterFunctionConfiguration.java

@@ -17,7 +17,8 @@
 
 package com.pig4cloud.pigx.gateway.config;
 
-import com.pig4cloud.pigx.gateway.handler.*;
+import com.pig4cloud.pigx.gateway.handler.ImageCodeCheckHandler;
+import com.pig4cloud.pigx.gateway.handler.ImageCodeCreateHandler;
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.context.annotation.Bean;
@@ -40,25 +41,13 @@ public class RouterFunctionConfiguration {
 
 	private final ImageCodeCreateHandler imageCodeCreateHandler;
 
-	private final SwaggerResourceHandler swaggerResourceHandler;
-
-	private final SwaggerSecurityHandler swaggerSecurityHandler;
-
-	private final SwaggerUiHandler swaggerUiHandler;
-
 	@Bean
 	public RouterFunction routerFunction() {
 		return RouterFunctions
 				.route(RequestPredicates.path("/code").and(RequestPredicates.accept(MediaType.TEXT_PLAIN)),
 						imageCodeCreateHandler)
 				.andRoute(RequestPredicates.POST("/code/check").and(RequestPredicates.accept(MediaType.ALL)),
-						imageCodeCheckHandler)
-				.andRoute(RequestPredicates.GET("/swagger-resources").and(RequestPredicates.accept(MediaType.ALL)),
-						swaggerResourceHandler)
-				.andRoute(RequestPredicates.GET("/swagger-resources/configuration/ui")
-						.and(RequestPredicates.accept(MediaType.ALL)), swaggerUiHandler)
-				.andRoute(RequestPredicates.GET("/swagger-resources/configuration/security")
-						.and(RequestPredicates.accept(MediaType.ALL)), swaggerSecurityHandler);
+						imageCodeCheckHandler);
 
 	}
 

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/config/SwaggerProvider.java

@@ -1,71 +0,0 @@
-/*
- *    Copyright (c) 2018-2025, lengleng All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * Neither the name of the pig4cloud.com developer nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- * Author: lengleng (wangiegie@gmail.com)
- */
-
-package com.pig4cloud.pigx.gateway.config;
-
-import lombok.AllArgsConstructor;
-import org.springframework.cloud.gateway.route.RouteDefinition;
-import org.springframework.cloud.gateway.route.RouteDefinitionRepository;
-import org.springframework.cloud.gateway.support.NameUtils;
-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.ArrayList;
-import java.util.Comparator;
-import java.util.List;
-import java.util.stream.Collectors;
-
-/**
- * @author Sywd 聚合接口文档注册，和zuul实现类似
- */
-@Component
-@Primary
-@AllArgsConstructor
-public class SwaggerProvider implements SwaggerResourcesProvider {
-
-	private static final String API_URI = "/v2/api-docs";
-
-	private final RouteDefinitionRepository routeDefinitionRepository;
-
-	private final FilterIgnorePropertiesConfig filterIgnorePropertiesConfig;
-
-	@Override
-	public List<SwaggerResource> get() {
-		List<RouteDefinition> routes = new ArrayList<>();
-		routeDefinitionRepository.getRouteDefinitions().subscribe(routes::add);
-		return routes.stream()
-				.flatMap(routeDefinition -> routeDefinition.getPredicates().stream()
-						.filter(predicateDefinition -> "Path".equalsIgnoreCase(predicateDefinition.getName()))
-						.filter(predicateDefinition -> !filterIgnorePropertiesConfig.getSwaggerProviders()
-								.contains(routeDefinition.getId()))
-						.map(predicateDefinition -> swaggerResource(routeDefinition.getId(),
-								predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0").replace("/**",
-										API_URI))))
-				.sorted(Comparator.comparing(SwaggerResource::getName)).collect(Collectors.toList());
-	}
-
-	private static SwaggerResource swaggerResource(String name, String location) {
-		SwaggerResource swaggerResource = new SwaggerResource();
-		swaggerResource.setName(name);
-		swaggerResource.setLocation(location);
-		swaggerResource.setSwaggerVersion("2.0");
-		return swaggerResource;
-	}
-
-}

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/filter/PasswordDecoderFilter.java

@@ -25,8 +25,9 @@ import cn.hutool.crypto.Padding;
 import cn.hutool.crypto.symmetric.AES;
 import cn.hutool.http.HttpUtil;
 import com.pig4cloud.pigx.common.core.constant.SecurityConstants;
+import com.pig4cloud.pigx.gateway.config.GatewayConfigProperties;
 import lombok.extern.slf4j.Slf4j;
-import org.springframework.beans.factory.annotation.Value;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.cloud.gateway.filter.GatewayFilter;
 import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
 import org.springframework.cloud.gateway.filter.factory.rewrite.CachedBodyOutputMessage;
@@ -69,8 +70,8 @@ public class PasswordDecoderFilter extends AbstractGatewayFilterFactory {
 
 	private static final String KEY_ALGORITHM = "AES";
 
-	@Value("${security.encode.key:1234567812345678}")
-	private String encodeKey;
+	@Autowired
+	private GatewayConfigProperties gatewayConfig;
 
 	@Override
 	public GatewayFilter apply(Object config) {
@@ -115,8 +116,9 @@ public class PasswordDecoderFilter extends AbstractGatewayFilterFactory {
 	private Function decryptAES() {
 		return s -> {
 			// 构建前端对应解密AES 因子
-			AES aes = new AES(Mode.CBC, Padding.NoPadding, new SecretKeySpec(encodeKey.getBytes(), KEY_ALGORITHM),
-					new IvParameterSpec(encodeKey.getBytes()));
+			AES aes = new AES(Mode.CBC, Padding.NoPadding,
+					new SecretKeySpec(gatewayConfig.getEncodeKey().getBytes(), KEY_ALGORITHM),
+					new IvParameterSpec(gatewayConfig.getEncodeKey().getBytes()));
 
 			// 获取请求密码并解密
 			Map<String, String> inParamsMap = HttpUtil.decodeParamMap((String) s, CharsetUtil.CHARSET_UTF_8);

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/filter/ValidateCodeGatewayFilter.java

@@ -30,7 +30,7 @@ import com.pig4cloud.pigx.common.core.exception.ValidateCodeException;
 import com.pig4cloud.pigx.common.core.util.R;
 import com.pig4cloud.pigx.common.core.util.SpringContextHolder;
 import com.pig4cloud.pigx.common.core.util.WebUtils;
-import com.pig4cloud.pigx.gateway.config.FilterIgnorePropertiesConfig;
+import com.pig4cloud.pigx.gateway.config.GatewayConfigProperties;
 import lombok.AllArgsConstructor;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
@@ -59,7 +59,7 @@ public class ValidateCodeGatewayFilter extends AbstractGatewayFilterFactory {
 
 	private final RedisTemplate redisTemplate;
 
-	private final FilterIgnorePropertiesConfig filterIgnorePropertiesConfig;
+	private final GatewayConfigProperties gatewayConfig;
 
 	@Override
 	public GatewayFilter apply(Object config) {
@@ -82,7 +82,7 @@ public class ValidateCodeGatewayFilter extends AbstractGatewayFilterFactory {
 			try {
 				String header = request.getHeaders().getFirst(HttpHeaders.AUTHORIZATION);
 				String clientId = WebUtils.extractClientId(header).orElse(null);
-				if (StrUtil.isNotBlank(clientId) && filterIgnorePropertiesConfig.getClients().contains(clientId)) {
+				if (StrUtil.isNotBlank(clientId) && gatewayConfig.getIgnoreClient().contains(clientId)) {
 					return chain.filter(exchange);
 				}
 

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/handler/ImageCodeCheckHandler.java

@@ -24,7 +24,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 import com.pig4cloud.pigx.common.core.constant.CommonConstants;
 import com.pig4cloud.pigx.common.core.util.R;
 import com.pig4cloud.pigx.common.core.util.SpringContextHolder;
-import lombok.AllArgsConstructor;
+import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
@@ -42,7 +42,7 @@ import reactor.core.publisher.Mono;
  */
 @Slf4j
 @Component
-@AllArgsConstructor
+@RequiredArgsConstructor
 public class ImageCodeCheckHandler implements HandlerFunction<ServerResponse> {
 
 	private final ObjectMapper objectMapper;

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/handler/ImageCodeCreateHandler.java

@@ -24,7 +24,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 import com.pig4cloud.pigx.common.core.constant.CommonConstants;
 import com.pig4cloud.pigx.common.core.util.R;
 import com.pig4cloud.pigx.common.core.util.SpringContextHolder;
-import lombok.AllArgsConstructor;
+import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.HttpStatus;
@@ -42,7 +42,7 @@ import reactor.core.publisher.Mono;
  */
 @Slf4j
 @Component
-@AllArgsConstructor
+@RequiredArgsConstructor
 public class ImageCodeCreateHandler implements HandlerFunction<ServerResponse> {
 
 	private final ObjectMapper objectMapper;

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/handler/SwaggerResourceHandler.java

@@ -1,54 +0,0 @@
-/*
- *    Copyright (c) 2018-2025, lengleng All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * Neither the name of the pig4cloud.com developer nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- * Author: lengleng (wangiegie@gmail.com)
- */
-
-package com.pig4cloud.pigx.gateway.handler;
-
-import lombok.AllArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.MediaType;
-import org.springframework.stereotype.Component;
-import org.springframework.web.reactive.function.BodyInserters;
-import org.springframework.web.reactive.function.server.HandlerFunction;
-import org.springframework.web.reactive.function.server.ServerRequest;
-import org.springframework.web.reactive.function.server.ServerResponse;
-import reactor.core.publisher.Mono;
-import springfox.documentation.swagger.web.SwaggerResourcesProvider;
-
-/**
- * @author lengleng
- * @date 2018-07-19 SwaggerResourceHandler
- */
-@Slf4j
-@Component
-@AllArgsConstructor
-public class SwaggerResourceHandler implements HandlerFunction<ServerResponse> {
-
-	private final SwaggerResourcesProvider swaggerResources;
-
-	/**
-	 * Handle the given request.
-	 * @param request the request to handler
-	 * @return the response
-	 */
-	@Override
-	public Mono<ServerResponse> handle(ServerRequest request) {
-		return ServerResponse.status(HttpStatus.OK).contentType(MediaType.APPLICATION_JSON)
-				.body(BodyInserters.fromValue(swaggerResources.get()));
-	}
-
-}

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/handler/SwaggerSecurityHandler.java

@@ -1,58 +0,0 @@
-/*
- *    Copyright (c) 2018-2025, lengleng All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * Neither the name of the pig4cloud.com developer nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- * Author: lengleng (wangiegie@gmail.com)
- */
-
-package com.pig4cloud.pigx.gateway.handler;
-
-import lombok.extern.slf4j.Slf4j;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.MediaType;
-import org.springframework.stereotype.Component;
-import org.springframework.web.reactive.function.BodyInserters;
-import org.springframework.web.reactive.function.server.HandlerFunction;
-import org.springframework.web.reactive.function.server.ServerRequest;
-import org.springframework.web.reactive.function.server.ServerResponse;
-import reactor.core.publisher.Mono;
-import springfox.documentation.swagger.web.SecurityConfiguration;
-import springfox.documentation.swagger.web.SecurityConfigurationBuilder;
-
-import java.util.Optional;
-
-/**
- * @author lengleng
- * @date 2018-07-19 SwaggerSecurityHandler
- */
-@Slf4j
-@Component
-public class SwaggerSecurityHandler implements HandlerFunction<ServerResponse> {
-
-	@Autowired(required = false)
-	private SecurityConfiguration securityConfiguration;
-
-	/**
-	 * Handle the given request.
-	 * @param request the request to handler
-	 * @return the response
-	 */
-	@Override
-	public Mono<ServerResponse> handle(ServerRequest request) {
-		return ServerResponse.status(HttpStatus.OK).contentType(MediaType.APPLICATION_JSON)
-				.body(BodyInserters.fromValue(Optional.ofNullable(securityConfiguration)
-						.orElse(SecurityConfigurationBuilder.builder().build())));
-	}
-
-}

pigx-gateway/src/main/java/com/pig4cloud/pigx/gateway/handler/SwaggerUiHandler.java

@@ -1,57 +0,0 @@
-/*
- *    Copyright (c) 2018-2025, lengleng All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * Neither the name of the pig4cloud.com developer nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- * Author: lengleng (wangiegie@gmail.com)
- */
-
-package com.pig4cloud.pigx.gateway.handler;
-
-import lombok.extern.slf4j.Slf4j;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.MediaType;
-import org.springframework.stereotype.Component;
-import org.springframework.web.reactive.function.BodyInserters;
-import org.springframework.web.reactive.function.server.HandlerFunction;
-import org.springframework.web.reactive.function.server.ServerRequest;
-import org.springframework.web.reactive.function.server.ServerResponse;
-import reactor.core.publisher.Mono;
-import springfox.documentation.swagger.web.UiConfiguration;
-import springfox.documentation.swagger.web.UiConfigurationBuilder;
-
-import java.util.Optional;
-
-/**
- * @author lengleng
- * @date 2018-07-19 SwaggerUiHandler
- */
-@Slf4j
-@Component
-public class SwaggerUiHandler implements HandlerFunction<ServerResponse> {
-
-	@Autowired(required = false)
-	private UiConfiguration uiConfiguration;
-
-	/**
-	 * Handle the given request.
-	 * @param request the request to handler
-	 * @return the response
-	 */
-	@Override
-	public Mono<ServerResponse> handle(ServerRequest request) {
-		return ServerResponse.status(HttpStatus.OK).contentType(MediaType.APPLICATION_JSON).body(BodyInserters
-				.fromValue(Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build())));
-	}
-
-}