Spring Cloud GateWay 路由轉(zhuǎn)發(fā)規(guī)則介紹詳解

Spring在因Netflix開源流產(chǎn)事件后，在不斷的更換Netflix相關(guān)的組件，比如：Eureka、Zuul、Feign、Ribbon等，Zuul的替代產(chǎn)品就是SpringCloud Gateway，這是Spring團(tuán)隊(duì)研發(fā)的網(wǎng)關(guān)組件，可以實(shí)現(xiàn)限流、安全認(rèn)證、支持長連接等新特性。

Spring Cloud Gateway

Spring Cloud Gateway是SpringCloud的全新子項(xiàng)目，該項(xiàng)目基于Spring5.x、SpringBoot2.x技術(shù)版本進(jìn)行編寫，意在提供簡單方便、可擴(kuò)展的統(tǒng)一API路由管理方式。

概念解釋：

• Route（路由）：路由是網(wǎng)關(guān)的基本單元，由ID、URI、一組Predicate、一組Filter組成，根據(jù)Predicate進(jìn)行匹配轉(zhuǎn)發(fā)。
• Predicate（謂語、斷言）：路由轉(zhuǎn)發(fā)的判斷條件，目前SpringCloud Gateway支持多種方式，常見如：Path、Query、Method、Header等。
• Filter（過濾器）：過濾器是路由轉(zhuǎn)發(fā)請求時所經(jīng)過的過濾邏輯，可用于修改請求、響應(yīng)內(nèi)容。

Spring Cloud GateWay 工作流程如下所示：

客戶端向Spring Cloud Gateway發(fā)出請求。如果網(wǎng)關(guān)處理程序映射確定請求與路由匹配，則將其發(fā)送到網(wǎng)關(guān)Web處理程序。此處理程序運(yùn)行時通過特定于請求的篩選鏈發(fā)送請求。過濾器被虛線分隔的原因是過濾器可以在發(fā)送代理請求之前或之后執(zhí)行邏輯。執(zhí)行所有“預(yù)”過濾邏輯，然后發(fā)出代理請求。在發(fā)出代理請求后，將執(zhí)行“post”過濾器邏輯。

開始使用

Spring Cloud Gateway目前有兩種方式進(jìn)行配置：

• application.yml配置文件方式
• 通過@Bean注解RouteLocator方法返回值

在本章會側(cè)重針對配置文件方式進(jìn)行講解，當(dāng)然RouteLocator方式也會簡單的告訴大家的使用方式。

添加依賴

添加Spring Cloud Gateway相關(guān)依賴，pom.xml如下所示：

//...省略部分內(nèi)容
<properties>
  <java.version>1.8</java.version>
  <spring-cloud.version>Greenwich.SR1</spring-cloud.version>
 </properties>

 <dependencies>
  <!--Spring Cloud Gateway-->
  <dependency>
   <groupId>org.springframework.cloud</groupId>
   <artifactId>spring-cloud-starter-gateway</artifactId>
  </dependency>

  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-test</artifactId>
   <scope>test</scope>
  </dependency>
 </dependencies>

 <dependencyManagement>
  <dependencies>
   <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-dependencies</artifactId>
    <version>${spring-cloud.version}</version>
    <type>pom</type>
    <scope>import</scope>
   </dependency>
  </dependencies>
 </dependencyManagement>
//...省略部分內(nèi)容

Spring Cloud Gateway Predicates

在我們開始本章內(nèi)容之前我們要來先了解下Spring Cloud Gateway內(nèi)部提供的所有謂語、斷言，這樣我們才能目標(biāo)性的進(jìn)行學(xué)習(xí)，我整理出來了一個腦圖，如下所示：

每一個Predicate的使用，你可以理解為：當(dāng)滿足這種條件后才會被轉(zhuǎn)發(fā)，如果是多個，那就是都滿足的情況下被轉(zhuǎn)發(fā)。

Path 方式匹配轉(zhuǎn)發(fā)

通過Path轉(zhuǎn)發(fā)示例，我們講解下上面的兩種配置，分別是application.yml以及RouteLocator。

配置文件匹配地址轉(zhuǎn)發(fā)

我們在application.yml配置文件內(nèi)添加對應(yīng)的路由配置，如下所示：

spring:
 application:
 name: spring-cloud-gateway-sample
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   # 匹配路徑轉(zhuǎn)發(fā)
   - Path=/api-boot-datasource-switch.html
# 端口號
server:
 port: 9090

先來解釋下route的組成部分：

