2. 程式人生 > 實用技巧 >【轉載】Spring Cloud Gateway-過濾器工廠詳解（GatewayFilter Factories）

【轉載】Spring Cloud Gateway-過濾器工廠詳解（GatewayFilter Factories）

阿新 • • 發佈：2020-08-26

http://www.imooc.com/article/290816

TIPS

本文基於Spring Cloud Greenwich SR2，理論支援Spring Cloud Greenwich SR1，其中的新特性標註出來了。

這一節來探討Spring Cloud Gateway內建的Filter工廠。包括：

1 AddRequestHeader GatewayFilter Factory
2 AddRequestParameter GatewayFilter Factory
3 AddResponseHeader GatewayFilter Factory
4 DedupeResponseHeader GatewayFilter Factory

5 Hystrix GatewayFilter Factory
6 FallbackHeaders GatewayFilter Factory
7 PrefixPath GatewayFilter Factory
8 PreserveHostHeader GatewayFilter Factory
9 RequestRateLimiter GatewayFilter Factory
10 RedirectTo GatewayFilter Factory
11 RemoveHopByHopHeadersFilter GatewayFilter Factory
12 RemoveRequestHeader GatewayFilter Factory
13 RemoveResponseHeader GatewayFilter Factory
14 RewritePath GatewayFilter Factory
15 RewriteResponseHeader GatewayFilter Factory
16 SaveSession GatewayFilter Factory
17 SecureHeaders GatewayFilter Factory
18 SetPath GatewayFilter Factory
19 SetResponseHeader GatewayFilter Factory
20 SetStatus GatewayFilter Factory
21 StripPrefix GatewayFilter Factory
22 Retry GatewayFilter Factory
23 RequestSize GatewayFilter Factory
24 Modify Request Body GatewayFilter Factory
25 Modify Response Body GatewayFilter Factory
26 Default Filters

技巧

  • 斷點打在org.springframework.cloud.gateway.filter.NettyRoutingFilter#filter，就可以除錯Gateway轉發的具體細節了。

  • 新增如下配置，可觀察到一些請求細節：

    logging:
  level:
    org.springframework.cloud.gateway: trace
    org.springframework.http.server.reactive: debug
    org.springframework.web.reactive: debug
    reactor.ipc.netty: debug

1 AddRequestHeader GatewayFilter Factory

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

3 AddResponseHeader GatewayFilter Factory

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

TIPS

Spring Cloud Greenwich SR2提供的新特性，低於這個版本無法使用。

強烈建議閱讀一下類org.springframework.cloud.gateway.filter.factory.DedupeResponseHeaderGatewayFilterFactory上的註釋，比官方文件寫得還好。

spring:
  cloud:
    gateway:
      routes:
      - id: dedupe_response_header_route
        uri: https://example.org
        filters:
        - DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin, RETAIN_FIRST

剔除重複的響應頭。

舉個例子：

我們在Gateway以及微服務上都設定了CORS（解決跨域）header，如果不做任何配置，請求 -> 閘道器 -> 微服務，獲得的響應就是這樣的：

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

也就是Header重複了。要想把這兩個Header去重，只需設定成如下即可。

filters:
- DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin

也就是說，想要去重的Header如果有多個，用空格分隔即可；

去重策略：

RETAIN_FIRST: 預設值，保留第一個值
RETAIN_LAST: 保留最後一個值
RETAIN_UNIQUE: 保留所有唯一值，以它們第一次出現的順序保留

5 Hystrix GatewayFilter Factory

TIPS

Hystrix是Spring Cloud第一代中的容錯元件，不過已經進入維護模式（相關文章：Spring Cloud Netflix專案進入維護模式之我見），未來，Hystrix會被Spring Cloud移除掉，取而代之的是Alibaba Sentinel/Resilience4J。

所以本文不做詳細探討了，但Gateway整合Hystrix其實包含了很多姿勢。請感興趣的同學自行前往官方文件瞭解詳情：https://cloud.spring.io/spring-cloud-static/Greenwich.SR2/single/spring-cloud.html#hystrix。

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

6 FallbackHeaders GatewayFilter Factory

TIPS

也是對Hystrix的支援，不做詳細探討了，請感興趣的同學自行前往官方文件瞭解詳情：https://cloud.spring.io/spring-cloud-static/Greenwich.SR2/single/spring-cloud.html#fallback-headers

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

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

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

