# SpringCloud Gateway-服務網關 ## 1.Gateway介紹 ### 1.1引出問題 **沒有使用網關服務時：** **使用網關服務後：** ### 1.2Gateway網路拓撲圖 ![Gateway網路拓撲圖](https://liyuelian.oss-cn-shenzhe ...

SpringCloud Gateway-服務網關

1.Gateway介紹

1.1引出問題

沒有使用網關服務時：

使用網關服務後：

1.2Gateway網路拓撲圖

Gateway網路拓撲圖

1.3Gateway是什麼

官網：Spring Cloud Gateway

Gateway是Spring生態系統之上構建的API網關服務，基於Spring、SpringBoot和Project Reactor等技術
Gateway旨在提供一種簡單有效的方式來對API進行路由，以及提供一切強大的過濾器功能，例如：熔斷、限流、重試等

1.4Gateway核心功能

鑒權
流量控制
熔斷
日誌監控
反向代理

1.5Gateway vs Zuul

（1）Gateway和Zuul的區別：

SpringCloud Gateway 作為Spring Cloud 生態系統中的網關，目標是替代Zuul
SpringCloud Gateway 是基於Spring WebFlux 框架實現的
Spring WebFlux框架底層則使用了高性能的Reactor模式通信框架Netty，提高了網關性能

（2）Gateway特性：

SpringCloud Gateway 基於 Spring Framework（支持Spring WebFlux），Project Reactor 和 Spring Boot 進行構建，具有如下特性：

動態路由
可以對路由指定 Predicate（斷言）和 Filter（過濾器）
繼承 Hystrix 的斷路器功能
繼承 Spring Cloud 服務發現功能
請求限流功能
支持路徑重寫

2.Gateway基本原理

2.1Gateway核心組件（路由、斷言、過濾）

Route（路由）

一句話：路由是構建網關的基本模塊，它由ID，目標URI，一系列的斷言和過濾器組成，如果斷言為true，則匹配該路由
Predicate（斷言）

一句話：對Http請求中的所有內容（例如請求頭或請求參數）進行匹配，如果請求與斷言相匹配則進行路由。

簡單舉例：比如配置路徑
```
Path=/member/get/** //斷言，如果Http請求的路徑匹配，則進行路由轉發，如果不匹配則不進行路由轉發
```

Filter（過濾）

一句話：使用過濾器，可以在請求被路由前或者之後對請求進行處理。可以理解為，在對Http請求斷言匹配成功之後，可以通過網關的過濾機制，對Http請求處理

簡單舉例：

filters:
	AddRequestParameter=color,blue 
	#過濾器在匹配的請求頭加上一對請求頭,名稱為color,值為 blue, 比如原來的 http 請求為
	#http://localhost:10000/member/get/1 
	#--過濾器處理後->http://localhost:10000/member/get/1?color=blue

2.2工作機制

說明：

客戶端向 Spring Cloud Gateway 發出請求。然後在 Gateway Handler Mapping 中找到與請求相匹配的路由，將其發送到 Gateway Web Handler。
Handler 再通過指定的過濾器鏈來將請求發送到我們實際的服務執行業務邏輯，然後返回。
過濾器之間用虛線分開是因為過濾器可能會在發送代理請求之前（"pre"）或之後（"post"）執行業務邏輯。（可以參考SpringMVC的攔截器執行順序）
Filter 在"pre"類型的過濾器可以做參數校驗、許可權校驗、流量監控、日誌輸出、協議轉換等。
在"post"類型的過濾器中可以做響應內容、響應頭的修改，日誌的輸出，流量監控等有著非常重要的作用。
一句話：路由轉發+執行過濾器鏈

3.搭建Gateway微服務

3.1搭建Gateway-應用實例

3.1.1思路分析

如下，將原來的服務消費方升級成Gateway網關。

引入Gateway項目架構
1. 通過網關暴露的介面，實現調用真正的服務
2. 網關本身也是一個微服務模塊

3.1.2代碼實現

（1）參照之前的消費方member-service-consumer-80，創建e-commerce-gateway-20000項目

（2）修改項目的pom.xml文件

<!--引入相關的依賴，版本都使用父項目聲明的版本-->
<dependencies>
    <!--引入Gateway starter，網關場景啟動器-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>

    <!--引入EurekaClient場景啟動器starter-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>

    <!--不要引入springboot-starter-web和springboot-starter-actuator，
    因為Gateway是網關服務，不需要web-->

    <!--lombok-->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

    <dependency>
        <groupId>com.li.springcloud</groupId>
        <artifactId>e_commerce_center_common-api</artifactId>
        <version>${project.version}</version>
    </dependency>
</dependencies>

（3）配置項目的application.yml文件

