Java之Springcloud Gateway內置路由的示例分析

這篇文章給大家分享的是有關Java之Springcloud Gateway內置路由的示例分析的內容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

Spring Cloud Gateway路由匹配是Spring WebFlux基礎功能的一部分，在Spring Cloud Gateway中內置了很多路由斷言工廠類。不同的斷言工廠類針對HTTP請求的不同屬性。多個斷言工廠類可以使用邏輯“and”進行組合使用。

4.1 After Route Predicate Factory

       這個Predicate工廠的實現類是AfterRoutePredicateFactory，使用一個時間參數，如果當前請求的時間在配置的趕時間之后，此斷言才會返回true。在application.yml中如下配置所示：

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: http://www.test111.com  # 如果斷言返回true,路由到的URI
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]

注意這個類使用的時間類是ZonedDateTime，表示ISO-8601日歷系統中具有時區的日期時間，所以在application.yml中的時間配置格式只能是：2017-01-20T17:42:47.789-07:00[America/Denver]，字符串的時間格式轉化為ZonedDateTime使用的是StringToZonedDateTimeConverter類。如果想使用其它的時間格式，得需要自己實現一個單獨的轉化類了。通過源碼中的測試例子可以看到，如果請求在配置的時間之前，網關會返回404，如果在配置的時間之后，網關路由成功到www.test111.com 網站。

      這里簡單說一下spring.cloud.gateway.routes的配置，它對應的是一個List列表，List列表存儲的對象類型是RouteDefinition，這是一個路由的定義類。id是在這個List列表中所有的路由定義中必須唯一，可以隨便定義。在RouteDefinition聲明的字段，在application.yml中的spring.cloud.gateway.routes中都可以配置。

4.2 Before Route Predicate Factory

       這個Predicate工廠的實現類是BeforeRoutePredicateFactory，它和AfterRoutePredicateFactory的實現基本上是一致的，在application.yml中的配置如下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: before_route
        uri: http://www.test111.com # 路由到的URI
        predicates:
        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

如果當前請求的時間在配置的時間之前，此斷言返回true，網關將請求路由到www.test111.com網站。否則，返回404。

4.3 Between Route Predicate Factory

       這個Predicate的工廠實現類是BetweenRoutePredicateFactory，它有兩個參數，datatime1,datetime2，在application.yml中的配置如下：

spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: http://www.test111.com
        predicates:
        - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

當請求網關的時間在datatime1之后，在datetim2之前時，這個斷言返回true，會將請求路由到www.test111.com網站。這個斷言對于維護一個時間窗口很有用。比如限制在基某段時間內開啟的活動，非這個時間段不可以訪問等。

4.4 Cookie Route Predicate Factory

       這個Predicate工廠的實現類是CookieRoutePredicateFactory，它有兩個參數，一個是name，另一個是正則表達式。在application.,yml中的配置如下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: http://www.test111.com
        predicates:
        - Cookie=username, wgslcuky

如果請求的Cookie中有name的值，并且根據name取出的值都匹配配置的正則表達式，這個斷方就返回true，會將請求路由到http://www.test111.com網站。上面的配置就是表示Cookie中username的值是wgslucky時，斷言返回true.

4.5 Header Route Predicate Factory

       這個Predicate工廠的實現類是HeaderRoutePredicateFactory，它有兩個參數，一個是name，另一個是正則表達式。在application.yml中的配置如下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: http://www.test111.com
        predicates:
        - Header=X-Request-Id, \d+

如果請求的Header里面有name的值，并且它的值與配置的正則表達式匹配，則斷言返回true，如果沒有配置正則表達式的值，斷言也是返回true（斷方只檢測帶正則表達式的配置）,將會把請求路由到http://www.test111.com網站。上面的配置示例表示Header中必須有X-Request-Id,且它的值必須是數字。

4.6 Host Route Predicate Factory

       這個Predicate的工廠的實現類是HostRoutePredicateFactory，這有一個參數，這個參數是一人List列表，它可以包含多個主機名字匹配的樣式。它遵循Ant的樣式風格，以點(.)分隔。在application.yml中的配置如下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: http://www.test111.com
        predicates:
        - Host=**.somehost.org,**.anotherhost.org,{sub}.myhost.org

上面示例中Host對應的URI模板變量同樣也支持{sub}.myhost.org格式的配置。如果請求的Header中的Host的值是www.sonmehost.org,abc.somehost.org,api.anotherhost.org，這個斷言就會返回true，將請求路由到http://www.test111.com網站。

