如何理解Gateway網關服務

本篇內容介紹了“如何理解Gateway網關服務”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

Gateway 網關服務

一、概述

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

二、作用

作用
    反向代理
    鑒權
    流量控制
    熔斷
    日志監控

三、三大核心概念

• Route（路由）

    路由是構建網關的基本模塊，由ID,URI,一系列的斷言和過濾器組成，如果斷言為true則匹配該路由

• Predicate 斷言

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

• Filter 過濾

    指Spring框架中GatewayFilter的實例，使用過濾器，可以在請求被路由前或之后對請求進行修改

總結：

web請求通過一些匹配條件，定位到真正的服務節點。并在這個轉發過程的前后，進行一些精細化控制
predicate就是我們的匹配條件，
而Filter可以理解為一個無所不能的過濾器，有了這兩個元素再加上目標Uri 就可以實現一個具體的路由。

四、Gateway工作流

客戶端向SpringCloudGateway發出請求。然后在GatewayHandlerMapping中找到與請求相匹配的路由，將其發送到GatewayWebHandler.

Handle再通過指定的過濾鏈來將請求發送到我們實際的服務執行業務邏輯 ，然后返回。
過濾器可能會在發送代理請求之前"pre" 或之后 “post”執行業務邏輯

Filter在“pre”類型的過濾器可以做參數校驗、權限校驗、流量控制、日志輸出、協議轉換等，在“post”類型的過濾器可以做響應內容、響應頭的修改，日志的輸出，流量監控等有非常重要的作用

五、入門配置

1.新建module cloud-gateway-gateway9527

2.pom

需要移除spring-boot-starter-web 否則報錯
    Spring MVC found on classpath, which is incompatible with Spring Cloud Gateway at this time. Please remove spring-boot-starter-web dependency.

 <dependencies>
        <!--gateway-->
        <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>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>

3.yml

server:
  port: 9527
spring:
  application:
    name: cloud-gateway

eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    register-with-eureka: true
    fetchRegistry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka

4.main

@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9527 {
    public static void main(String[] args) {
        SpringApplication.run(GateWayMain9527.class,args);
    }
}

5.通過網關訪問8001的接口

映射兩個接口

/payment/lb

/payment/get/{id}

YML新增網關配置：

    新增spring.cloud.gateway.routes部分

server:
  port: 9527
spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      routes:
        - id: payment_routh #payment_route    #路由的ID，沒有固定規則但要求唯一，建議配合服務名
          uri: http://localhost:8001          #匹配后提供服務的路由地址
          predicates:
            - Path=/payment/get/**         # 斷言，路徑相匹配的進行路由
        - id: payment_routh3 #payment_route    #路由的ID，沒有固定規則但要求唯一，建議配合服務名
          uri: http://localhost:8001          #匹配后提供服務的路由地址
          predicates:
            - Path=/payment/lb/**         # 斷言，路徑相匹配的進行路由
eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    register-with-eureka: true
    fetchRegistry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka

啟動7001、cloud-provider-payment8001、9527

訪問
    http://localhost:9527/payment/get/1

6.YML配置說明

Gateway網關路由有兩種配置方式

6.1 在YML中配置

6.2 代碼中注入RouteLocator的Bean

參考：https://spring.io/projects/spring-cloud-gateway

com.zhl.springcloud.config.GateWayConfig

@Configuration
public class GateWayConfig {
    @Bean
    public RouteLocator customeRouteLocator(RouteLocatorBuilder builder){
        RouteLocatorBuilder.Builder routes = builder.routes();
        routes.route("path_route_atguigu1",
                r->r.path("/guonei")
                        .uri("http://news.baidu.com/guonei")).build();
        return  routes.build();
    }
}

6.3 測試訪問

    http://localhost:9527/guonei 跳轉 http://news.baidu.com/guonei

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

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

1.啟動Eureka和服務提供者 8001 8002

2.YML

    1.spring.cloud.gateway.discovery.locator.enabled:true

    2.spring.cloud.gateway.routes[0].uri：lb://cloud-payment-service #匹配后提供服務的路由地址

        spring.cloud.gateway.routes[1].uri：lb://cloud-payment-service

server:
  port: 9527
spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true #開啟從注冊中心動態創建路由的功能，利用微服務名進行路由
      routes:
        - id: payment_routh #payment_route    #路由的ID，沒有固定規則但要求唯一，建議配合服務名
          uri: lb://cloud-payment-service #匹配后提供服務的路由地址
          predicates:
            - Path=/payment/get/**         # 斷言，路徑相匹配的進行路由

        - id: payment_routh3 #payment_route    #路由的ID，沒有固定規則但要求唯一，建議配合服務名
          uri: lb://cloud-payment-service #匹配后提供服務的路由地址
          predicates:
            - Path=/payment/lb/**         # 斷言，路徑相匹配的進行路由

eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    register-with-eureka: true
    fetchRegistry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka

3.測試

訪問：http://localhost:9527/payment/lb   

8001/8002

七、Predicate的使用

1.Predicate是什么

2.RoutePredicateFactories 是什么

查看啟動的后臺信息：

Spring Cloud Gateway將路由匹配作為SpringWebFlux HandlerMapping基礎架構的一部分

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

Spring Cloud Gateway創建Route對象時，使用RoutePredicateFactory創建Predicate對象，Predicate對象可以賦值給Route。SpringCloudGateway包含許多內置的RoutePredicateFatories

3. 常用的Route Predicate

參考官網：

https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/#gateway-request-predicates-factories

1.After Route Predicate
    在時間之后  使用 ZonedDateTime.now() 獲取時間

        - id: payment_routh3 #payment_route    #路由的ID，沒有固定規則但要求唯一，建議配合服務名
          #uri: http://localhost:8001          #匹配后提供服務的路由地址
          uri: lb://cloud-payment-service #匹配后提供服務的路由地址
          predicates:
            - Path=/payment/lb/**         # 斷言，路徑相匹配的進行路由
            - After=2020-02-21T15:51:37.485+08:00[Asia/Shanghai]

2.Before Route Predicate
    在時間之前
3.Between Route Predicate
    時間之間
4.Cookie Route Predicate

        - id: payment_routh3 #payment_route    #路由的ID，沒有固定規則但要求唯一，建議配合服務名
          #uri: http://localhost:8001          #匹配后提供服務的路由地址
          uri: lb://cloud-payment-service #匹配后提供服務的路由地址
          predicates:
            - Path=/payment/lb/**         # 斷言，路徑相匹配的進行路由
            #- After=2020-02-21T15:51:37.485+08:00[Asia/Shanghai]
            - Cookie=username,zzyy

  不帶cookie訪問 

C:\Users\Administrator>curl http://localhost:9527/payment/lb
{"timestamp":"2020-12-04T14:16:14.906+00:00","path":"/payment/lb","status":404,"error":"Not Found",......

   帶上cookie訪問 

C:\Users\Administrator>curl http://localhost:9527/payment/lb  --cookie "username=zzyy"
8002

5.Header

        - id: payment_routh3 #payment_route    #路由的ID，沒有固定規則但要求唯一，建議配合服務名
          uri: lb://cloud-payment-service #匹配后提供服務的路由地址
          predicates:
            - Path=/payment/lb/**         # 斷言，路徑相匹配的進行路由
            - Header=X-Request-Id, \d+  # 請求頭要有X-Request-Id屬性并且值為整數的正則表達式

C:\Users\Administrator>curl http://localhost:9527/payment/lb  -H "X-Request-Id:1234"
8002

C:\Users\Administrator>curl http://localhost:9527/payment/lb  -H "X-Request-Id:aaaa"
{"timestamp":"2020-12-04T14:22:01.354+00:00","path":"/payment/lb","status":404,"error":"Not Found",

6.Host

Host Route Predicate接收一組參數，一組匹配的域名列表，這個模板時一個ant分割的模板，用.號作為分隔符它通過參數中的主機地址作為匹配規則。
7.Method
8.Path
9.Query
10.小結

八、Filter的使用

指的是Spring框架中GatewayFilter的實例，使用過濾器，可以再請求被路由前或之后對請求進行修改。

路由過濾器允許以某種方式修改傳入的HTTP請求或傳出的HTTP響應。路由過濾器適用于特定路由。Spring Cloud Gateway包括許多內置的GatewayFilter工廠

1.聲明周期

    Pre  Post

2.種類

GatewayFilter:     單一的
GlobalFilter:        全局的

3.常用的GatewayFilter

    AddRequestParameter

4.自定義過濾器

A. 兩個主要接口

B.作用

    全局日志記錄

    統一網關鑒權...

C.案例代碼

新增 組件 ：com.zhl.springcloud.filter.MyLogGateWayFilter

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("*****come in MyLogGateWayFilter: "+new Date());
        String name =exchange.getRequest().getQueryParams().getFirst("uname");
        if (name==null){
            log.info("***用戶名為null ，非法用戶***");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        /*加載過濾器的順序，順序越小優先級越高*/
        return 0;
    }
}

D.測試

C:\Users\Administrator>curl http://localhost:9527/payment/lb?uname=z3
8002

“如何理解Gateway網關服務”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！