Spring Cloud Gateway 2.1.0 中文官網文檔

目錄

1. How to Include Spring Cloud Gateway
2. Glossary
3. How It Works
4. Route Predicate Factories
5. GatewayFilter Factories
6. Global Filters
7. TLS / SSL
8. Configuration
9. Reactor Netty Access Logs
10. CORS Configuration
11. Actuator API
12. Developer Guide

該項目提供了一個建立在Spring Ecosystem之上的API網關，包括：Spring 5，Spring Boot 2和Project Reactor。Spring Cloud Gateway旨在提供一種簡單而有效的方式來對API進行路由，併為他們提供切面，例如：安全性，監控/指標 和彈性等。

1. 如何在工程中引用Spring Cloud Gateway

要在項目中引入Spring Cloud Gateway，需要引用 group org.springframework.cloud 和 artifact id為spring-cloud-starter-gateway starter。最新的Spring Cloud Release 構建信息，請參閱Spring Cloud Project page。

如果應用了該starter，但由於某種原因不希望啟用網關，請進行設置spring.cloud.gateway.enabled=false。

重要

Spring Cloud Gateway依賴Spring Boot和Spring Webflux提供的Netty runtime。它不能在傳統的Servlet容器中工作或構建為WAR

2. 詞彙表

• Route 路由：gateway的基本構建模塊。它由ID、目標URI、斷言集合和過濾器集合組成。如果聚合斷言結果為真，則匹配到該路由。
• Predicate 斷言：這是一個Java 8 Function Predicate。輸入類型是 Spring Framework ServerWebExchange。這允許開發人員可以匹配來自HTTP請求的任何內容，例如Header或參數。
• Filter 過濾器：這些是使用特定工廠構建的 Spring FrameworkGatewayFilter實例。所以可以在返回請求之前或之後修改請求和響應的內容。

3. 如何工作的

Spring Cloud Gateway Diagram

客戶端向Spring Cloud Gateway發出請求。如果Gateway Handler Mapping確定請求與路由匹配，則將其發送到Gateway Web Handler。此handler通過特定於該請求的過濾器鏈處理請求。圖中filters被虛線劃分的原因是filters可以在發送代理請求之前或之後執行邏輯。先執行所有“pre filter”邏輯，然後進行請求代理。在請求代理執行完後，執行“post filter”邏輯。

注意

HTTP和HTTPS URI默認端口設置是80和443。

4. 路由斷言Factories

Spring Cloud Gateway將路由作為Spring WebFlux HandlerMapping基礎結構的一部分進行匹配。Spring Cloud Gateway包含許多內置的路由斷言Factories。這些斷言都匹配HTTP請求的不同屬性。多個路由斷言Factories可以通過 and 組合使用。

4.1 After 路由斷言 Factory

After Route Predicate Factory採用一個參數——日期時間。在該日期時間之後發生的請求都將被匹配。

application.yml

spring:
 cloud:
 gateway:
 routes:
 - id: after_route
 uri: http://example.org
 predicates:
 - After=2017-01-20T17:42:47.789-07:00[America/Denver]

4.2 Before 路由斷言 Factory

Before Route Predicate Factory採用一個參數——日期時間。在該日期時間之前發生的請求都將被匹配。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: before_route
 uri: http://example.org
 predicates:
 - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

4.3 Between 路由斷言 Factory

Between 路由斷言 Factory有兩個參數，datetime1和datetime2。在datetime1和datetime2之間的請求將被匹配。datetime2參數的實際時間必須在datetime1之後。

application.yml.

spring:
 cloud:
 gateway: 

 routes:
 - id: between_route
 uri: http://example.org
 predicates:
 - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

4.4 Cookie 路由斷言 Factory

Cookie 路由斷言 Factory有兩個參數，cookie名稱和正則表達式。請求包含次cookie名稱且正則表達式為真的將會被匹配。

application.yml

spring:
 cloud:
 gateway:
 routes:
 - id: cookie_route
 uri: http://example.org
 predicates:
 - Cookie=chocolate, ch.p

