Spring Cloud Gateway路由元信息作用及路由超時配置詳解
環(huán)境：Spring Cloud Gateway 3.1.4
路由元信息配置
你可以使用元數(shù)據(jù)為每個路由配置其他參數(shù)，如下所示：
spring:
cloud:
gateway:
routes:
- id: route_with_metadata
uri: https://pack.com
metadata:
zone: "xj"
infos:
name: "value"
weight: 0.2可以通過ServerWebExchange中獲取所有元數(shù)據(jù)屬性，如下所示:
// 獲取路由對象
Route route = exchange.getAttribute(GATEWAY_ROUTE_ATTR);
// 獲取路由元信息
route.getMetadata();
// 獲取某一個元信息
route.getMetadata(someKey);上面exchange.getAttribute方法獲取路由對象是在通過HandlerMapping對象查找路由對象時設(shè)置到當(dāng)前的上下文中的，如下：
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<Route, Mono<?>>) r -> {
exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR);
// 將查找到的路由保存到當(dāng)前的執(zhí)行上下文中
exchange.getAttributes().put(GATEWAY_ROUTE_ATTR, r);
return Mono.just(webHandler);
}).switchIfEmpty(Mono.empty().then(Mono.fromRunnable(() -> {
exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR);
})));
}
}路由的超時配置就是通過元信息的配置來設(shè)置的，接下來就是路由超時相關(guān)的講解。
路由(http)超時配置
Http超時（響應(yīng)和連接）可以為所有路由配置，并為還可以為每個特定路由覆蓋。
- 全局超時配置
要配置全局http超時：
連接超時必須以毫秒為單位指定。
響應(yīng)超時必須指定為java.time.Duration
spring:
cloud:
gateway:
httpclient:
connect-timeout: 1000
response-timeout: 5s- 每個路由配置超時
要配置每個路由超時：
連接超時必須以毫秒為單位指定。
響應(yīng)超時必須以毫秒為單位指定。
- 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();
}超時時間配置為負(fù)值的每條路由響應(yīng)超時將禁用全局響應(yīng)超時值。
- id: per_route_timeouts
uri: https://example.org
predicates:
- name: Path
args:
pattern: /delay/{timeout}
metadata:
response-timeout: -1流式的Java路由API
@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("name", "pack")
)
.build();
}這種風(fēng)格還允許更多的自定義謂詞斷言。RouteDefinitionLocator bean定義的謂詞使用邏輯和進行組合。通過使用流暢的Java API，可以在Predicate類上使用and()、or()和negate()操作符。
- DiscoveryClient路由定義定位器
你可以將網(wǎng)關(guān)配置為基于在DiscoveryClient兼容服務(wù)注冊表中注冊的服務(wù)創(chuàng)建路由。直接通過服務(wù)實例訪問路由
要啟用此功能，需要將spring.cloud.gateway.decovery.locator.enabled設(shè)置為true，并確保DiscoveryClient實現(xiàn)（如Netflix Eureka、Consul、Zookeeper或Nacos）位于類路徑上并已啟用。
默認(rèn)情況下，網(wǎng)關(guān)為使用DiscoveryClient創(chuàng)建的路由定義一個謂詞和篩選器。
默認(rèn)謂詞是使用模式/serviceId/**定義的路徑謂詞，其中serviceId是DiscoveryClient中服務(wù)的ID（注冊中心注冊的服務(wù)名稱，主要就是spring.application.name）。
默認(rèn)的過濾器是重寫路徑過濾器，regex /serviceId/?(?<remaining> .*)和替換的/${remaining}。這將在請求發(fā)送到下游之前從路徑中剝離服務(wù)ID。
如果你想自定義DiscoveryClient路由使用的謂詞或過濾器，請設(shè)置
spring.cloud.gateway.discovery.locator.predicates[x]和
spring.cloud.gateway.discovery.locator.filters[y]。這樣做時，如果你希望保留該功能，則需要確保包含前面所示的默認(rèn)謂詞和過濾器。下面的例子展示了它的樣子:
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}'"完畢?。?！
