知識庫 / Spring / Spring Cloud RSS 訂閱

- id: circuitbreaker_route
  uri: https://httpbin.org
  predicates:
  - Path=/status/504
  filters:
  - name: CircuitBreaker
    args:
      name: myCircuitBreaker
      fallbackUri: forward:/anything
  - RewritePath=/status/504, /anything

對於斷路器的配置，我們使用了 Resilience4J，通過添加 spring-cloud-starter-circuitbreaker-reactor-resilience4j 依賴項：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-circuitbreaker-reactor-resilience4j</artifactId>
</dependency>

再次，我們可以使用 curl 測試功能：

$ curl http://localhost:8080/status/504 
"url": "https://localhost:8080/anything"

4.2. 重試

另一個高級功能允許客户端在代理服務出現問題時重試訪問。它接受多個參數，例如重試次數、HTTP 狀態碼狀態碼、以及方法，系列、異常和退避間隔，用於在每次重試後等待：

- id: retry_test
  uri: https://httpbin.org
  predicates:
  - Path=/status/502
  filters:
  - name: Retry
    args:
       retries: 3
       statuses: BAD_GATEWAY
       methods: GET,POST
       backoff:
          firstBackoff: 10ms
          maxBackoff: 50ms
          factor: 2
          basedOnPreviousValue: false

當客户端遇到 /status/502 (Bad Gateway) 錯誤時，過濾器會重試三次，等待每次執行後配置的退避間隔。

下面我們來查看它的工作原理:

$ curl http://localhost:8080/status/502

同時，還需要檢查服務器上的網關日誌：