• id：路由的ID
• uri：匹配路由的轉(zhuǎn)發(fā)地址
• predicates：配置該路由的斷言，通過PredicateDefinition類進(jìn)行接收配置。

在上面的配置中，當(dāng)訪問http://localhost:9090/api-boot-datasource-switch.html時就會被自動轉(zhuǎn)發(fā)到http://blog.yuqiyu.com/api-boot-datasource-switch.html，這里要注意完全匹配Path的值時才會進(jìn)行路由轉(zhuǎn)發(fā)。

訪問效果如下所示：

RouteLocator 匹配路徑轉(zhuǎn)發(fā)

在上面的配置中，如果使用RouteLocator方式該怎么進(jìn)行配置呢？

如下所示：

@Bean
public RouteLocator routeLocator(RouteLocatorBuilder builder) {
 return builder.routes()
 .route("blog", r -> 
   r.path("/api-boot-datasource-switch.html").uri("http://blog.yuqiyu.com"))
 .build();
}

Before 方式匹配轉(zhuǎn)發(fā)

當(dāng)部署有訪問時間限制的接口時，我們可以通過Before Predicate來完成某一個時間點(diǎn)之前允許訪問，過時后則不允許轉(zhuǎn)發(fā)請求到具體的服務(wù)，配置如下所示：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Before=2019-05-01T00:00:00+08:00[Asia/Shanghai]

在上面配置中，我們允許2019-05-01日凌晨之前通過路由轉(zhuǎn)發(fā)到http://blog.yuqiyu.com，通過查看org.springframework.cloud.gateway.handler.predicate.BeforeRoutePredicateFactory源碼我們發(fā)現(xiàn)，Spring Cloud Gateway的Before斷言采用的ZonedDateTime進(jìn)行匹配時間，這里要注意存在時區(qū)的問題，需要配置[Asia/Shanghai]作為中國時區(qū)。

After 方式匹配轉(zhuǎn)發(fā)

After Predicate與Before配置使用一致，匹配某一個時間點(diǎn)之后允許路由轉(zhuǎn)發(fā)，如下所示配置：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - After=2019-04-29T00:00:00+08:00[Asia/Shanghai]

在上面配置中允許2019-04-29凌晨之后進(jìn)行轉(zhuǎn)發(fā)到http://blog.yuqiyu.com。

Between 方式匹配轉(zhuǎn)發(fā)

那如果是一個時間段內(nèi)允許請求轉(zhuǎn)發(fā)，通過Before、After組合配置也可以完成，不過Spring Cloud Gateway還是提供了Between方式，如下所示：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Between=2019-04-29T00:00:00+08:00[Asia/Shanghai], 2019-05-01T00:00:00+08:00[Asia/Shanghai]

在上面配置中，允許在2019-04-29日凌晨后 & 2019-05-01凌晨之前請求轉(zhuǎn)發(fā)到http://blog.yuqiyu.com。

Cookie 方式匹配轉(zhuǎn)發(fā)

Spring Cloud Gateway 還提供了根據(jù)Cookie值的方式匹配轉(zhuǎn)發(fā)請求，如果請求中所攜帶的Cookie值與配置的Predicate匹配，那么就可以被允許轉(zhuǎn)發(fā)到指定地址，如下所示：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Cookie=hengboy, yuqiyu

在上面配置中，如果客戶端發(fā)送請求時攜帶了"hengboy=yuqiyu"的Cookie信息，則允許請求轉(zhuǎn)發(fā)。

測試Cookie方式轉(zhuǎn)發(fā)：

curl http://localhost:9090 --cookie "hengboy=yuqiyu"

通過上面方式我們是可以成功轉(zhuǎn)發(fā)請求的，如果我們修改Cookie的值，就會導(dǎo)致無法轉(zhuǎn)發(fā)，出現(xiàn)404。

Header 方式匹配轉(zhuǎn)發(fā)

Spring Cloud Gateway可以根據(jù)發(fā)送請求的Header信息進(jìn)行匹配轉(zhuǎn)發(fā)，加入我們可以根據(jù)X-Request-Id的值進(jìn)行匹配，如下所示：

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

在上面配置中，如果X-Request-Id的值為數(shù)字，那么就可以轉(zhuǎn)發(fā)到http://blog.yuqiyu.com，我們通過如下方式進(jìn)行測試：

curl http://localhost:9090 -H "X-Request-Id:123456"

如果頭信息為X-Request-Id:abc時，就會轉(zhuǎn)發(fā)失敗，出現(xiàn)404。

Host 方式匹配轉(zhuǎn)發(fā)