當有用戶發送請求到網關Gateway，如 http://localhost:20000/member/get/1，前面 http://localhost:20000是網關的ip地址，後面的 /member/get/**是你配置的某一個路由地址的斷言predicates，Gateway根據配置的uri（服務提供方的uri），將uri和對應path拼接，得到真正的服務提供方地址。

如果網關匹配不到對應的斷言，則給客戶端返回404

server:
  port: 20000

spring:
  application:
    name: e-commerce-gateway
  cloud:
    gateway:
      routes: #配置路由，可以配置多個
        - id: member_router01 #路由id，要求唯一
          #gateway 最終訪問的url=uri+path, uri可以是任意的地址如 http://www.baidu.com
          #這裡的uri是雖然固定的，在真正開發情況下，是到Eureka Server等去發現uri的
          uri: http://localhost:10000 #服務提供方的介面
          predicates: #斷言，可以有多種形式
            - Path=/member/get/**
        - id: member_router02
          uri: http://localhost:10000
          predicates:
            - Path=/member/save

#配置EurekaClient
eureka:
  instance:
    hostname: e-commerce-service
  client:
    register-with-eureka: true #將自己註冊到EurekaServer
    #表示從EurekaServer抓取註冊信息
    fetch-registry: true
    service-url:
      #表示將自己註冊到哪個EurekaServer
      defaultZone: http://eureka9001.com:9001/eureka

（4）配置主啟動類

package com.li.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

/**
 * @author 李
 * @version 1.0
 */
@SpringBootApplication
@EnableEurekaClient
public class GateWayApplication20000 {
    public static void main(String[] args) {
        SpringApplication.run(GateWayApplication20000.class, args);
    }
}

3.1.3測試

順序啟動 e-commerce-eureka-server-9001，e-commerce-service-provider-10000，e-commerce-gateway-20000
通過瀏覽器（網關訪問）訪問 http://localhost:20000/member/get/1，訪問成功，說明網關gateway正常運行。
如果訪問的uri不匹配，則返回404提示
用postman進行測試

3.2Gateway路由配置方式

通過application.yml文件配置（上述例子）

通過編寫配置類註入：

@Configuration
public class GateWayRoutesConfig {
    @Bean
    public RouteLocator myRouteLocatior03(RouteLocatorBuilder routeLocatorBuilder) {
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        //分別指定id，path，uri
        // 其中第二個參數是一個函數式介面（lambda），接收類型是PredicateSpec, 返回類型 Route.AsyncBuilder
        return routes.route(
                "member_router03",
                r -> r.path("/member/get/**").uri("http://localhost:10000")
        ).build();
    }
}

兩種方式選擇一種即可，最好不要混用。

關於lambda表達式的使用，例子：

import java.util.function.Function;

/**
 * @author 李
 * @version 1.0
 */
public class LambdaTest {
    public static void main(String[] args) {
        //第一種形式
        //Dog dog = hi("小花", (String str) -> {//這裡其實就是實現apply介面
        //    Cat cat = new Cat();
        //    cat.setName(str);
        //    return cat;
        //});

        //第二種形式，簡寫
        //Dog dog = hi("小花", str -> {//這裡的str不指定類型也可以，因為hi方法已經指定了
        //    Cat cat = new Cat();
        //    cat.setName(str);
        //    return cat;
        //});

        //第二種形式簡寫後：
        //Dog dog = hi("小花", str -> {
        //    return new Cat(str);
        //});

        //對上面的lambda表達式再進行簡寫
        Dog dog = hi("小花", x -> new Cat(x));

        System.out.println(dog);
    }

    public static Dog hi(String str, Function<String, Cat> fn) {
        Cat cat = fn.apply(str);
        Dog dog = new Dog();
        dog.setName(cat.getName() + "~修改為小狗名");
        return dog;
    }
}

class Cat {
    private String name;