在斷方工廠中會提取上面配置中Host對應的URI模板變量（比如上面的sub），把匹配的URI放到一個Map中，這個Map會被添加到ServerWebExchange.getAttributes(ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE)的屬性集中。可以在后面的Gateway Filter工廠類使用。

注意，在配置Host的時候，如果Host不是80端口，在配置的時候也需要添加上端口。如：localhost:8080

4.7 Method Route Predicate Factory

       這個Predicate的實現類是MethodRoutePredicateFactory，它有一個參數：指定的Http方法名。在application.yml中的配置如下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: http://www.test111.com
        predicates:
        - Method=GET

如果這個請求的方法名是GET，斷言將返回true,將請求路由到http://www.test111.com網站。

4.8 Path Route Predicate Factory

       這個Predicate的實現類是PathRoutePredicateFactory，它有兩個參數，一個是匹配樣式列表，另一個是boolean值，表示是否匹配分隔線。在application.yml中的配置好下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: path_route
        uri: http://www.test111.com
        predicates:
        - Path=/foo/{segment},/bar/{segment}

如果請求的URI中的路徑是/foo/1,/foo/bar或/bar/baz，這個斷言將返回true,會將請求路由到http://www.test111.com網站。這個斷言工廠將會提取配置的URI格式中的變量（比如上面配置的segment），并將它轉化為Map，替換掉ServerWebExchange.getAttributes(ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE)中的值。這個值可以在GatewayFilter工廠中使用。有一個方法可以方便的訪問這些值，如下面代碼所示：

Map<String, String> uriVariables = ServerWebExchangeUtils.getPathPredicateVariables(exchange);

String segment = uriVariables.get("segment");

4.9 Query Route Predicate Factory

    這個是參數路由斷言工廠，它的實現類是QueryRoutePredicateFactory，它有兩個參數，一個是參數（param），這個是必須的，另一個是可選參數，是一個正則表達式。在application.yml中不帶正則的配置如下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: http://www.test111.com
        predicates:
        - Query=baz

如果請求的參數中包含baz參數，斷言將返回true,并將請求路由到http://www.test111.com網站。帶正則表達式的配置如下所示：

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

如果請求的參數中包含foo，且它的值匹配ba.，斷言將返回true,并將請求路徑到http://www.test111.com網著。

4.10 RemoteAddr Route Predicate Factory

    這個是遠程地址路由斷言工廠，它的實現類是RemoteAddrRoutePredicateFactory，它有一個List列表的參數，這些參數是CIDR-notation（IPv4和IPv6）的地址字符串，比如192.168.0.1/16（192.168.0.1是ip地址，16是一個子網掩碼）。在application.yml中的配置如下所示：

spring:
  cloud:
    gateway:
      routes:
      - id: remoteaddr_route
        uri: http://www.test111.com
        predicates:
        - RemoteAddr=192.168.1.1/24

如果請求的客戶端的ip地址是192.168.1.1到192.168.1.24的范圍，此斷言返回true,并將請求路由到http://www.test111.com網站。比如192.168.1.10。

4.10．1修改遠程地址的解析方式

    默認情況下，RemoteAddrRoutePredicateFactory中用到的遠程客戶端的IP地址是從請求中獲取的，但是，如果Spring Cloud Gateway是部署在一個代理服務之后的話，這可能就匹配不到真實的客戶端IP地址。這樣的話，你可以實現RemoteAddressResolver接口，自定義一個IP地址的解析方式。在Spring Cloud Gateway中有一個非默認的遠程IP地址解析器XForwardedRemoteAddressResolver，它是基于X-Forwarded-For header實現的。XForwardedRemoteAddressResolver有兩個靜態的構造方法，可以用于不同的安全策略：XForwardedRemoteAddressResolver::trustAll方法返回一個RemoteAddressResolver實例，它返回從X-Forwarded-For header獲取到的第一個IP地址。這種方式容易受到欺騙攻擊，惡意的客戶端可以給X-Forwarded-For設置一個初始化的值，這個值對于解析器來說是可以接受的。XForwardedRemoteAddressResolver::maxTrustedIndex需要一個索引值做為參數，這個值和Spring Cloud Gateway前面受信任的代理設備數量相關。比如，如果Spring Cloud Gateway只可以通過HAPoxy訪問，那么maxTrustedIndex應該設置為1，如果需要通過兩個受信任的設備訪問，那么這個值應該設置為2。比如在Header中的X-Forwarded-For值如下所示：

X-Forwarded-For: 0.0.0.1, 0.0.0.2, 0.0.0.3

那么maxTrustedIndex的值與下面的遠程相對應：

如下面代碼所示：

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")
)

感謝各位的閱讀！關于“Java之Springcloud Gateway內置路由的示例分析”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！