如果不設定，那麼名為Host的Header由Http Client控制；如果設定了，那麼會設定一個請求屬性（preserveHostHeader=true），路由過濾器會檢查從而去判斷是否要傳送原始的、名為Host的Header。

9 RequestRateLimiter GatewayFilter Factory

TIPS

在視訊Spring Cloud Gateway一章，限流一節會詳細講解。也可閱讀官方文件https://cloud.spring.io/spring-cloud-static/Greenwich.SR2/single/spring-cloud.html#_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

10 RedirectTo GatewayFilter Factory

spring:
  cloud:
    gateway:
      routes:
      - id: prefixpath_route
        uri: https://example.org
        filters:
        # 配置成HTTP狀態碼, URL的形式
        - RedirectTo=302, http://www.itmuch.com
  • HTTP狀態碼應該是HTTP狀態碼300序列，例如301
  • URL必須是合法的URL，並且該值會作為名為Location的Header。

上面配置表達的意思是：${GATEWAY_URL}/hello會重定向到https://ecme.org/hello，並且攜帶一個Location:http://www.itmuch.com的Header。

11 RemoveHopByHopHeadersFilter GatewayFilter Factory

spring.cloud.gateway.filter.remove-hop-by-hop.headers: Connection,Keep-Alive

移除轉發請求的Header，多個用,分隔。預設情況下，移除如下Header。這些Header是由IETF組織規定的。

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

12 RemoveRequestHeader GatewayFilter Factory

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

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

13 RemoveResponseHeader GatewayFilter Factory

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:
        # 配置成原始路徑正則, 重寫後的路徑的正則
        - RewritePath=/foo/(?<segment>.*), /$\{segment}

重寫請求路徑。如上配置，訪問/foo/bar會將路徑改為/bar再轉發，也就是會轉發到https://example.org/bar。需要注意的是，由於YAML語法，需用$\替換$。

15 RewriteResponseHeader GatewayFilter Factory

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

如果名為X-Response-Foo的響應頭的內容是/42？user=ford&password=omg!what&flag=true，則會被修改為/42?user=ford&password=***&flag=true。

16 SaveSession GatewayFilter Factory

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

在轉發到後端微服務請求之前，強制執行WebSession::save操作。用在那種像Spring Session延遲資料儲存（筆者注：資料不是立刻持久化）的，並希望在請求轉發前確保session狀態儲存情況。

如果你將Spring Secutiry於Spring Session整合使用，並想確保安全資訊都傳到下游機器，你就需要配置這個filter。

17 SecureHeaders GatewayFilter Factory

新增一系列起安全作用的響應頭。Spring Cloud Gateway參考了這篇部落格的建議：https://blog.appcanary.com/2017/http-security-headers.html

預設會新增如下Header（包括值）：

  • 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的值，可使用如下配置：

字首：spring.cloud.gateway.filter.secure-headers

上面的header對應的字尾：

  • 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.xss-protection-header: 你想要的值

如果想禁用某些Header，可使用如下配置：spring.cloud.gateway.filter.secure-headers.disable，多個用,分隔。例如：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}

採用路徑template引數，通過請求路徑的片段的模板化，來達到操作修改路徑的母的，執行多個路徑片段模板化。

如上配置，訪問${GATEWAY_PATH}/foo/bar，則對於後端微服務的路徑會修改為/bar。

19 SetResponseHeader GatewayFilter Factory

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

如果後端服務響應帶有名為X-Response-Foo的響應頭，則將值改為替換成Bar。

20 SetStatus GatewayFilter Factory

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

修改響應的狀態碼，值可以是數字，也可以是字串。但一定要是SpringHttpStatus列舉類中的值。如上配置，兩種方式都可以返回HTTP狀態碼401。

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

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。預設值是5M

24 Modify Request Body GatewayFilter Factory

TIPS

該過濾器處於BETA狀態，未來API可能會變化，生產環境請慎用。

可用於在Gateway將請求傳送給後端微服務之前，修改請求體內容。該過濾器只能通過程式碼配置，不支援在配置檔案設定。示例：

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

25 Modify Response Body GatewayFilter Factory

TIPS

該過濾器處於BETA狀態，未來API可能會變化，生產環境請慎用。

可用於修改響應體內容。該過濾器只能通過程式碼配置，不支援在配置檔案設定。示例：

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

