Spring Cloud Gateway 內置的過濾器工廠

本文基于Spring Cloud Greenwich SR2

[TOC]

內置的過濾器工廠

這里簡單將Spring Cloud Gateway內置的所有過濾器工廠整理成了一張表格，雖然不是很詳細，但能作為速覽使用。如下：

Tips：每個過濾器工廠都對應一個實現類，并且這些類的名稱必須以GatewayFilterFactory結尾，這是Spring Cloud Gateway的一個約定，例如AddRequestHeader對應的實現類為AddRequestHeaderGatewayFilterFactory。對源碼感興趣的小伙伴就可以按照這個規律拼接出具體的類名，以此查找這些內置過濾器工廠的實現代碼

1、AddRequestHeader GatewayFilter Factory

為原始請求添加Header，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
        - AddRequestHeader=X-Request-Foo, Bar

為原始請求添加名為 X-Request-Foo ，值為 Bar 的請求頭

2、AddRequestParameter GatewayFilter Factory

為原始請求添加請求參數及值，配置示例：

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

為原始請求添加名為foo，值為bar的參數，即：foo=bar

3、AddResponseHeader GatewayFilter Factory

為原始響應添加Header，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: add_response_header_route
        uri: https://example.org
        filters:
        - AddResponseHeader=X-Response-Foo, Bar

為原始響應添加名為 X-Request-Foo ，值為 Bar 的響應頭

4、DedupeResponseHeader GatewayFilter Factory

DedupeResponseHeader可以根據配置的Header名稱及去重策略剔除響應頭中重復的值，這是Spring Cloud Greenwich SR2提供的新特性，低于這個版本無法使用。

我們在Gateway以及微服務上都設置了CORS（解決跨域）Header的話，如果不做任何配置，那么請求 -> 網關 -> 微服務，獲得的CORS Header的值，就將會是這樣的：

Access-Control-Allow-Credentials: true, true
Access-Control-Allow-Origin: https://musk.mars, https://musk.mars

可以看到這兩個Header的值都重復了，若想把這兩個Header的值去重的話，就需要使用到DedupeResponseHeader，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: dedupe_response_header_route
        uri: https://example.org
        filters:
        # 若需要去重的Header有多個，使用空格分隔
        - DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin

去重策略：

• RETAIN_FIRST：默認值，保留第一個值
• RETAIN_LAST：保留最后一個值
• RETAIN_UNIQUE：保留所有唯一值，以它們第一次出現的順序保留

若想對該過濾器工廠有個比較全面的了解的話，建議閱讀該過濾器工廠的源碼，因為源碼里有詳細的注釋及示例，比官方文檔寫得還好：org.springframework.cloud.gateway.filter.factory.DedupeResponseHeaderGatewayFilterFactory

5、Hystrix GatewayFilter Factory

為路由引入Hystrix的斷路器保護，配置示例：

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

Hystrix是Spring Cloud第一代容錯組件，不過已經進入維護模式，未來Hystrix會被Spring Cloud移除掉，取而代之的是Alibaba Sentinel/Resilience4J。所以本文不做詳細介紹了，感興趣的話可以參考官方文檔：

• Hystrix GatewayFilter Factory

6、FallbackHeaders GatewayFilter Factory

同樣是對Hystrix的支持，上一小節所介紹的過濾器工廠支持一個配置參數：fallbackUri，該配置用于當發生異常時將請求轉發到一個特定的uri上。而FallbackHeaders這個過濾工廠可以在轉發請求到該uri時添加一個Header，這個Header的值為具體的異常信息。配置示例：

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

這里也不做詳細介紹了，感興趣可以參考官方文檔：

• FallbackHeaders GatewayFilter Factory

7、PrefixPath GatewayFilter Factory

為原始的請求路徑添加一個前綴路徑，配置示例：

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

該配置使訪問${GATEWAY_URL}/hello 會轉發到https://example.org/mypath/hello