4.5 Header 路由斷言 Factory

Header 路由斷言 Factory有兩個參數，header名稱和正則表達式。請求包含次header名稱且正則表達式為真的將會被匹配。

application.yml.

spring:
 cloud:
 gateway:
 routes: 

 - id: header_route
 uri: http://example.org
 predicates:
 - Header=X-Request-Id, \\d+

4.6 Host 路由斷言 Factory

Host 路由斷言 Factory包括一個參數：host name列表。使用Ant路徑匹配規則，.作為分隔符。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: host_route
 uri: http://example.org
 predicates:
 - Host=**.somehost.org,**.anotherhost.org

4.7 Method 路由斷言 Factory

Method 路由斷言 Factory只包含一個參數: 需要匹配的HTTP請求方式

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: method_route
 uri: http://example.org
 predicates:
 - Method=GET
 

所有GET請求都將被路由

4.8 Path 路由斷言 Factory

Path 路由斷言 Factory 有2個參數: 一個Spring PathMatcher表達式列表和可選matchOptionalTrailingSeparator標識 .

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: host_route
 uri: http://example.org
 predicates:
 - Path=/foo/{segment},/bar/{segment}

例如: /foo/1 or /foo/bar or /bar/baz的請求都將被匹配

URI 模板變量 (如上例中的 segment ) 將以Map的方式保存於ServerWebExchange.getAttributes() key為ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE. 這些值將在GatewayFilter Factories使用

可以使用以下方法來更方便地訪問這些變量。

Map<string> uriVariables = ServerWebExchangeUtils.getPathPredicateVariables(exchange);
String segment = uriVariables.get("segment");
/<string>

4.9 Query 路由斷言 Factory

Query 路由斷言 Factory 有2個參數: 必選項 param 和可選項 regexp.

spring:
 cloud:
 gateway:
 routes:
 - id: query_route
 uri: http://example.org
 predicates:
 - Query=baz

則包含了請求參數 baz的都將被匹配。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: query_route
 uri: http://example.org
 predicates:
 - Query=foo, ba.

如果請求參數裡包含foo參數，並且值匹配為ba. 表達式，則將會被路由，如：bar and baz

4.10 RemoteAddr 路由斷言 Factory

RemoteAddr 路由斷言 Factory的參數為 一個CIDR符號（IPv4或IPv6）字符串的列表，最小值為1，例如192.168.0.1/16（其中192.168.0.1是IP地址並且16是子網掩碼）。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: remoteaddr_route
 uri: http://example.org
 predicates:
 - RemoteAddr=192.168.1.1/24

如果請求的remote address 為 192.168.1.10則將被路由

4.10.1 修改遠程地址的解析方式

默認情況下，RemoteAddr 路由斷言 Factory使用傳入請求中的remote address。如果Spring Cloud Gateway位於代理層後面，則可能與實際客戶端IP地址不匹配。

可以通過設置自定義RemoteAddressResolver來自定義解析遠程地址的方式。Spring Cloud Gateway網關附帶一個非默認遠程地址解析程序，它基於X-Forwarded-For header, XForwardedRemoteAddressResolver.

XForwardedRemoteAddressResolver 有兩個靜態構造函數方法，採用不同的安全方法：

1. XForwardedRemoteAddressResolver:：TrustAll返回一個RemoteAddressResolver，它始終採用X-Forwarded-for頭中找到的第一個IP地址。這種方法容易受到欺騙，因為惡意客戶端可能會為解析程序接受的“x-forwarded-for”設置初始值。
2. XForwardedRemoteAddressResolver:：MaxTrustedIndex獲取一個索引，該索引與在Spring Cloud網關前運行的受信任基礎設施數量相關。例如，如果SpringCloudGateway只能通過haproxy訪問，則應使用值1。如果在訪問Spring Cloud Gateway之前需要兩個受信任的基礎架構躍點，那麼應該使用2。

給定以下的header值：

X-Forwarded-For: 0.0.0.1, 0.0.0.2, 0.0.0.3