Mapping [Exchange: GET http://localhost:8080/status/502] to Route{id='retry_test', ...}
Handler is being applied: {uri=https://httpbin.org/status/502, method=GET}
Received last HTTP packet
Handler is being applied: {uri=https://httpbin.org/status/502, method=GET}
Received last HTTP packet
Handler is being applied: {uri=https://httpbin.org/status/502, method=GET}
Received last HTTP packet

當網關收到 502 狀態碼時，過濾器會嘗試三次，並採用此退避策略對 GET 和 POST 方法進行重試。

4.3. 保存會話和安全頭部

<a href="https://cloud.spring.io/spring-cloud-gateway/reference/html/#the-secureheaders-gatewayfilter-factory"><em>SecureHeader</em></a> 工廠添加了 HTTP 安全頭部到響應中。 同樣，<a href="https://cloud.spring.io/spring-cloud-gateway/reference/html/#the-savesession-gatewayfilter-factory"><em>SaveSession</em></a> 在與 <em>Spring Session</em> 和 <em>Spring Security</em> 一起使用時尤其重要：

filters: 
- SaveSession

此過濾器存儲會話狀態，在轉發調用之前。

4.4. 請求速率限制器

RequestRateLimiter 工廠 確定請求是否可以繼續。如果不能，它返回 HTTP 狀態碼 429 – 請求過多。它使用不同的參數和解析器來指定速率限制器。

RedisRateLimiter 使用了廣為人知的 Redis 數據庫來檢查桶可以保持的令牌數量。

它需要以下依賴項：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
 </dependency>

Consequently, it also needs the configuration of Spring Redis:

spring:
  redis:
    host: localhost
    port: 6379

過濾器具有多個屬性。第一個參數，replenishRate，表示每秒允許的請求數量。第二個參數，burstCapacity，是單個秒鐘內的最大請求數量。第三個參數，requestedTokens，表示請求的成本（請求消耗的 token 數量）。下面是一個示例實現：

- id: request_rate_limiter
  uri: https://httpbin.org
  predicates:
  - Path=/redis/get/**
  filters:
  - StripPrefix=1
  - name: RequestRateLimiter
    args:
      redis-rate-limiter.replenishRate: 10
      redis-rate-limiter.burstCapacity: 5
      redis-rate-limiter.requestedTokens: 1

讓我們使用 curl 測試過濾器。在進行測試之前，我們應該確保 Redis 實例已啓動，例如使用 Docker：Docker。

$ curl "http://localhost:8080/redis/get" -i
HTTP/1.1 200 OK
X-RateLimit-Remaining: 4
X-RateLimit-Requested-Tokens: 1
X-RateLimit-Burst-Capacity: 5
X-RateLimit-Replenish-Rate: 10

當剩餘速率限制降至零時，網關會返回 HTTP 狀態碼 429。為了測試其行為，我們可以使用單元測試。

我們啓動一個嵌入式 Redis 服務器，並並行運行 RepeatedTests。當桶達到限制時，錯誤開始顯示：

00:57:48.263 [main] INFO  c.b.s.w.RedisWebFilterFactoriesLiveTest - Received: status->200, reason->OK, remaining->[4]
00:57:48.394 [main] INFO  c.b.s.w.RedisWebFilterFactoriesLiveTest - Received: status->200, reason->OK, remaining->[3]
00:57:48.530 [main] INFO  c.b.s.w.RedisWebFilterFactoriesLiveTest - Received: status->200, reason->OK, remaining->[2]
00:57:48.667 [main] INFO  c.b.s.w.RedisWebFilterFactoriesLiveTest - Received: status->200, reason->OK, remaining->[1]
00:57:48.826 [main] INFO  c.b.s.w.RedisWebFilterFactoriesLiveTest - Received: status->200, reason->OK, remaining->[0]
00:57:48.851 [main] INFO  c.b.s.w.RedisWebFilterFactoriesLiveTest - Received: status->429, reason->Too Many Requests, remaining->[0]
00:57:48.894 [main] INFO  c.b.s.w.RedisWebFilterFactoriesLiveTest - Received: status->429, reason->Too Many Requests, remaining->[0]
00:57:49.135 [main] INFO  c.b.s.w.RedisWebFilterFactoriesLiveTest - Received: status->200, reason->OK, remaining->[4]

4.5. 緩存支持

從 4.0 版本開始，Spring Cloud Gateway 提供了用於請求（CacheRequestBody）和響應（LocalCacheResponseBody）的緩存過濾器。

要配置 CacheRequestBody 過濾器，只需設置將請求體轉換為的類類型即可：

- id: cache_request_body_route
  uri: https://httpbin.org
  predicates:
  - Path=/cache/post/**
  filters:
  - StripPrefix=1
  - name: CacheRequestBody
    args:
      bodyClass: java.lang.String

緩存內容將在 ServerWebExchange.getAttributes() 中可用，其鍵定義在 ServerWebExchangeUtils.CACHED_REQUEST_BODY_ATTR 中，用於在後續過濾器中使用。

在配置 LocalCacheResponseBody 過濾器之前，我們需要添加 spring-boot-starter-cache 和 caffeine 依賴項或其他 Spring Cache 實現：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
    <groupId>com.github.ben-manes.caffeine</groupId>
    <artifactId>caffeine</artifactId>
</dependency>

我們可以通過將以下屬性設置為 spring.cloud.gateway.filter.local-response-cache.enabled 為 true 來全局激活此緩存過濾器。它還提供了兩個附加屬性 timeToLive 和 size。 timeToLive 屬性設置緩存條目過期時間。 size 屬性設置緩存的最大大小，用於驅逐條目。

spring:
  cloud:
    gateway:
      filter:
        local-response-cache:
          enabled: true
          timeToLive: 20m
          size: 6MB

我們還可以通過為每個路由配置過濾器來覆蓋全局配置。路由配置接受兩個參數。第一個參數將覆蓋緩存條目的過期時間，第二個參數將覆蓋該路由中用於驅逐緩存條目的最大大小。

- id: cache_response_body_route
  uri: https://httpbin.org
  predicates:
    - Path=/cache/get/**
  filters:
    - StripPrefix=1
    - LocalResponseCache=10s,20MB

在訪問此路徑後，我們將會找到一個響應頭，其值為 ，值為 。

5. 結論

在本教程中，我們介紹了 Spring Cloud Gateway 的 <em >WebFilter</em> 工廠。我們學習瞭如何與客户端在代理服務執行之前和之後請求和響應進行交互。