【Spring Gateway】 Http timeouts configuration
【Spring Gateway】 Http timeouts configuration
Metadata
title: 【Spring Gateway】 Http timeouts configuration
date: 2023-02-14 10:05
tags:
- 行动阶段/完成
- 主题场景/组件
- 笔记空间/KnowladgeSpace/ProgramSpace/ModuleSpace
- 细化主题/Module/SpringGateway
categories:
- SpringGateway
keywords:
- SpringGateway
description: 【Spring Gateway】 Http timeouts configuration
【Spring Gateway】 Http timeouts configuration
Http超时(响应和连接)可以为所有路由配置，并覆盖每个特定的路由。
Global timeouts
要配置http全局超时:connect-timeout必须以毫秒为单位指定。response-timeout必须指定为java.time.Duration
spring:
cloud:
gateway:
httpclient:
connect-timeout: 1000
response-timeout: 5s
Per-route timeouts
要配置每路由超时:connect-timeout必须以毫秒为单位指定。response-timeout必须以毫秒为单位指定。
- id: per_route_timeouts
uri: https://example.org
predicates:
- name: Path
args:
pattern: /delay/{timeout}
metadata:
response-timeout: 200
connect-timeout: 200
per-route timeouts configuration using 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();
}
每个路由的响应超时为负值将禁用全局响应超时值。
- id: per_route_timeouts
uri: https://example.org
predicates:
- name: Path
args:
pattern: /delay/{timeout}
metadata:
response-timeout: -1
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定义的谓词使用逻辑和组合。通过使用流畅的Java API，您可以在Predicate类上使用and()、or()和negate()操作符。
The DiscoveryClient Route Definition Locator
您可以将网关配置为基于在DiscoveryClient兼容的服务注册中心注册的服务创建路由。
要启用此功能，请设置spring.cloud.gateway.discovery.locator.enabled=true，并确保DiscoveryClient实现(如Netflix Eureka, Consul或Zookeeper)在类路径上并启用。
Configuring Predicates and Filters For DiscoveryClient Routes
默认情况下，网关为DiscoveryClient创建的路由定义一个谓词和过滤器。
默认谓词是用模式/serviceId/**定义的路径谓词，其中serviceId是来自DiscoveryClient的服务的ID。
默认过滤器是正则表达式/serviceId/?(?<remaining>.*)和替换过滤器/${remaining}的重写路径过滤器。这将在请求发送到下游之前从路径中删除服务ID。
如果想定制DiscoveryClient路由使用的谓词或过滤器，可以设置spring.cloud.gateway.discovery.locator.predicate[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}'"
wechat
alipay