下面的` maxTrustedIndex值將生成以下遠程地址:

Java 配置方式:

RemoteAddressResolver resolver = XForwardedRemoteAddressResolver
 .maxTrustedIndex(1);
...
.route("direct-route",
 r -> r.remoteAddr("10.1.1.1", "10.10.1.1/24")
 .uri("https://downstream1")
.route("proxied-route",
 r -> r.remoteAddr(resolver, "10.10.1.1", "10.10.1.1/24")
 .uri("https://downstream2")
)

5. GatewayFilter Factories

過濾器允許以某種方式修改傳入的HTTP請求或返回的HTTP響應。過濾器的作用域是某些特定路由。Spring Cloud Gateway包括許多內置的 Filter工廠。

注意：有關如何使用以下任何過濾器的更詳細示例，請查看unit tests.。

5.1 AddRequestHeader GatewayFilter Factory

採用一對名稱和值作為參數

application.yml.

spring:

cloud:

gateway:

routes:

- id: add_request_header_route

uri: http://example.org

filters:

- AddRequestHeader=X-Request-Foo, Bar

對於所有匹配的請求，這將向下遊請求的頭中添加 x-request-foo:bar header

5.2 AddRequestParameter GatewayFilter Factory

採用一對名稱和值作為參數

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: add_request_parameter_route
 uri: http://example.org
 filters:
 - AddRequestParameter=foo, bar

對於所有匹配的請求，這將向下遊請求添加foo=bar查詢字符串

5.3 AddResponseHeader GatewayFilter Factory

採用一對名稱和值作為參數

application.yml.

spring:
 cloud: 

 gateway:
 routes:
 - id: add_request_header_route
 uri: http://example.org
 filters:
 - AddResponseHeader=X-Response-Foo, Bar

對於所有匹配的請求，這會將x-response-foo:bar頭添加到下游響應的header中

5.4 Hystrix GatewayFilter Factory

Hystrix 是Netflix開源的斷路器組件。Hystrix GatewayFilter允許你向網關路由引入斷路器，保護你的服務不受級聯故障的影響，並允許你在下游故障時提供fallback響應。

要在項目中啟用Hystrix網關過濾器，需要添加對 spring-cloud-starter-netflix-hystrix的依賴 Spring Cloud Netflix.

Hystrix GatewayFilter Factory 需要一個name參數，即HystrixCommand的名稱。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: hystrix_route
 uri: http://example.org
 filters:
 - Hystrix=myCommandName

這將剩餘的過濾器包裝在命令名為“myCommandName”的HystrixCommand中。

hystrix過濾器還可以接受可選的fallbackUri 參數。目前，僅支持forward: 預設的URI，如果調用fallback，則請求將轉發到與URI匹配的控制器。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: hystrix_route
 uri: lb://backing-service:8088
 predicates:
 - Path=/consumingserviceendpoint
 filters:
 - name: Hystrix
 args:
 name: fallbackcmd
 fallbackUri: forward:/incaseoffailureusethis
 - RewritePath=/consumingserviceendpoint, /backingserviceendpoint

當調用hystrix fallback時，這將轉發到/incaseoffailureusethis uri。注意，這個示例還演示了（可選）通過目標URI上的'lb`前綴,使用Spring Cloud Netflix Ribbon 客戶端負載均衡。

主要場景是使用fallbackUri 到網關應用程序中的內部控制器或處理程序。但是，也可以將請求重新路由到外部應用程序中的控制器或處理程序，如：

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: ingredients
 uri: lb://ingredients
 predicates:
 - Path=//ingredients/**
 filters:
 - name: Hystrix
 args: 

 name: fetchIngredients
 fallbackUri: forward:/fallback
 - id: ingredients-fallback
 uri: http://localhost:9994
 predicates:
 - Path=/fallback

在本例中，gateway應用程序中沒有 fallback 實現，但是另一個應用程序中有一個接口實現，註冊為“http://localhost:9994”。

在將請求轉發到fallback的情況下，Hystrix Gateway過濾還支持直接拋出Throwable 。它被作為ServerWebExchangeUtils.HYSTRIX_EXECUTION_EXCEPTION_ATTR屬性添加到ServerWebExchange中，可以在處理網關應用程序中的fallback時使用。