8、PreserveHostHeader GatewayFilter Factory

為請求添加一個preserveHostHeader=true的屬性，路由過濾器會檢查該屬性以決定是否要發送原始的Host Header。配置示例：

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

如果不設置，那么名為 Host 的Header將由Http Client控制

9、RequestRateLimiter GatewayFilter Factory

用于對請求進行限流，限流算法為令牌桶。配置示例：

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

由于另一篇文章中已經介紹過如何使用該過濾器工廠實現網關限流，所以這里就不再贅述了：

• Spring Cloud Gateway - 擴展

或者參考官方文檔：

• RequestRateLimiter GatewayFilter Factory

10、RedirectTo GatewayFilter Factory

將原始請求重定向到指定的Url，配置示例：

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

該配置使訪問 ${GATEWAY_URL}/hello 會被重定向到 https://acme.org/hello ，并且攜帶一個 Location:http://acme.org 的Header，而返回客戶端的HTTP狀態碼為302

注意事項：

• HTTP狀態碼應為3xx，例如301
• URL必須是合法的URL，該URL會作為Location Header的值

11、RemoveHopByHopHeadersFilter GatewayFilter Factory

為原始請求刪除IETF組織規定的一系列Header，默認刪除的Header如下：

• Connection
• Keep-Alive
• Proxy-Authenticate
• Proxy-Authorization
• TE
• Trailer
• Transfer-Encoding
• Upgrade

可以通過配置去指定僅刪除哪些Header，配置示例：

spring:
  cloud:
    gateway:
      filter:
        remove-hop-by-hop:
          # 多個Header使用逗號（,）分隔
          headers: Connection,Keep-Alive

12、RemoveRequestHeader GatewayFilter Factory

為原始請求刪除某個Header，配置示例：

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

刪除原始請求中名為 X-Request-Foo 的請求頭

13、RemoveResponseHeader GatewayFilter Factory

為原始響應刪除某個Header，配置示例：

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

刪除原始響應中名為 X-Request-Foo 的響應頭

14、RewritePath GatewayFilter Factory

