Geteway服務網關

一、概述

1、Gateway簡介

​ SpringCloud Gateway是SpringCloud的一個全新的項目，基於Spring 5.0 + SpringBoot 2.0和Project Reactor等技術開發的網關。爲提高網關性能，SpringCloud Gateway 是基於WebFlux框架實現的，而WebFlux框架底層則使用了高性能的Reactor模式通信框架Netty。其目標是提供統一的路由方式且基於Filter鏈的方式提供了網關基本的功能，例如：安全，監控/指標，限流。官方文檔地址 https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.2.RELEASE/reference/html/ 。

2、網關：實現反向代理、鑑權、流量控制、熔斷、日誌監控等。

二、核心概念

1、路由（Route）

​ 路由是構建網關的基本模塊，它由ID、目標URI以及一系列的斷言和過濾器組成，如果斷言爲true則匹配該路由。

2、斷言（Predicate）

​ 參考的是Java8的java.util.function.Predicate，開發人員可以匹配HTTP請求中的所有內容（例如請求頭或請求參數），如果請求與斷言匹配則進行路由。

3、過濾（Filter）

​ Spring框架中GatewayFilter的實例，使用過濾器可以在請求被路由前或者之後對請求就行修改。

三、Gateway工作流程

1、工作流程圖如下

2、說明

• 客戶端向Spring Cloud Gateway發出請求。如果在Gateway Handler Mapping中找到匹配的路由，則將其發送到Gateway Web Handler。
• Handler通過指定的過濾器鏈來將請求發送到我們實際的服務執行業務邏輯，然後返回。過濾器由虛線分隔的原因是，過濾器可以在發送代理請求之前(pre)和之後(post)運行邏輯。
• Filter在“pre”類型的過濾器可以做參數校驗、權限校驗、流量監控、日誌輸出、協議轉換等；在“post”類型的過濾器中可以做響應內容、響應頭的修改、日誌的輸出、流量監控。

四、案例配置

1、新建一個模塊用於網關，在pom中添加以下依賴。

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <!-- eureka-client -->
    <dependency>
    	<groupId>org.springframework.cloud</groupId>
    	<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!--引入自己定義的包-->
    <dependency>
    	<groupId>com.xhanglog.springcloud</groupId>
    	<artifactId>cloud-api-commons</artifactId>
    	<version>${project.version}</version>
    </dependency>
    <!--熱部署-->
    <dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-devtools</artifactId>
    	<scope>runtime</scope>
    	<optional>true</optional>
    </dependency>
    <dependency>
    	<groupId>org.projectlombok</groupId>
    	<artifactId>lombok</artifactId>
    	<optional>true</optional>
    </dependency>
    <dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-test</artifactId>
    	<scope>test</scope>
    </dependency>
</dependencies>

2、在application.xml中添加如下配置，啓動項目，便可以通過路由去訪問。

server:
  port: 9527
spring:
  application:
    name: cloud-gateway-service
  cloud:
    gateway:
      routes:
        - id: payment_routh #路由ID，沒有固定規則但要求唯一
          uri: http://localhost:8001 #匹配後提供服務的路由地址
          predicates:
            - Path=/payment/get/**  #斷言，路徑匹配的進行路由

        - id: payment_routh2 #路由ID，沒有固定規則但要求唯一
          uri: http://localhost:8001 #匹配後提供服務的路由地址
          predicates:
            - Path=/payment/lb/**  #斷言，路徑匹配的進行路由
eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    #是否從Eureka server 抓取已有的註冊信息，默認爲true。單節點無所謂，集羣必須設置爲true才能配合ribbon使用負載均衡
    fetch-registry: true
    #表示是否將自己註冊進入Eureka server ，默認爲true
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:7001/eureka

3、通過微服務名實現動態路由

​ 默認情況下Gateway會根據註冊服務中心註冊的服務列表，以註冊中心上微服務名爲路徑創建動態路由進行轉發，從而實現動態路由的功能。

• 在網關的application.yml配置中添加以下內容

  spring:
    cloud:
      gateway:
        discovery:
          locator:
            enabled: true #開啓從註冊中心動態創建路由的功能，利用微服務進行路由
  

• 將請求提供服務端地址修改爲註冊中心上微服務名即可。

4、自定義全局過濾器

• 定義一個類實現 GlobalFilter, Ordered 即可。

  public class MyGlobalFilter implements GlobalFilter, Ordered {
      public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
          log.info("*********************** MyGlobalFilter, date"+new Date());
          return chain.filter(exchange);
      }
  
      public int getOrder() {
          return 0; //過濾器加載順序，數字越小優先級越高
      }
  }
  

案例代碼地址：https://github.com/xhanglog/springcloud-learning