SpringCloudGateway

Spring Cloud Gateway 基于 Spring Boot 2.x, Spring WebFlux, and Project Reactor 。

因此一些同步库（Spring Data and Spring Security等）无法一起使用。

依赖运行时的Netty。

Eureka 自动服务发现配置

如果Eureka Server上有两个相同serviceId的服务时，SpringCloud Gateway会自动完成负载均衡。

# 服务名称
spring:
  application:
    name: spring-cloud-gateway
  # 开启 Gateway 服务注册中心服务发现（对内置支持的服务发现通用）
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
# Eureka Server 配置，不同的服务发现不同机制
eureka:
  client:
    service-url:
      defaultZone: http://localhost:10000/eureka/
# 配置Gateway日志等级，输出转发细节信息
logging:
  level:
    org.springframework.cloud.gateway: debug

spring.cloud.gateway.discovery.locator.enabled设置为true时，将 /serviceId/**匹配到对应的服务；并且将 /serviceId/(?<remaining>.*)URL重写为 /${remaining}。

过滤

gateway 只有俩种过滤器：“pre” 和 “post”。

• PRE： 这种过滤器在请求被路由之前调用。
• POST：这种过滤器在路由到微服务以后执行。

GatewayFilter 与 GlobalFilter。

• GlobalFilter： 全局过滤器
• GatewayFilter： 将应用到单个路由或者一个分组的路由上。

Websocket 配置

spring 默认支持 websocket

# websocket 的frame最大配置，默认64K
spring.cloud.gateway.httpclient.websocket.max-frame-payload-length
# Proxy ping frames to downstream services, defaults to true
spring.cloud.gateway.httpclient.websocket.proxy-ping

Swagger集成

采用 SpringDoc，重写 SwaggerUiConfigProperties 的配置信息。

• 引入 springdoc-openapi-webflux-ui依赖，而非springdoc-openapi-ui。

@Bean
public List<GroupedOpenApi> apis(SwaggerUiConfigProperties configProperties, RouteDefinitionLocator routeLocator) {
    List<GroupedOpenApi> groups = new ArrayList<>();
    // 获取所有可用的服务地址
    List<RouteDefinition> definitions = routeLocator.getRouteDefinitions().collectList().block();
    if (CollectionUtils.isEmpty(definitions)) {
        return groups;
    }
    Set<AbstractSwaggerUiConfigProperties.SwaggerUrl> urls = new HashSet<>();
    definitions.stream().filter(route -> route.getUri().getHost() != null)
        .distinct()
        .forEach(route -> {
                // service low case
                String name = route.getUri().getHost().toLowerCase(Locale.ROOT);
                // 排查 Eureka 和网关服务
                if (!name.contains("eureka") && !name.contains("gateway")) {
                    AbstractSwaggerUiConfigProperties.SwaggerUrl swaggerUrl = new AbstractSwaggerUiConfigProperties.SwaggerUrl();
                    swaggerUrl.setName(name);
                    swaggerUrl.setUrl(String.format(API_URI, name));
                    urls.add(swaggerUrl);
                }
            }
        );
    configProperties.setUrls(urls);
    return groups;
}