通過正則表達式重寫原始的請求路徑，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: rewritepath_route
        uri: https://example.org
        predicates:
        - Path=/foo/**
        filters:
        # 參數1為原始路徑的正則表達式，參數2為重寫后路徑的正則表達式
        - RewritePath=/foo/(?<segment>.*), /$\{segment}

該配置使得訪問 /foo/bar 時，會將路徑重寫為/bar 再進行轉發，也就是會轉發到 https://example.org/bar。需要注意的是：由于YAML語法，需用$\ 替換 $

15、RewriteResponseHeader GatewayFilter Factory

重寫原始響應中的某個Header，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: rewriteresponseheader_route
        uri: https://example.org
        filters:
        # 參數1為Header名稱，參數2為值的正則表達式，參數3為重寫后的值
        - RewriteResponseHeader=X-Response-Foo, password=[^&]+, password=***

該配置的意義在于：如果響應頭中 X-Response-Foo 的值為/42?user=ford&password=omg!what&flag=true，那么就會被按照配置的值重寫成/42?user=ford&password=***&flag=true，也就是把其中的password=omg!what重寫成了password=***

16、SaveSession GatewayFilter Factory

在轉發請求之前，強制執行WebSession::save操作，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: save_session
        uri: https://example.org
        predicates:
        - Path=/foo/**
        filters:
        - SaveSession

主要用在那種像 Spring Session 延遲數據存儲（數據不是立刻持久化）的，并希望在請求轉發前確保session狀態保存情況。如果你將Spring Secutiry于Spring Session集成使用，并想確保安全信息都傳到下游機器，你就需要配置這個filter。

17、secureHeaders GatewayFilter Factory

secureHeaders過濾器工廠主要是參考了這篇博客中的建議，為原始響應添加了一系列起安全作用的響應頭。默認會添加如下Headers（包括值）：

• 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'; script-src https:; style-src 'self' https: 'unsafe-inline'
• X-Download-Options:noopen
• X-Permitted-Cross-Domain-Policies:none

如果你想修改這些Header的值，那么就需要使用這些Headers對應的后綴，如下：

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

配置示例：

spring:
  cloud:
    gateway:
      filter:
        secure-headers:
          # 修改 X-Xss-Protection 的值為 2; mode=unblock
          xss-protection-header: 2; mode=unblock

如果想禁用某些Header，可使用如下配置：

spring:
  cloud:
    gateway:
      filter:
        secure-headers:
          # 多個使用逗號（,）分隔
          disable: frame-options,download-options

18、SetPath GatewayFilter Factory

修改原始的請求路徑，配置示例：

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

該配置使訪問 ${GATEWAY_URL}/foo/bar 時會轉發到 https://example.org/bar ，也就是原本的/foo/bar被修改為了/bar

19、SetResponseHeader GatewayFilter Factory

修改原始響應中某個Header的值，配置示例：

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

將原始響應中 X-Response-Foo 的值修改為 Bar

20、SetStatus GatewayFilter Factory

修改原始響應的狀態碼，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: setstatusstring_route
        uri: https://example.org
        filters:
        # 字符串形式
        - SetStatus=BAD_REQUEST
      - id: setstatusint_route
        uri: https://example.org
        filters:
        # 數字形式
        - SetStatus=401

SetStatusd的值可以是數字，也可以是字符串。但一定要是Spring HttpStatus 枚舉類中的值。上面這兩種配置都可以返回401這個HTTP狀態碼。

21、StripPrefix GatewayFilter Factory

用于截斷原始請求的路徑，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: nameRoot
        uri: http://nameservice
        predicates:
        - Path=/name/**
        filters:
        # 數字表示要截斷的路徑的數量
        - StripPrefix=2

如上配置，如果請求的路徑為 /name/bar/foo ，那么則會截斷成/foo后進行轉發 ，也就是會截斷2個路徑。

22、Retry GatewayFilter Factory

針對不同的響應進行重試，例如可以針對HTTP狀態碼進行重試，配置示例：

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

可配置如下參數：

• retries：重試次數
• statuses：需要重試的狀態碼，取值在 org.springframework.http.HttpStatus 中
• methods：需要重試的請求方法，取值在 org.springframework.http.HttpMethod 中
• series：HTTP狀態碼序列，取值在 org.springframework.http.HttpStatus.Series 中

23、RequestSize GatewayFilter Factory

設置允許接收最大請求包的大小，配置示例：

spring:
  cloud:
    gateway:
      routes:
      - id: request_size_route
      uri: http://localhost:8080/upload
      predicates:
      - Path=/upload
      filters:
      - name: RequestSize
        args:
          # 單位為字節
          maxSize: 5000000

如果請求包大小超過設置的值，則會返回 413 Payload Too Large以及一個errorMessage

24、Modify Request Body GatewayFilter Factory

在轉發請求之前修改原始請求體內容，該過濾器工廠只能通過代碼配置，不支持在配置文件中配置。代碼示例：

@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;
    }
}

Tips：該過濾器工廠處于 BETA 狀態，未來API可能會變化，生產環境請慎用

25、Modify Response Body GatewayFilter Factory

可用于修改原始響應體的內容，該過濾器工廠同樣只能通過代碼配置，不支持在配置文件中配置。代碼示例：

@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();
}

Tips：該過濾器工廠處于 BETA 狀態，未來API可能會變化，生產環境請慎用

26、Default Filters

Default Filters用于為所有路由添加過濾器工廠，也就是說通過Default Filter所配置的過濾器工廠會作用到所有的路由上。配置示例：

spring:
  cloud:
    gateway:
      default-filters:
      - AddResponseHeader=X-Response-Default-Foo, Default-Bar
      - PrefixPath=/httpbin

官方文檔：

• GatewayFilter Factories