SpringCloud系列教程 | 第十三篇：Spring Cloud Gateway服務化和過濾器

Springboot: 2.1.6.RELEASE

SpringCloud: Greenwich.SR1

如無特殊說明，本系列教程全採用以上版本

上一篇文章服務閘道器 Spring Cloud GateWay 初級篇，介紹了 Spring Cloud Gateway 的相關術語、技術原理，以及如何快速使用 Spring Cloud Gateway。這篇文章我們繼續學習 Spring Cloud Gateway 的高階使用方式，比如如何配置服務中心來使用，如何使用熔斷、限流等高階功能。

1. 註冊中心

1.1 準備服務和註冊中心

上篇主要講解了閘道器代理單個服務的使用語法，在實際的工作中，服務的相互呼叫都是依賴於服務中心提供的入口來使用，服務中心往往註冊了很多服務，如果每個服務都需要單獨配置的話，這將是一份很枯燥的工作。Spring Cloud Gateway 提供了一種預設轉發的能力，只要將 Spring Cloud Gateway 註冊到服務中心，Spring Cloud Gateway 預設就會代理服務中心的所有服務，下面用程式碼演示。

在介紹Zuul的時候，我們用到了Eureka和producer，本次演示還是需要他們兩個，將他們兩個CV過來。

1.2 服務網關注冊到註冊中心

上一篇用到的gateway也CV過來，在依賴檔案裡面加入:

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

新增對eureka的依賴，在啟動檔案加入註解@EnableEurekaClient。

修改配置檔案application.yml：

server:
  port: 8080
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
logging:
  level:
    org.springframework.cloud.gateway: debug
 

配置說明：

• spring.cloud.gateway.discovery.locator.enabled：是否與服務註冊於發現元件進行結合，通過 serviceId 轉發到具體的服務例項。預設為 false，設為 true 便開啟通過服務中心的自動根據 serviceId 建立路由的功能。
• eureka.client.service-url.defaultZone指定註冊中心的地址，以便使用服務發現功能
• logging.level.org.springframework.cloud.gateway 調整相 gateway 包的 log 級別，以便排查問題

修改完成後啟動 gateway 專案，訪問註冊中心地址 http://localhost:8761/ 即可看到名為 API-GATEWAY的服務。

1.3 測試

將 gateway 註冊到服務中心之後，閘道器會自動代理所有的在註冊中心的服務，訪問這些服務的語法為：

http://閘道器地址：埠/服務中心註冊 serviceId/具體的url

比如我們的 producer 專案有一個 /hello 的服務，訪問此服務的時候會返回："hello "+name+"，producer is ready"。

比如訪問地址：http://localhost:8081/hello?name=spring，頁面返回：hello spring，producer is ready。

按照上面的語法我們通過閘道器來訪問，瀏覽器輸入：http://localhost:8080/SPRING-CLOUD-PRODUCER/hello?name=spring 同樣返回：hello spring，producer is ready。證明服務閘道器轉發成功。

我們將專案 producer 複製一份為 producer1，將/hello服務的返回值修改為 hello spring，producer1 is ready。修改埠號為 8082 ，修完完成後重啟，這時候訪問註冊中心後臺會發現有兩個名為 SPRING-CLOUD-PRODUCER的服務。

在瀏覽器多次訪問地址：http://localhost:8888/SPRING-CLOUD-PRODUCER/hello，頁面交替返回以下資訊：

hello spring，producer is ready。
hello spring，producer1 is ready。

說明後端服務自動進行了均衡負載。

2. 基於 Filter(過濾器) 實現的高階功能

在Zuul高階篇中大概介紹過 Filter 的概念。

Spring Cloud Gateway 的 Filter 的生命週期不像 Zuul 的那麼豐富，它只有兩個：“pre” 和 “post”。

