SpringCloud Gateway---SpringCloud网关

原创已于 2022-06-06 16:58:06 修改 · 1k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring cloud

于 2021-10-19 18:56:24 首次发布

SpringCloud 专栏收录该内容

6 篇文章

订阅专栏

本文深入探讨SpringCloudGateway在分布式系统中的作用，作为一款功能丰富的微服务网关，它提供了路由、流量控制、熔断降级和安全验证等功能。相较于nginx，Gateway在实现上更广泛。基于SpringWebflux的实现，Gateway在高网络IO场景下表现出更好的吞吐量和伸缩性。文章还详细介绍了路由谓词工厂和过滤器的使用，包括自定义过滤器的实现，并指出在yaml配置中无法直接配置读取请求body。最后，讨论了如何在代码中处理和修改转发请求的Body。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringCloud Gateway：

作用：

用于分布式系统，可进行路由、流量控制、熔断降级、安全验证等操作。功能与nginx相近但比nginx实现的功能更广。gateway用作网关，接入web请求和webmvc处理web请求基本相似，只是实现上不同。

实现方式：

SpringBoot Gateway基于Spring Webflux实现。

Spring Webflux与SpringMVC：

Spring Webflux是一种异步非阻塞框架，SpringMVC是一种同步阻塞框架。Spring Webflux相比于SpringMVC无法提升处理速度，但能提升吞吐量与伸缩性，适用于高网络IO情况下，比如网关。

Spring Webflux无法替代SpringMVC，其存在难编码、debug、测试等问题，故只在高网络IO情况或者项目存在大量异步操作情况下使用。

请求处理流程图如下：

粗略流程图：

请求访问gateway client
请求经过handler mapping，根据predicate选择匹配的路由
请求根据匹配路由执行定义的pre过滤器（对请求数据进行验证）
请求根据匹配路由执行定义的post过滤器（对响应数据进行操作）

详细流程图：

图参考博文：springcloud gateway请求处理流程

路由谓词Predicate：

请求验证路由谓词工厂种类：

SpringCloud gateway内嵌了十一种请求验证谓词工厂可使用（不包括ReadBodyRouteRedicateFactory），每个工厂分别通过对应不同方面predicate的对路由进行匹配。可从yml配置文件配置与java代码配置两个方面进行调用。

其中的After路由谓词工厂yml配置文件配置使用示例：

名称使用路由谓词工厂前缀，工厂作用使用其中apply方法提供相应细粒度的GatewayFilter过滤器，可自定义路由谓词工厂以及其中apply方法响应的GatewayFilter过滤器。

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]

参考博文：spring cloud gateway-路由谓词RoutePredicate、RoutePredicateFactory

路由过滤器Filter：

路由过滤器分为局部过滤器GatewayFilter与全局过滤器GlobalFilters，可使用内置过滤器也可使用自定义过滤器，使用起来与Spring过滤器相似。

内置局部过滤器有：30种

其中AddRequestHeader过滤器yml配置使用示例：

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
        - AddRequestHeader=X-Request-red, blue

内置全局过滤器有：9种

`ReactiveLoadBalancerClientFilter使用示例：`

lb代表使用了负载均衡策略。

spring:
  cloud:
    gateway:
      routes:
      - id: myRoute
        uri: lb://service
        predicates:
        - Path=/service/**

内置 Http头部过滤器：3种

HttpHeadersFilters 在向下游发送请求之前应用于请求，例如在NettyRoutingFilter。

在yml配置文件种配置。

自定义过滤器并使用示例：

局部过滤器（细粒度过滤）：

@Slf4j
@Component
public class MyGatewayFilter implements GatewayFilter, Ordered {

    //设置readme，即使用ReadBodyRoutePredicateFactory，后通过ServerWebExchange该字段属性可重复读取request body
    private static final String CACHE_REQUEST_BODY_OBJECT_KEY = "cachedRequestBodyObject";

    //过滤器逻辑
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("chain.filter执行前为pre过滤操作");
        return chain.filter(exchange).then(
                Mono.fromRunnable(() -> {
                    log.info("chain.filter执行后为post过滤操作");
                })
        );

    }
    //设定过滤器优先级别
    @Override
    public int getOrder() {
        return 0;
    }
}

@Configuration
public class GateWayConfig {

    @Autowired
    MyGatewayFilter myGatewayFilter

    //局部过滤器需要在设置路由时将过滤器加入对应路由
    @Bean
    public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route(r -> r.path("/testFilter/**")
                        .and()
                        .readBody(String.class, requestBody -> true)
                        .filters(f -> f.filter(myGatewayFilter))
                        .uri("lb://mytest"))
                )
                .build();
    }
}

全局过滤器：

public class YourFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("全局过滤器，直接应用于全局路由过滤");
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}