Spring Cloud Gateway -- 聚合swagger

我不是女神ヾ 2021-10-19 05:36 343阅读 0赞

### Spring Cloud Gateway -- 聚合swagger ###

*  前言
 *  Gateway的搭建
 *   *  配置文件
     *  全局Filter设置

# 前言 #

传统服务变成微服务架构之后，如果我们需要访问各个服务的swagger文档，通过不同端口号去访问比较麻烦。我们可以通过Gateway来聚合swagger文档，通过同一端口加项目名称的形式来访问。

# Gateway的搭建 #

## 配置文件 ##

server:
      port: 8010
    spring:
      application:
        name: ljl-gateway
      cloud:
        gateway:
         discovery:
            locator:
             enabled: true
             # 项目名称可以小写
             lowerCaseServiceId: true
    
    # 将自身也加入eureka中
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8012/eureka/

## 全局Filter设置 ##

由于我们通过Gateway来聚合swagger，但是利用swagger进行测试接口的时候，发现Gateway并没有帮把项目名称带上去，导致了虽然可以查看各个服务的接口文档，但是测试不了。  
测试中发现在Swagger中会根据X-Forwarded-Prefix这个Header来获取BasePath，将它添加至接口路径与host中间，这样才能正常做接口测试。所有我们就设置一个全局Filter。

package com.ljl.filter;
    
    
    import com.ljl.config.SwaggerProvider;
    import org.springframework.cloud.gateway.filter.GatewayFilter;
    import org.springframework.cloud.gateway.filter.GatewayFilterChain;
    import org.springframework.cloud.gateway.filter.GlobalFilter;
    import org.springframework.core.Ordered;
    import org.springframework.http.server.reactive.ServerHttpRequest;
    import org.springframework.stereotype.Component;
    import org.springframework.util.StringUtils;
    import org.springframework.web.server.ServerWebExchange;
    import reactor.core.publisher.Mono;
    
    /** * 通估设置一个全局的Filter, */
    @Component
    public class SwaggerHeaderFilter implements GlobalFilter, Ordered { 
    
        private static final String HEADER_NAME = "X-Forwarded-Prefix";
    
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { 
                ServerHttpRequest request = exchange.getRequest();
                String path = request.getURI().getPath();
                if (!StringUtils.endsWithIgnoreCase(path, SwaggerProvider.API_URI)) { 
                    return chain.filter(exchange);
                }
                String basePath = path.substring(0, path.lastIndexOf(SwaggerProvider.API_URI));
                System.out.print("basePath: "+basePath);
                ServerHttpRequest newRequest = request.mutate().header(HEADER_NAME, basePath).build();
                ServerWebExchange newExchange = exchange.mutate().request(newRequest).build();
                return chain.filter(newExchange);
        }
    
        @Override
        public int getOrder() { 
            return -200;
        }
    }

package com.ljl.config;
    
    import org.springframework.cloud.gateway.config.GatewayProperties;
    import org.springframework.cloud.gateway.discovery.DiscoveryClientRouteDefinitionLocator;
    import org.springframework.cloud.gateway.route.Route;
    import org.springframework.cloud.gateway.route.RouteLocator;
    import org.springframework.cloud.gateway.support.NameUtils;
    import org.springframework.context.annotation.Primary;
    import org.springframework.stereotype.Component;
    import reactor.core.publisher.Flux;
    import springfox.documentation.swagger.web.SwaggerResource;
    import springfox.documentation.swagger.web.SwaggerResourcesProvider;
    
    import java.util.ArrayList;
    import java.util.List;
    
    @Component
    @Primary
    public class SwaggerProvider implements SwaggerResourcesProvider { 
    
        public static final String API_URI = "/v2/api-docs";
        public static final String EUREKA_SUB_PRIX = "CompositeDiscoveryClient_";
        private final DiscoveryClientRouteDefinitionLocator routeLocator;
        public SwaggerProvider(DiscoveryClientRouteDefinitionLocator routeLocator) { 
            this.routeLocator = routeLocator;
        }
    
        @Override
        public List<SwaggerResource> get() { 
            List<SwaggerResource> resources = new ArrayList<>();
            List<String> routes = new ArrayList<>();
            //从DiscoveryClientRouteDefinitionLocator 中取出routes，构造成swaggerResource
            routeLocator.getRouteDefinitions().subscribe(routeDefinition -> { 
                resources.add(swaggerResource(routeDefinition.getId().substring(EUREKA_SUB_PRIX.length()),routeDefinition.getPredicates().get(0).getArgs().get("pattern").replace("/**", API_URI)));
            });
            return resources;
        }
    
        private SwaggerResource swaggerResource(String name, String location) { 
            SwaggerResource swaggerResource = new SwaggerResource();
            swaggerResource.setName(name);
            swaggerResource.setLocation(location);
            swaggerResource.setSwaggerVersion("2.0");
            return swaggerResource;
        }
    
    }

再次访问http://localhost:8010/ljl-server-base/swagger-ui.html 并测试接口 发现测试成功。  
大功告成！