Spring Cloud Gateway可以根據(jù)Host主機(jī)名進(jìn)行匹配轉(zhuǎn)發(fā)，如果我們的接口只允許**.yuqiyu.com域名進(jìn)行訪問，那么配置如下所示：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Host=**.yuqiyu.com

測試如下所示：

1. curl http://localhost:9090 -H "Host: yuqiyu.com"  	// 匹配
2. curl http://localhost:9090 -H "Host: api.yuqiyu.com"		// 匹配
3. curl http://localhost:9090 -H "Host: admin.yuqiyu.com" // 匹配
3. curl http://localhost:9090 -H "Host: hengboy.com" 	 // 不匹配

請求方式 方式匹配轉(zhuǎn)發(fā)

Rest請求風(fēng)格的接口內(nèi)往往會存在多種請求方式的接口，如果我們的接口只允許POST請求訪問，那么配置如下所示：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Method=POST

發(fā)送GET請求測試：

~ curl http://localhost:9090
{"timestamp":"2019-04-29T06:27:41.121+0000","path":"/","status":404,"error":"Not Found","message":null}

我們的請求并未被Spring Cloud Gateway進(jìn)行轉(zhuǎn)發(fā)，那么我們再來通過POST請求進(jìn)行測試：

curl -X POST http://localhost:9090

是可以被轉(zhuǎn)發(fā)到目標(biāo)地址uri的，不過我的這個博客是OSS部署的，阿里云限制了POST訪問，盡管如此我們也證明了可以轉(zhuǎn)發(fā)。

請求參數(shù) 方式匹配轉(zhuǎn)發(fā)

Spring Cloud GateWay還支持根據(jù)指定的參數(shù)進(jìn)行匹配，Query方式的Predicate也有兩種方式匹配情況，如下所示：

請求中存在xxx參數(shù)

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Query=xxx

我們通過curl http://localhost:9090\?xxx\=123是可以被成功轉(zhuǎn)發(fā)的，只要參數(shù)存在xxx就會被成功轉(zhuǎn)發(fā)，否則出現(xiàn)404轉(zhuǎn)發(fā)失敗。

請求中存在xxx參數(shù)且值為zzz

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Query=xxx, zzz

根據(jù)上面配置，我們限定了參數(shù)xxx必須為zzz時才會被成功轉(zhuǎn)發(fā)，否則同樣會出現(xiàn)404抓發(fā)失敗。

請求路徑 方式匹配轉(zhuǎn)發(fā)

Spring Cloud Gateway提供了請求路徑變量方式匹配轉(zhuǎn)發(fā)，如下所示：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Path=/article/{articleId}

在上面配置中{articleId}是一個路徑變量，可以是任意值，匹配/article/1、/article/abc等，測試如下所示：

~ curl http://localhost:9090/article/1			// 匹配
~ curl http://localhost:9090/article/abc		// 匹配
~ curl http://localhost:9090/article/1/1		// 不匹配

Spring Cloud Gateway可以限制允許訪問接口的客戶端IP地址，配置后只對指定IP地址的客戶端進(jìn)行請求轉(zhuǎn)發(fā)，配置如下所示：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - RemoteAddr=192.168.1.56/24

在上面我們配置了192.168.1.56/24，其中192.168.1.56是客戶端的IP地址，而24則是子網(wǎng)掩碼。

組合示例

相同的Predicate也可以配置多個，請求的轉(zhuǎn)發(fā)是必須滿足所有的Predicate后才可以進(jìn)行路由轉(zhuǎn)發(fā)，組合使用示例如下所示：

spring:
 cloud:
 gateway:
  routes:
  - id: blog
   uri: http://blog.yuqiyu.com
   predicates:
   - Query=author, hengboy
   - Query=yuqiyu
   - Method=GET
   - Cookie=hengboy, yuqiyu
   - Header=X-Request-Id, \d+
   - RemoteAddr=192.168.1.56/24

總結(jié)

本章節(jié)講解了Spring Cloud Gateway的相關(guān)謂詞、斷言基本使用方式，GateWay內(nèi)部提供了很多種靈活的路由轉(zhuǎn)發(fā)規(guī)則，在同一個路由內(nèi)存在多個Predicate時，同時滿足規(guī)則后請求才會被路由轉(zhuǎn)發(fā)。

源碼位置

Gitee：https://gitee.com/hengboy/spring-cloud-chapter/tree/master/SpringCloud/spring-cloud-gateway

ApiBoot：https://gitee.com/hengboy/api-boot、https://github.com/hengboy/api-boot

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。