對於外部控制器/處理程序方案，可以添加帶有異常詳細信息的header。可以在 FallbackHeaders GatewayFilter Factory section.中找到有關它的更多信息。

hystrix配置參數（如 timeouts）可以使用全局默認值配置，也可以使用Hystrix wiki中所述屬性進行配置。

要為上面的示例路由設置5秒超時，將使用以下配置：

application.yml.

hystrix.command.fallbackcmd.execution.isolation.thread.timeoutInMilliseconds: 5000

5.5 FallbackHeaders GatewayFilter Factory

FallbackHeaders允許在轉發到外部應用程序中的FallbackUri的請求的header中添加Hystrix異常詳細信息，如下所示：

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: ingredients
 uri: lb://ingredients
 predicates:
 - Path=//ingredients/**
 filters:
 - name: Hystrix
 args:
 name: fetchIngredients
 fallbackUri: forward:/fallback
 - id: ingredients-fallback
 uri: http://localhost:9994
 predicates:
 - Path=/fallback
 filters:
 - name: FallbackHeaders
 args:
 executionExceptionTypeHeaderName: Test-Header

在本例中，在運行HystrixCommand發生執行異常後，請求將被轉發到 localhost:9994應用程序中的 fallback終端或程序。異常類型、消息（如果可用）cause exception類型和消息的頭，將由FallbackHeaders filter添加到該請求中。

通過設置下面列出的參數值及其默認值，可以在配置中覆蓋headers的名稱：

• executionExceptionTypeHeaderName ("Execution-Exception-Type")
• executionExceptionMessageHeaderName ("Execution-Exception-Message")
• rootCauseExceptionTypeHeaderName ("Root-Cause-Exception-Type")
• rootCauseExceptionMessageHeaderName ("Root-Cause-Exception-Message")

Hystrix 如何實現的更多細節可以參考 Hystrix GatewayFilter Factory section.

5.6 PrefixPath GatewayFilter Factory

PrefixPath GatewayFilter 只有一個 prefix 參數.

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: prefixpath_route
 uri: http://example.org
 filters:
 - PrefixPath=/mypath

這將給所有匹配請求的路徑加前綴/mypath。因此，向/hello發送的請求將發送到/mypath/hello。

5.7 PreserveHostHeader GatewayFilter Factory

該filter沒有參數。設置了該Filter後，GatewayFilter將不使用由HTTP客戶端確定的host header ，而是發送原始host header 。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: preserve_host_route
 uri: http://example.org
 filters: 

 - PreserveHostHeader

5.8 RequestRateLimiter GatewayFilter Factory

RequestRateLimiter使用RateLimiter實現是否允許繼續執行當前請求。如果不允許繼續執行，則返回HTTP 429 - Too Many Requests （默認情況下）。

這個過濾器可以配置一個可選的keyResolver 參數和rate limiter參數（見下文）。

keyResolver 是 KeyResolver 接口的實現類.在配置中，按名稱使用SpEL引用bean。#{@myKeyResolver} 是引用名為'myKeyResolver'的bean的SpEL表達式。

KeyResolver.java.

public interface KeyResolver {
 Mono<string> resolve(ServerWebExchange exchange);
}
/<string>

KeyResolver接口允許使用可插拔策略來派生限制請求的key。在未來的里程碑版本中，將有一些KeyResolver實現。

KeyResolver的默認實現是PrincipalNameKeyResolver，它從ServerWebExchange檢索Principal並調用Principal.getName()。

默認情況下，如果KeyResolver 沒有獲取到key，請求將被拒絕。此行為可以使用 spring.cloud.gateway.filter.request-rate-limiter.deny-empty-key (true or false) 和 spring.cloud.gateway.filter.request-rate-limiter.empty-key-status-code屬性進行調整。

說明

無法通過"shortcut" 配置RequestRateLimiter。以下示例

application.properties.

