文章目录
- 1. 全局超时
- 2. 每个路由超时
- 3. Fluent Java Routes API
- 4. DiscoveryClient路由定义定位器
- 4.1 DiscoveryClient路由配置谓词和过滤器
- [Spring Cloud 相关系列文章目录]()
- 网关服务
- Spring Cloud Gateway
本文Spring Cloud Gateway 版本:2020.0.0
可以为所有路由配置Http超时(响应和连接),并为每个特定路由覆盖Http超时。
1. 全局超时
要配置全局http超时:connect-timeout
必须以毫秒为单位指定。response-timeout
必须指定为java.time.Duration
全局http超时示例
spring:
cloud:
gateway:
httpclient:
connect-timeout: 1000
response-timeout: 5s
2. 每个路由超时
要配置每个路由超时:connect-timeout
必须以毫秒为单位指定。response-timeout
必须以毫秒为单位指定。
通过配置每个路由的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();
}
3. Fluent Java Routes API
为了在Java中进行简单的配置,该RouteLocatorBuilder
bean包含了一个流畅的API。以下清单显示了它的工作方式:
// 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,你可以使用and()
,or()
以及negate()
对运营Predicate
类。
4. DiscoveryClient路由定义定位器
您可以将网关配置为基于在DiscoveryClient
兼容服务注册表中注册的服务来创建路由。
要启用此功能,请设置spring.cloud.gateway.discovery.locator.enabled=true
并确保DiscoveryClient
在类路径上启用了某个实现(例如Netflix Eureka,Consul或Zookeeper)。
4.1 DiscoveryClient路由配置谓词和过滤器
默认情况下,网关为使用所创建的路由定义单个谓词和过滤器DiscoveryClient
。
默认谓词是使用模式定义的路径谓词/serviceId/**
,其中serviceId
是来自的服务ID DiscoveryClient
。
默认的过滤器是带有正则表达式/serviceId/(?<remaining>.*)
和替换的重写路径过滤器/${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: 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}'"