26 Default Filters

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

如果你想為所有路由新增過濾器，可使用該屬性。

本文首發

http://www.itmuch.com/spring-cloud-gateway/gateway-filter-factory

相關推薦

【轉載】Spring Cloud Gateway-過濾器工廠詳解（GatewayFilter Factories）

http://www.imooc.com/article/290816 TIPS 本文基於Spring Cloud Greenwich SR2，理論支援Spring Cloud Greenwich SR1，其中的新特性標註出來了。

【轉載】Spring Cloud Gateway-全域性過濾器（Global Filters）

http://www.imooc.com/article/290821 TIPS 本文基於Spring Cloud Gateway SR2，理論適配Spring Cloud Gateway SR1以及更高版本。

【轉載】Spring Cloud Gateway監控

http://www.imooc.com/article/290822 歡迎加入Spring Cloud Gateway監控豪華套餐—— 只要為Spring Cloud Gateway新增Spring Boot Actuator（spring-boot-starter-actuator）的依賴，並將gateway端點

【轉載】Spring Cloud Gateway排錯、除錯技巧總結

http://www.imooc.com/article/290824 本文總結Spring Cloud Gateway的排錯、除錯技巧。歡迎留言補充！

【轉載】Dockerfile Maven外掛及擴充套件詳解

【原文連結】https://blog.csdn.net/taiyangdao/article/details/79817787 作為一個Docker專案，都繞不過Dockerfile檔案構建、打標籤和釋出等操作。如果能夠將對Dockerfile檔案的這些操作包含進Maven的生命週期管理中

【轉載】組播及igmp/mld協議詳解(二)

版權宣告：本文為CSDN博主「xinyuan0214」的原創文章，遵循CC 4.0 BY-SA版權協議，轉載請附上原文出處連結及本宣告。

【轉載】淺談SQL Server事務與鎖（上篇）

一  概述 在資料庫方面，對於非DBA的程式設計師來說，事務與鎖是一大難點，針對該難點，本篇文章試圖採用圖文的方式來與大家一起探討。

【轉載】Linux驅動之platform匯流排詳解

原文地址：https://www.jb51.net/article/231922.htm 1、platform 匯流排簡介 1.1、Linux 驅動的分離和分層思想

【轉載】Spring Boot 使用SSL-HTTPS

原文連結：https://zhuanlan.zhihu.com/p/31385073 Keytool是java提供的證書生成工具，如果配置了java_home的，直接就可以在控制檯進行生成了，這裡演示使用的是window的dos視窗：

SpringCloud學習筆記【十三】Spring Cloud Bus訊息匯流排

目錄本片要點Spring Cloud Bus簡介概述什麼是匯流排基本原理Docker安裝RabbitMQ演示動態重新整理全域性廣播前置準備新建模組，引入依賴配置bootstrap.yml編寫主啟動類編寫介面設計思想開始演示動態重新整理全域性廣播

【轉載】Spring 如何解決迴圈依賴的問題

（一）Spring IOC容器---物件迴圈依賴 1.什麼是迴圈依賴？ what？ （1）迴圈依賴-->迴圈引用。--->即2個或以上bean互相持有對方，最終形成閉環。

【Day04】Spring Cloud 昇華篇：容器化技術docker和kurbernetes

一、介紹 1、要考慮的問題 微服務數量有很多 中介軟體的部署-nacos-server sentinel-server

Spring Cloud Gateway過濾器精確控制異常返回(分析篇)

歡迎訪問我的GitHub 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：https://github.com/zq2599/blog_demos

Spring Cloud Gateway過濾器精確控制異常返回(實戰，控制http返回碼和message欄位)

歡迎訪問我的GitHub 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：https://github.com/zq2599/blog_demos

【計理01組58號】【搬運】Spring Cloud系列

搬運連結 https://www.cnblogs.com/sam-uncle/category/1205832.html spring cloud入門系列:初識spring cloud

【轉載】python自動提取文字中的時間（包含中文日期）

原文出處：https://www.cnblogs.com/i-love-python/p/12763063.html 有時在處理不規則資料時需要提取文字包含的時間日期。dateutil.parser模組可以統一日期字串格式。datefinder模組可以在字串中提取日期。datefinde

【轉載】淺析機器視覺中的照明系統（該如何打光）