# INVALID SHORTCUT CONFIGURATION
spring.cloud.gateway.routes[0].filters[0]=RequestRateLimiter=2, 2, #{@userkeyresolver}

5.8.1 Redis RateLimiter

Redis的實現基於 Stripe實現。它需要使用 spring-boot-starter-data-redis-reactive Spring Boot starter。

使用的算法是Token Bucket Algorithm.。

redis-rate-limiter.replenishRate是你允許用戶每秒執行多少請求，而丟棄任何請求。這是令牌桶的填充速率。

``redis-rate-limiter.burstCapacity`是允許用戶在一秒鐘內執行的最大請求數。這是令牌桶可以保存的令牌數。將此值設置為零將阻止所有請求。

穩定速率是通過在replenishRate 和 burstCapacity中設置相同的值來實現的。可通過設置burstCapacity高於replenishRate來允許臨時突發流浪。在這種情況下，限流器需要在兩次突發之間留出一段時間（根據replenishRate），因為連續兩次突發將導致請求丟失 (HTTP 429 - Too Many Requests).。

application.yml.

spring:
 cloud:
 gateway: 

 routes:
 - id: requestratelimiter_route
 uri: http://example.org
 filters:
 - name: RequestRateLimiter
 args:
 redis-rate-limiter.replenishRate: 10
 redis-rate-limiter.burstCapacity: 20

Config.java.

@Bean
KeyResolver userKeyResolver() {
 return exchange -> Mono.just(exchange.getRequest().getQueryParams().getFirst("user"));
}

這定義了每個用戶10個請求的限制。允許20個突發，但下一秒只有10個請求可用。KeyResolver是一個簡單的獲取user請求參數的工具（注意：不建議用於生產）。

限流器也可以定義為RateLimiter接口的實現 bean。在配置中，按名稱使用SpEL引用bean。#{@myRateLimiter}是引用名為'myRateLimiter'的bean的SpEL表達式。

application.yml.

spring:

cloud:

gateway:

routes:

- id: requestratelimiter_route

uri: http://example.org

filters:

- name: RequestRateLimiter

args:

rate-limiter: "#{@myRateLimiter}"

key-resolver: "#{@userKeyResolver}"

5.9 RedirectTo GatewayFilter Factory

該過濾器有一個 status 和一個 url參數。status是300類重定向HTTP代碼，如301。該URL應為有效的URL，這將是 Location header的值。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: prefixpath_route
 uri: http://example.org
 filters:
 - RedirectTo=302, http://acme.org

這將發送一個302狀態碼和一個Location:http://acme.org header來執行重定向。

5.10 RemoveNonProxyHeaders GatewayFilter Factory

RemoveNonProxyHeaders GatewayFilter Factory 從轉發請求中刪除headers。刪除的默認頭列表來自 IETF.

The default removed headers are:

• Connection
• Keep-Alive
• Proxy-Authenticate
• Proxy-Authorization
• TE
• Trailer
• Transfer-Encoding
• Upgrade
• 要更改此設置，請將 spring.cloud.gateway.filter.remove-non-proxy-headers.headers屬性設置為要刪除的header名稱。

5.11 RemoveRequestHeader GatewayFilter Factory

有一個name參數. 這是要刪除的header的名稱。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: removerequestheader_route
 uri: http://example.org
 filters:
 - RemoveRequestHeader=X-Request-Foo

這將在X-Request-Foo header被髮送到下游之前刪除它。

5.12 RemoveResponseHeader GatewayFilter Factory

有一個name參數. 這是要刪除的header的名稱。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: removeresponseheader_route
 uri: http://example.org
 filters:
 - RemoveResponseHeader=X-Response-Foo

這將在返回到網關client之前從響應中刪除x-response-foo頭。

5.13 RewritePath GatewayFilter Factory

包含一個 regexp正則表達式參數和一個 replacement 參數. 通過使用Java正則表達式靈活地重寫請求路徑。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: rewritepath_route
 uri: http://example.org
 predicates:
 - Path=/foo/**
 filters:
 - RewritePath=/foo/(?<segment>.*), /$\\{segment}
/<segment>

對於請求路徑/foo/bar，將在發出下游請求之前將路徑設置為/bar。注意,由於YAML規範，請使用 $\\替換 $。

5.14 RewriteResponseHeader GatewayFilter Factory

包含 name, regexp和 replacement 參數.。通過使用Java正則表達式靈活地重寫響應頭的值。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: rewriteresponseheader_route
 uri: http://example.org
 filters:
 - RewriteResponseHeader=X-Response-Foo, , password=[^&]+, password=***

對於一個/42?user=ford&password=omg!what&flag=true的header值，在做下游請求時將被設置為/42?user=ford&password=***&flag=true，由於YAML規範，請使用 $\\替換 $。

5.15 SaveSession GatewayFilter Factory

SaveSession GatewayFilter Factory將調用轉發到下游之前強制執行WebSession::save 操作。這在使用 Spring Session 之類時特別有用，需要確保會話狀態在進行轉發調用之前已保存。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: save_session 

 uri: http://example.org
 predicates:
 - Path=/foo/**
 filters:
 - SaveSession

如果你希望要將[Spring Security]（https://projects.spring.io/Spring Security/）與Spring Session集成,並確保安全詳細信息已轉發到遠程的進程，這一點至關重要。

5.16 SecureHeaders GatewayFilter Factory

SecureHeaders GatewayFilter Factory 將許多headers添加到reccomedation處的響應中，從this blog post.

添加以下標題（使用默認值分配）:

• X-Xss-Protection:1; mode=block
• Strict-Transport-Security:max-age=631138519
• X-Frame-Options:DENY
• X-Content-Type-Options:nosniff
• Referrer-Policy:no-referrer
• Content-Security-Policy:default-src 'self' https:; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none';>
• X-Download-Options:noopen
• X-Permitted-Cross-Domain-Policies:none

要更改默認值，請在spring.cloud.gateway.filter.secure-headers 命名空間中設置相應的屬性：

Property to change:

• xss-protection-header
• strict-transport-security
• frame-options
• content-type-options
• referrer-policy
• content-security-policy
• download-options
• permitted-cross-domain-policies

5.17 SetPath GatewayFilter Factory

SetPath GatewayFilter Factory 採用 template路徑參數。它提供了一種通過允許路徑的模板化segments來操作請求路徑的簡單方法。使用Spring Framework中的URI模板，允許多個匹配segments。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: setpath_route
 uri: http://example.org
 predicates:
 - Path=/foo/{segment}
 filters:
 - SetPath=/{segment}

對於一個 /foo/bar請求，在做下游請求前，路徑將被設置為/bar

SetResponseHeader GatewayFilter Factory 包括 name 和 value 參數.

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: setresponseheader_route
 uri: http://example.org
 filters:
 - SetResponseHeader=X-Response-Foo, Bar

此GatewayFilter使用給定的名稱替換所有header，而不是添加。因此，如果下游服務器響應為X-Response-Foo:1234，則會將其替換為X-Response-Foo:Bar,這是網關客戶端將接收的內容。

5.19 SetStatus GatewayFilter Factory

SetStatus GatewayFilter Factory 包括唯一的 status參數.必須是一個可用的Spring HttpStatus。它可以是整數值404或字符串枚舉NOT_FOUND。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: setstatusstring_route
 uri: http://example.org
 filters:
 - SetStatus=BAD_REQUEST
 - id: setstatusint_route
 uri: http://example.org
 filters: 

 - SetStatus=401

在這個例子中，HTTP返回碼將設置為401.

5.20 StripPrefix GatewayFilter Factory

StripPrefix GatewayFilter Factory 包括一個parts參數。 parts參數指示在將請求發送到下游之前，要從請求中去除的路徑中的節數。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: nameRoot
 uri: http://nameservice
 predicates:
 - Path=/name/**
 filters:
 - StripPrefix=2

當通過網關發出/name/bar/foo請求時，向nameservice發出的請求將是http://nameservice/foo。

5.21 Retry GatewayFilter Factory

Retry GatewayFilter Factory包括 retries, statuses, methods和 series 參數.

• retries: 應嘗試的重試次數
• statuses: 應該重試的HTTP狀態代碼，用org.springframework.http.HttpStatus標識
• methods: 應該重試的HTTP方法，用 org.springframework.http.HttpMethod標識
• series: 要重試的一系列狀態碼，用 org.springframework.http.HttpStatus.Series標識

application.yml.

spring:

cloud:

gateway:

routes:

- id: retry_test

uri: http://localhost:8080/flakey

predicates:

- Host=*.retry.com

filters:

- name: Retry

args:

retries: 3

statuses: BAD_GATEWAY

注意

retry filter 不支持body請求的重試，如通過body的POST 或 PUT請求

注意

在使用帶有前綴為 forward: 的retry filter時，應仔細編寫目標端點，以便在出現錯誤時不會執行任何可能導致將響應發送到客戶端並提交的操作。例如，如果目標端點是帶註解的controller，則目標controller方法不應返回帶有錯誤狀態代碼的ResponseEntity。相反，它應該拋出一個Exception，或者發出一個錯誤信號，例如通過Mono.error(ex) 返回值，重試過濾器可以配置為通過重試來處理。

5.22 RequestSize GatewayFilter Factory

當請求大小大於允許的限制時，RequestSize GatewayFilter Factory可以限制請求不到達下游服務。過濾器以RequestSize作為參數，這是定義請求的允許大小限制(以字節為單位)。

application.yml.

spring:
 cloud:
 gateway:
 routes:
 - id: request_size_route
 uri: http://localhost:8080/upload
 predicates:
 - Path=/upload
 filters:
 - name: RequestSize
 args:
 maxSize: 5000000

當請求因大小而被拒絕時， RequestSize GatewayFilter Factory 將響應狀態設置為413 Payload Too Large，並帶有額外的header errorMessage 。下面是一個 errorMessage的例子。

errorMessage : Request size is larger than permissible limit. Request size is 6.0 MB where permissible limit is 5.0 MB

注意

如果未在路由定義中作為filter參數提供，則默認請求大小將設置為5 MB。

5.23 Modify Request Body GatewayFilter Factory

這個過濾器被定義為beta版本，將來API可能會改變。

此過濾器可用於在請求主體被網關發送到下游之前對其進行修改。

注意

只能使用Java DSL配置此過濾器

@Bean
public RouteLocator routes(RouteLocatorBuilder builder) {
 return builder.routes()
 .route("rewrite_request_obj", r -> r.host("*.rewriterequestobj.org")
 .filters(f -> f.prefixPath("/httpbin")
 .modifyRequestBody(String.class, Hello.class, MediaType.APPLICATION_JSON_VALUE,
 (exchange, s) -> return Mono.just(new Hello(s.toUpperCase())))).uri(uri))
 .build();
}
static class Hello {
 String message;
 public Hello() { }
 public Hello(String message) {
 this.message = message;
 }
 public String getMessage() {
 return message;
 }
 public void setMessage(String message) {
 this.message = message;
 }
}

5.24 Modify Response Body GatewayFilter Factory

這個過濾器被定義為beta版本，將來API可能會改變。

此過濾器可用於在將響應正文發送回客戶端之前對其進行修改。

注意

只能使用Java DSL配置此過濾器

@Bean
public RouteLocator routes(RouteLocatorBuilder builder) {
 return builder.routes()
 .route("rewrite_response_upper", r -> r.host("*.rewriteresponseupper.org")
 .filters(f -> f.prefixPath("/httpbin")
 .modifyResponseBody(String.class, String.class,
 (exchange, s) -> Mono.just(s.toUpperCase()))).uri(uri)
 .build();
}

完整文章請見：https://www.jianshu.com/p/6ff196940b67

歡迎關注 高廣超的簡書博客 與 收藏文章 ！

個人介紹：

高廣超：多年一線互聯網研發與架構設計經驗，擅長設計與落地高可用、高性能、可擴展的互聯網架構。目前從事大數據相關研發與架構工作。

本文首發在 高廣超的簡書博客 轉載請註明！