每日观察!Spring Cloud Gateway路由元信息作用及路由超时配置详解

环境：Spring Cloud Gateway 3.1.4

(相关资料图)

路由元信息配置

你可以使用元数据为每个路由配置其他参数，如下所示：

spring:  cloud:    gateway:      routes:      - id: route_with_metadata        uri: https://pack.com        metadata:          zone: "xj"          infos:            name: "value"          weight: 0.2

可以通过ServerWebExchange中获取所有元数据属性，如下所示:

// 获取路由对象Route route = exchange.getAttribute(GATEWAY_ROUTE_ATTR);// 获取路由元信息route.getMetadata();// 获取某一个元信息route.getMetadata(someKey);

上面exchange.getAttribute方法获取路由对象是在通过HandlerMapping对象查找路由对象时设置到当前的上下文中的，如下：

public class RoutePredicateHandlerMapping extends AbstractHandlerMapping {  private final FilteringWebHandler webHandler;  public RoutePredicateHandlerMapping(FilteringWebHandler webHandler, ...) {    this.webHandler = webHandler;    // ...  }  protected Mono getHandlerInternal(ServerWebExchange exchange) {    // 查找路由    return lookupRoute(exchange)      .flatMap((Function>) r -> {        exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR);        // 将查找到的路由保存到当前的执行上下文中        exchange.getAttributes().put(GATEWAY_ROUTE_ATTR, r);        return Mono.just(webHandler);      }).switchIfEmpty(Mono.empty().then(Mono.fromRunnable(() -> {        exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR);      })));  }}

路由的超时配置就是通过元信息的配置来设置的，接下来就是路由超时相关的讲解。

路由(http)超时配置

Http超时（响应和连接）可以为所有路由配置，并为还可以为每个特定路由覆盖。

全局超时配置

要配置全局http超时：连接超时必须以毫秒为单位指定。响应超时必须指定为java.time.Duration

spring:  cloud:    gateway:      httpclient:        connect-timeout: 1000        response-timeout: 5s

每个路由配置超时

要配置每个路由超时：连接超时必须以毫秒为单位指定。响应超时必须以毫秒为单位指定。

- id: per_route_timeouts  uri: https://example.org  predicates:  - name: Path    args:    pattern: /delay/{timeout}  metadata:    response-timeout: 200    connect-timeout: 200

使用Java DSL的每个路由超时配置：

import static org.springframework.cloud.gateway.support.RouteMetadataUtils.CONNECT_TIMEOUT_ATTR;import static org.springframework.cloud.gateway.support.RouteMetadataUtils.RESPONSE_TIMEOUT_ATTR;@Beanpublic RouteLocator customRouteLocator(RouteLocatorBuilder routeBuilder){  return routeBuilder.routes()    .route("test1", r -> {      return r.host("*.somehost.org").and().path("/somepath")        .filters(f -> f.addRequestHeader("header1", "header-value-1"))        .uri("http://someuri")        .metadata(RESPONSE_TIMEOUT_ATTR, 200)        .metadata(CONNECT_TIMEOUT_ATTR, 200);  })  .build();}

超时时间配置为负值的每条路由响应超时将禁用全局响应超时值。

- id: per_route_timeouts  uri: https://example.org  predicates:  - name: Path    args:    pattern: /delay/{timeout}  metadata:    response-timeout: -1

流式的Java路由API

@Beanpublic RouteLocator customRouteLocator(RouteLocatorBuilder builder, ThrottleGatewayFilterFactory throttle) {  return builder.routes()    .route(r -> r.host("**.abc.org").and().path("/image/png")      .filters(f -> f.addResponseHeader("X-TestHeader", "foobar"))      .uri("http://httpbin.org:80")    )    .route(r -> r.path("/image/webp")      .filters(f -> f.addResponseHeader("X-AnotherHeader", "baz"))      .uri("http://httpbin.org:80")      .metadata("key", "value")    )    .route(r -> r.order(-1)      .host("**.throttle.org").and().path("/get")      .filters(f -> f.filter(throttle.apply(1,1,10,TimeUnit.SECONDS)))      .uri("http://httpbin.org:80")      .metadata("name", "pack")    )    .build();}

这种风格还允许更多的自定义谓词断言。RouteDefinitionLocator bean定义的谓词使用逻辑和进行组合。通过使用流畅的Java API，可以在Predicate类上使用and()、or()和negate()操作符。

DiscoveryClient路由定义定位器

你可以将网关配置为基于在DiscoveryClient兼容服务注册表中注册的服务创建路由。直接通过服务实例访问路由

要启用此功能，需要将spring.cloud.gateway.decovery.locator.enabled设置为true，并确保DiscoveryClient实现（如Netflix Eureka、Consul、Zookeeper或Nacos）位于类路径上并已启用。

默认情况下，网关为使用DiscoveryClient创建的路由定义一个谓词和筛选器。

默认谓词是使用模式/serviceId/**定义的路径谓词，其中serviceId是DiscoveryClient中服务的ID（注册中心注册的服务名称，主要就是spring.application.name）。

默认的过滤器是重写路径过滤器，regex/serviceId/?(? .*)和替换的/${remaining}。这将在请求发送到下游之前从路径中剥离服务ID。

如果你想自定义DiscoveryClient路由使用的谓词或过滤器，请设置spring.cloud.gateway.discovery.locator.predicates[x]和spring.cloud.gateway.discovery.locator.filters[y]。这样做时，如果你希望保留该功能，则需要确保包含前面所示的默认谓词和过滤器。下面的例子展示了它的样子:

spring.cloud.gateway.discovery.locator.predicates[0].name: Pathspring.cloud.gateway.discovery.locator.predicates[0].args[pattern]: ""/"+serviceId+"/**""spring.cloud.gateway.discovery.locator.predicates[1].name: Hostspring.cloud.gateway.discovery.locator.predicates[1].args[pattern]: ""**.foo.com""spring.cloud.gateway.discovery.locator.filters[0].name: CircuitBreakerspring.cloud.gateway.discovery.locator.filters[0].args[name]: serviceIdspring.cloud.gateway.discovery.locator.filters[1].name: RewritePathspring.cloud.gateway.discovery.locator.filters[1].args[regexp]: ""/" + serviceId + "/?(?.*)""spring.cloud.gateway.discovery.locator.filters[1].args[replacement]: ""/${remaining}""

完毕！！！