Springcloud-Alibaba 〖十〗微服務網關Gateway 動態路由斷言Predicate 自定義GlobalFilter

PS: github倉庫倉庫地址項目都放到裏面了

一. 什麼是Gateway網關?

Gateway是在Spring生態系統之上構建的API網關服務,基於Spring 5,Spring Boot 2和Project Reactor等技術。
Gateway旨在提供一種簡單而有效的方式來對API進行路由，以吸提供- 些強大的過濾器功能，例如:熔斷、限流、重試等
SpringCloud Gateway是Spring Cloud的一個全新項目,紆Spring 5.0+ Spring Boot 2.0和Project Reactor等技術開發的網關,它旨在爲微服務架構提供一種簡單有效的統一的API路由管理方式。
SpringCloud Gateway作爲Spring Cloud生態系統中的網關，目標是替代Zuul,在Spring Cloud 2.0以上版本中，沒有對新版本的Zuul 2.0以上最新高性能版本進行集成，仍然還是使用的Zuul 1.x非Reactor模式的老版本。而爲了提升網關的性能，SpringCloud Gateway是基於WebFlux框架實現的，而WebFlux框架底層則使用了高性能的Reactor模式通信框架Netty
SpringCloud Gateway的目標提供統一的路由方式且基於Filter 鏈的方式提供了網關基本的功能，例如:安全，監控/指標, 和限流。

二. Spring Cloud Gateway具有如下特性

基於Spring Framework 5, Project Reactor和Spring Boot 2.0進行構建;
動態路由:能夠匹配任何請求屬性;
可以對路由指定Predicate (斷言)和Filter (過濾器) ;
集成Hystrix的斷路器功能;
集成Spring Cloud服務發現功能;
易於編寫的Predicate (斷言)和Filter (過濾器) ;
請求限流功能;
支持路徑重寫。

三. 新建module cloud-gateway-gateway9527

3.1 項目目錄

3.2 pom

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>cloud2020</artifactId>
        <groupId>com.aiguigu.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-gateway-gateway9527</artifactId>

    <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>
        <!--引入自定義的api通用包，可使用Payment支付Entity-->
        <dependency>
            <groupId>com.aiguigu.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>1.0-SNAPSHOT</version>
            <scope>compile</scope>
        </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>
</project>

3.3 application.yml

server:
  port: 9527

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

        - id: payment_routh2 #payment_routh   #路由的ID，沒有固定規則但要求唯一，簡易配合服務名
          uri: http://localhost:8001          #匹配後提供服務的路由地址
          predicates:
            - Path=/payment/lb/**             #斷言，路徑相匹配的進行路由


eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      #設置與Eureka Server交互的地址查詢服務和註冊服務都需要依賴這個地址
      #      defaultZone: http://eureka7002.com:7002/eureka/
      #      單機版eureka
      defaultZone: http://eureka7001.com:7001/eureka/

3.4 主啓動

package com.atguigu.springcloud;

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

@SpringBootApplication
@EnableEurekaClient
public class GatewayMain9527 {

    public static void main(String[] args) {
        SpringApplication.run(GatewayMain9527.class,args);
    }
}

3.5 測試

打開我們的EurekaUI界面,發現服務已經註冊進來

測試網關,發現不用之前的localhost:8001/payment/get/3,9527直接在外面包裝了一層

3.6 路由的另外一種配置方法

這裏新建一個config

配置路由規則,代替yml配置

package com.atguigu.springcloud.config;

import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class GatewayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();

        routes.route("path_route_atguigu",
                r -> r.path("/guonei").uri("http://news.baidu.com/guonei")).build();
        return routes.build();
    }
}

如果要訪問 http://news.baidu.com/guonei 這個網站,配置路由規則爲http://localhost:9527/guonei就可以訪問到

四. 動態路由

動態路由實現

9527網關配置修改爲如下

server:
  port: 9527

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

        - id: payment_routh2 #payment_routh   #路由的ID，沒有固定規則但要求唯一，簡易配合服務名
          uri: lb://cloud-payment-service
#          uri: http://localhost:8001          #匹配後提供服務的路由地址
          predicates:
            - Path=/payment/lb/**             #斷言，路徑相匹配的進行路由


eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      #設置與Eureka Server交互的地址查詢服務和註冊服務都需要依賴這個地址
      #      defaultZone: http://eureka7002.com:7002/eureka/
      #      單機版eureka
      defaultZone: http://eureka7001.com:7001/eureka/

測試結果如下,9527網關成功從Eureka註冊中心找到並且實現了負載均衡

五. Gateway 常用的 Predicate

請求要滿足斷言表達式判斷爲true纔可訪問,只要一個不符合就回訪問不到服務

5.2 配置時間斷言

在當前時間之後纔可以訪問

時間格式複雜怎麼辦?這裏有生成當前時間的方法

import java.time.ZonedDateTime;

public class TimeBulider {
    public static void main(String[] args) {
        ZonedDateTime zonedDateTime=ZonedDateTime.now();
        System.out.println(zonedDateTime);
    }
}

測試,如果我將時間調至明天,再次訪問會出現找不到服務

可以看到這裏斷言還有After,Before和Between,方法都是大同小異

5.3 Cookie斷言

Cookie Route Predicate需要兩個參數, 一個是Cookie name ,一個是正則表達式。

路由規則會通過獲取對應的Cookie name值和正則表達式去匹配，如果匹配上就會執行路由，如果沒有匹配上則不執行

這裏配置一個Cookie 通過命令框的CURL去訪問,出現了負載均衡

5.4 Header斷言

 - Header=X-Request-Id, \d+ 
 #請求頭需要有X-Request-Id屬性名,值爲整數正則表達式

命令框輸入http://localhost:9527/payment/lb -H “X-Request-Id:1234”,負數就直接報錯

5.5總結

所有斷言不一一舉例了

說白了,Predicate就是爲了實現一組匹配規則,讓請求過來找到對應的Route進行處理。

六. Gateway的filter

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

路由過濾器可用於修改進入的HTTP請求和返回的HTTP響應,路由過濾器只能指定路由進行使用。

Spring Cloud Gateway內置了多種路由過濾器，他們都由GatewayFilter的工廠類來產生

常用的GatewayFilter 有31種之多
全局的Filter也有10種

6.1 自定義全局GlobalFilter

創建Gateway配置類

實現一個GlobalFilter

package com.atguigu.springcloud.filter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.Date;

@Component
@Slf4j
@Order(0)
public class MyLogGateWayFilter implements GlobalFilter{
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("***************Come in My LogGlobalFilter "+new Date());
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        if(uname==null){
            log.info("*******用戶名非法,請稍後再試!");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();

        }
        return chain.filter(exchange);
    }

//    @Override 實現上面@Order(0)註解就可以不用實現接口
//    public int getOrder() {
//        return 0;
//    }
}

這裏實現的是,請求進來必須帶有uname的參數纔可以訪問,測試以下

可以寫多個Filter進行過濾,傳回過濾連就行chain

Springcloud-Alibaba 〖十〗微服務網關Gateway 動態路由斷言Predicate 自定義GlobalFilter