12. Http超时配置

可以为所有路由配置 HTTP 超时(响应和连接),并为每个特定路由覆盖这些超时。spring-doc.cadn.net.cn

12.1. 全局超时

要配置全局 HTTP 超时时间,请执行以下操作:
connect-timeout必须以毫秒为单位指定。
response-timeout必须指定为java.time.Durationspring-doc.cadn.net.cn

全局 HTTP 超时示例
spring:
  cloud:
    gateway:
      httpclient:
        connect-timeout: 1000
        response-timeout: 5s

12.2. 每路由超时时间

为了配置每个路由的超时时间:<br/>
connect-timeout必须以毫秒为单位指定。
response-timeout必须以毫秒为单位指定。spring-doc.cadn.net.cn

通过配置进行每路由 HTTP 超时配置
      - 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;

      @Bean
      public 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();
      }

12.3. 流式 Java 路由器 API

为了在 Java 中实现简单的配置,RouteLocatorBuilder Bean 包含了一个流畅式 API。
以下列表展示了其工作方式:spring-doc.cadn.net.cn

示例 66. GatewaySampleApplication.java
// static imports from GatewayFilters and RoutePredicates
@Bean
public 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("key", "value")
            )
            .build();
}

这种风格还允许进行更多自定义谓词断言。由 RouteDefinitionLocator 个 Bean 定义的谓词使用逻辑 and 进行组合。通过使用流畅的 Java API,您可以在 Predicate 类上使用 and()or()negate() 运算符。spring-doc.cadn.net.cn

12.4. 路由定义定位器 DiscoveryClient

您可以配置网关根据服务注册表中与DiscoveryClient兼容的服务注册表注册的服务创建路由。spring-doc.cadn.net.cn

要启用此功能,请设置spring.cloud.gateway.discovery.locator.enabled=true,并确保classpath上有一个DiscoveryClient实现(如Netflix Eureka、Consul或Zookeeper),并已启用。spring-doc.cadn.net.cn

12.4.1. 配置 0 条路线的谓词和过滤器

默认情况下,网关为使用 DiscoveryClient 创建的路由定义一个单独的谓词和过滤器。spring-doc.cadn.net.cn

默认谓词是使用模式 0 定义的路径谓词,其中 1 是来自 2 的服务的 ID。spring-doc.cadn.net.cn

默认的过滤器是一个路径重写过滤器,使用正则表达式 /serviceId/?(?<remaining>.*) 和替换 /${remaining}。 这会在请求发送到下游之前,从路径中剥离服务ID。spring-doc.cadn.net.cn

如果您要自定义由DiscoveryClient路由使用的谓词或过滤器,请设置spring.cloud.gateway.discovery.locator.predicates[x]spring.cloud.gateway.discovery.locator.filters[y]。 当执行此操作时,您需要确保包括前面显示的默认谓词和筛选器,如果您要保留该功能。 下面的示例显示了它的外观:spring-doc.cadn.net.cn

Example 67. application.properties
spring.cloud.gateway.discovery.locator.predicates[0].name: Path
spring.cloud.gateway.discovery.locator.predicates[0].args[pattern]: "'/'+serviceId+'/**'"
spring.cloud.gateway.discovery.locator.predicates[1].name: Host
spring.cloud.gateway.discovery.locator.predicates[1].args[pattern]: "'**.foo.com'"
spring.cloud.gateway.discovery.locator.filters[0].name: CircuitBreaker
spring.cloud.gateway.discovery.locator.filters[0].args[name]: serviceId
spring.cloud.gateway.discovery.locator.filters[1].name: RewritePath
spring.cloud.gateway.discovery.locator.filters[1].args[regexp]: "'/' + serviceId + '/?(?<remaining>.*)'"
spring.cloud.gateway.discovery.locator.filters[1].args[replacement]: "'/${remaining}'"