    Cat(String name) {
        this.name = name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

class Dog {
    private String name;

    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                '}';
    }
}

3.3動態路由

3.3.1需求分析

上面的例子中，配置的服務提供方的uri是寫死的，實際上，gateway可以實現動態路由，自動切換到不同的服務介面。

3.3.2代碼實現

修改網關微服務的application.yml文件配置：

spring:
  application:
    name: e-commerce-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true #啟用DiscoveryClient服務發現
      routes: #配置路由，可以配置多個
        - id: member_router01 #路由id，要求唯一
          #gateway 最終訪問的url=uri+path, uri可以是任意的地址如 http://www.baidu.com
          #這裡的uri是雖然固定的，在真正開發情況下，是到Eureka Server等去發現uri的
          #uri: http://localhost:10000 #服務提供方的介面
          # lb是協議名，member-service-provider 是服務提供方在註冊中心的名稱，要求小寫
          # 預設情況下負載均衡演算法為 輪詢
          uri: lb://member-service-provider
          predicates: #斷言，可以有多種形式
            - Path=/member/get/**
        - id: member_router02
          #uri: http://localhost:10000
          uri: lb://member-service-provider
          predicates:
            - Path=/member/save

重新順序啟動 e-commerce-eureka-server-9001，e-commerce-service-provider-10000，e-commerce-service-provider-10002，e-commerce-gateway-20000
通過瀏覽器（網關訪問）多次訪問 http://localhost:20000/member/get/5

訪問成功，說明網關gateway正常運行，並且負載均衡演算法預設為輪詢。

3.3.3註意事項

配置好動態路由之後，Gateway會根據註冊中心上的微服務名，為請求創建動態路由，實現動態路由功能，使用的lb協議支持負載均衡-輪詢演算法。

也可以使用javaconfig方式，配置註入自定義負載均衡演算法：

@Configuration
public class RibbonRule {
    @Bean
    public IRule myRibbonRule() {
        return new RandomRule();
    }
}

Ribbon常見負載演算法：

策略名	描述
BestAvailableRule	選擇一個最小併發請求的server。逐個考察server，如果server被tripped（跳閘）了，則忽略，再選擇其中ActiveRequestsCount最小的Server
AvailabilityFilteringRule	過濾掉那些因為一直連接失敗的被標記為circuit tripped的後端server，並過濾掉那些高併發的後端server（active connections超過配置的閾值）
WeightedResponseTimeRule	根據響應時間分配一個weight，響應時間越長，weight越小，被選中的可能性越低
RetryRule	對選定的負載均衡策略機上重試機制。在一個配置時間段內當選擇Server不成功，則一直嘗試使用subRule的方式選擇一個可用的server
RoundRobbinRule	輪詢index，選擇index對應位置的server
RandomRule	隨機選擇一個server，在index上隨機，選擇index對應位置的server
ZoneAvoidanceRule	複合判斷server所在區域的性能和server的可用性，來選擇server

3.4Predicate/斷言

3.4.1介紹

gateway-request-predicates-factories

Predicate就是一組匹配規則，當請求匹配成功，就執行對應的Route，匹配失敗則放棄處理/轉發。

Spring Cloud Gateway 包括許多內置的Route Predicate工廠, 所有這些Predicate都與HTTP請求的不同屬性匹配，可以組合使用。

Spring Cloud Gateway 創建 Route 對象時，使用RoutePredicateFactory 創建 Predicate 對象，Predicate 對象可以賦值給Route。

所有這些謂詞（判斷標準）都匹配HTTP請求的不同屬性。多種謂詞工廠可以組合。

3.4.2內置斷言Factories

Spring Cloud Gateway 2.1.0 中文官網文檔-騰訊雲開發者社區-騰訊雲 (tencent.com)

12.gateway中的斷言（predicate）的使用：內置斷言介紹、自定義斷言_gateway predicates_秀聚的博客-CSDN博客

1.After 路由斷言 Factory

After Route Predicate Factory採用一個參數——日期時間。在該日期時間之後發生的請求都將被匹配

例子：

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: http://example.org
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]

時間格式按照ZoneDateTime.now的格式

2.Before 路由斷言 Factory

Before Route Predicate Factory採用一個參數——日期時間。在該日期時間之前發生的請求都將被匹配。

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: http://example.org
        predicates:
        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

3.Between 路由斷言 Factory

Between 路由斷言 Factory有兩個參數，datetime1和datetime2。在datetime1和datetime2之間的請求將被匹配。

datetime2參數的實際時間必須在datetime1之後。

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

4.Cookie 路由斷言 Factory

Cookie 路由斷言 Factory有兩個參數：cookie名稱和正則表達式。請求包含cookie名稱，且正則表達式為真的將會被匹配

spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: http://example.org
        predicates:
        - Cookie=chocolate, ch.p

chocolate 是 cookie 名字；ch.p 是 cookie 的值，支持正則表達式

5.Header 路由斷言 Factory

Header 路由斷言 Factory有兩個參數，header名稱和正則表達式。請求包含次header名稱且正則表達式為真的將會被匹配

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

X-Request-Id 是 header 的名稱, \d+ 是一個正則表達式

6.Host 路由斷言 Factory

Host 路由斷言 Factory 包括一個參數：host name列表。使用Ant路徑匹配規則，Host 可以有多個, 使用逗號間隔。

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: http://example.org
        predicates:
        - Host=**.somehost.org,**.anotherhost.org

7.Method 路由斷言 Factory

Method 路由斷言 Factory只包含一個參數: 需要匹配的HTTP請求方式（GET或者POST方式）

spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: http://example.org
        predicates:
        - Method=GET

8.Path 路由斷言 Factory

Path 路由斷言 Factory 有2個參數：一個Spring PathMatcher表達式列表和可選matchOptionalTrailingSeparator標識

Path 可以有多個, 使用逗號間隔

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: http://example.org
        predicates:
        - Path=/foo/{segment},/bar/{segment}

9.Query 路由斷言 Factory

Query 路由斷言 Factory 有2個參數: 必選項 param 和可選項 regexp.

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

上面表示包含了請求參數 email 的都將被匹配。

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: http://example.org
        predicates:
        - Query=email, [\d]+

上面表示，如果請求參數里包含email參數，並且值要匹配數字且至少有一個數字，則將會被路由

10.RemoteAddr 路由斷言 Factory

RemoteAddr 路由斷言 Factory的參數為一個CIDR符號（IPv4或IPv6）字元串的列表，最小值為1，例如192.168.0.1/16（其中192.168.0.1是IP地址並且16是子網掩碼）

spring:
  cloud:
    gateway:
      routes:
      - id: remoteaddr_route
        uri: http://example.org
        predicates:
        - RemoteAddr=192.168.1.1/24

如上，若請求的remote address 為 192.168.1.10，則會被路由

註意：這裡的remote address不是服務方的地址，而是調用端（客戶端）的地址。

11.Weight路由斷言Factory

WeightRoutePredicateFactory：接收一個 [組名,權重] 然後對於同一個組內的路由按照權重轉發

gateway:
  routes:
  - id: weight_high
    uri: https://weighthigh.org
    predicates:
      - Weight=group1, 8
  - id: weight_low
    uri: https://weighlow.org
    predicates:
      - Weight= group1, 2

將會把80%的流量轉發到weighthigh，將20%的流量轉發到weighlow

3.5Filter/過濾器

gatewayfilter-factories

Spring Cloud : Gateway 網關過濾器 GatewayFilter

Spring Cloud Gateway 內置了多種路由過濾器，他們都由GatewayFilter的工廠類來產生。Gateway 根據作用範圍劃分為 GatewayFilter 和 GlobalFilter，區別如下：

1.GatewayFilter：網關過濾器，需要通過 spring.cloud.routes.filters 配置在具體路由下，只作用在當前路由上或通過 spring.cloud.default-filters 配置在全局，作用在所有路由上。

2.GlobalFilter：全局過濾器，不需要在配置文件中配置，作用在所有的路由上，最終通過GatewayFilterAdapter 包裝成 GatewayFilterChain 可識別的過濾器，它為請求業務以及路由的 URI 轉換為真實業務服務請求地址的核心過濾器，不需要配置系統初始化時載入，並作用在每個路由上。

3.5.1網關過濾器GatewayFilter

網關過濾器用於攔截並鏈式處理 Web 請求，可以實現橫切與應用無關的需求，比如：安全、訪問超時的設置等。修改傳入的 HTTP 請求或傳出 HTTP 響應。

Spring Cloud Gateway 包含許多內置的網關過濾器工廠，一共有 22 個，包括頭部過濾器、路徑類過濾器、Hystrix 過濾器和重寫請求 URL 的過濾器，還有參數和狀態碼等其他類型的過濾器。

根據過濾器工廠的用途來劃分，可以分為以下幾種：Header、Parameter、Path、Body、Status、Session、Redirect、Retry、RateLimiter 和 Hystrix。

/resources/articles/spring/spring-cloud/gateway/20181202154250869.png

請求參數過濾器-例子：

filters:
	AddRequestParameter=color,blue 
	#過濾器在匹配的請求頭加上一對請求頭,名稱為color,值為 blue
	#比如原來的 http 請求為 http://localhost:10000/member/get/1 
	#--過濾器處理後->http://localhost:10000/member/get/1?color=blue

3.5.2全局過濾器GlobalFilter

全局過濾器不需要在配置文件中配置，作用在所有的路由上，最終通過 GatewayFilterAdapter 包裝成 GatewayFilterChain 可識別的過濾器，它是請求業務以及路由的 URI 轉換為真實業務服務請求地址的核心過濾器，不需要配置系統初始化時載入，並作用在每個路由上。

/resources/articles/spring/spring-cloud/gateway/920071-20190929104112590-1124234164.png

自定義GlobalFilter需要實現兩個介面：GatewayFilter，Ordered

例子

package com.li.springcloud.filter;

import ...

/**
 * @author 李
 * @version 1.0
 */
@Component
public class CustomGatewayFilter implements GlobalFilter, Ordered {
    //filter方法中編寫業務
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //自定義網關過濾器...
        return chain.filter(exchange);// 繼續向下執行
    }

    //order 表示該過濾器執行的順序，數字越小，優先順序越高.
    @Override
    public int getOrder() {
        return 0;
    }
}

day08-SpringCloud Gateway-服務網關