• PRE： 這種過濾器在請求被路由之前呼叫。我們可利用這種過濾器實現身份驗證、在叢集中選擇請求的微服務、記錄除錯資訊等。
• POST：這種過濾器在路由到微服務以後執行。這種過濾器可用來為響應新增標準的 HTTP Header、收集統計資訊和指標、將響應從微服務傳送給客戶端等。

Spring Cloud Gateway 的 Filter 分為兩種：GatewayFilter 與 GlobalFilter。GlobalFilter 會應用到所有的路由上，而 GatewayFilter 將應用到單個路由或者一個分組的路由上。

Spring Cloud Gateway 內建了9種 GlobalFilter，比如 Netty Routing Filter、LoadBalancerClient Filter、Websocket Routing Filter 等，根據名字即可猜測出這些 Filter 的作者，具體大家可以參考官網內容：Global Filters

利用 GatewayFilter 可以修改請求的 Http 的請求或者響應，或者根據請求或者響應做一些特殊的限制。 更多時候我們會利用 GatewayFilter 做一些具體的路由配置，下面我們做一些簡單的介紹。

2.1 快速上手 Filter 使用

我們以 AddRequestParameter GatewayFilter 來演示一下，如何在專案中使用 GatewayFilter，AddRequestParameter GatewayFilter 可以在請求中新增指定引數。

2.1.1 配置application.yml示例

server:
  port: 8080
spring:
  application:
    name: api-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
      routes:
        - id: add_request_parameter_route
          uri: http://localhost:8081
          filters:
            - AddRequestParameter=foo, bar
          predicates:
            - Method=GET
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
logging:
  level:
    org.springframework.cloud.gateway: debug

這裡的 routes 手動指定了服務的轉發地址，設定所有的 GET 方法都會自動新增foo=bar，http://localhost:8081 是 producer 專案，我們在此專案中新增一個 foo() 方法，用來接收轉發中新增的引數 foo。

@RequestMapping("/foo")
public String foo(String foo) {
    return "hello "+foo+"!";
}

修改完成後重啟 gateway、producer 專案。訪問地址 http://localhost:8081/foo 頁面返回：hello null!，說明並沒有接受到引數 foo；通過閘道器來呼叫此服務，瀏覽器訪問地址 http://localhost:8080/foo 頁面返回：hello bar!，說明成功接收到引數 foo 引數的值 bar ,證明閘道器在轉發的過程中已經通過 filter 添加了設定的引數和值。

2.2 服務化路由轉發

面我們使用 uri 指定了一個服務轉發地址，單個服務這樣使用問題不大，但是我們在註冊中心往往會使用多個服務來共同支撐整個服務的使用，這個時候我們就期望可以將 Filter 作用到每個應用的例項上，spring cloud gateway 工了這樣的功能，只需要簡單配置即可。

為了測試兩個服務提供者是否都被呼叫，我們在 producer1 專案中也同樣新增 foo() 方法。

@RequestMapping("/foo")
public String foo(String foo) {
    return "hello "+foo+"!@@@@";
}

為了和 producer 中 foo() 方法有所區別，這裡使用了多加了4個@。同時將 gateway 專案配置檔案中的 uri 內容修改如下：

#格式為：lb://應用註冊服務名
uri: lb://spring-cloud-producer

修改完之後，重新啟動專案 gateway、producer1，瀏覽器訪問地址: http://localhost:8080/foo 頁面交替出現：

hello bar!
hello bar!@@@@

證明請求依據均勻轉發到後端服務，並且後端服務均接收到了 filter 增加的引數 foo 值。

這裡其實預設使用了全域性過濾器 LoadBalancerClient ，當路由配置中 uri 所用的協議為 lb 時（以uri: lb://spring-cloud-producer為例），gateway 將使用 LoadBalancerClient 把 producer 通過 eureka 解析為實際的主機和埠，並進行負載均衡。

示例程式碼-Github

參考：

http://www.ityouknow.com/springcloud/2019/01/19/spring-cloud-gateway-service.h