SpringCloudAlibaba項目之GateWay網關

SpringCloudAlibaba隨筆目錄

一、SpringCloudAlibaba項目之父工程搭建

二、SpringCloudAlibaba項目之Nacos搭建及服務注冊

三、SpringCloudAlibaba項目之生產者與消費者

四、SpringCloudAlibaba項目之Ribbon負載均衡

五、SpringCloudAlibaba項目之OpenFeign遠程調用

六、SpringCloudAlibaba項目之Nacos-config配置中心

七、SpringCloudAlibaba項目之Sentinel流量控制

八、SpringCloudAlibaba項目之Seata分布式事務

九、SpringCloudAlibaba項目之GateWay網關

十、SpringCloudAlibaba項目之SkyWalking鏈路追蹤

 

SpringCloudAlibaba項目之GateWay網關

1、什么是API 網關

　　（1）定義

　　網關的角色是作為一個 API 架構，用來保護、增強和控制對於 API 服務的訪問。API 網關是一個處於應用程序或服務（提供 REST API 接口服務）之前的系統，用來管理授權、訪問控制和流量限制等，這樣 REST API 接口服務就被 API 網關保護起來，對所有的調用者透明。因此，隱藏在 API 網關后面的業務系統就可以專注於創建和管理服務，而不用去處理這些策略性的基礎設施。

　　（2）職能

 　　（3）分類與功能

2、GateWay

　　（1）簡介

　　Spring Cloud Gateway是Spring官方基於Spring 5.0，Spring Boot 2.0和Project Reactor等技術開發的網關，Spring Cloud Gateway旨在為微服務架構提供一種簡單而有效的統一的API路由管理方式。Spring Cloud Gateway作為Spring Cloud生態系中的網關，目標是替代ZUUL，其不僅提供統一的路由方式，並且基於Filter鏈的方式提供了網關基本的功能，例如：安全，監控/埋點，和限流等。

　　github：https://github.com/apex/gateway

　　（2）為什么使用Gateway

　　Spring Cloud Gateway 可以看做是一個 Zuul 1.x 的升級版和代替品，比 Zuul 2 更早的使用 Netty 實現異步 IO，從而實現了一個簡單、比 Zuul 1.x 更高效的、與 Spring Cloud 緊密配合的 API 網關。
　　Spring Cloud Gateway 里明確的區分了 Router 和 Filter，並且一個很大的特點是內置了非常多的開箱即用功能，並且都可以通過 SpringBoot 配置或者手工編碼鏈式調用來使用。
比如內置了 10 種 Router，使得我們可以直接配置一下就可以隨心所欲的根據 Header、或者 Path、或者 Host、或者 Query 來做路由。
比如區分了一般的 Filter 和全局 Filter，內置了 20 種 Filter 和 9 種全局 Filter，也都可以直接用。當然自定義 Filter 也非常方便。

　　（3）概念

 3、快速使用

pom.xml依賴

<!-- nacos 服務注冊發現（客戶端）依賴 -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!-- gateway 網關依賴 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

application.yml（推薦使用yaml格式）

# 應用服務 WEB 訪問端口
server:
  port: 8090
spring:
  application:
    name: service-gateway # 應用名稱
  cloud:
    # Nacos幫助文檔: https://nacos.io/zh-cn/docs/concepts.html
    # Nacos認證信息
    nacos:
      discovery:
        username: nacos
        password: nacos
        # Nacos 服務發現與注冊配置，其中子屬性 server-addr 指定 Nacos 服務器主機和端口
        server-addr: 127.0.0.1:8848
        namespace: public # 注冊到 nacos 的指定 namespace，默認為 public
    # gateway 配置
    gateway:
      # 路由規則
      routes:
        - id: order_route # 路由的唯一標識，路由到order
          uri: lb://service-openfeign  # 需要轉發的地址  lb：使用nacos本地的負載均衡策略
          # 斷言規則 用於路由規則的匹配
          predicates:
            - Path=/service-order/**
          # 過濾器
          filters:
            - StripPrefix=1 #轉發之前去掉第一層路由

注意：yaml格式注意每個字段對應的位置，否則會出問題

訪問地址：http://127.0.0.1:8090/service-order/order/addOrder

 4、路由斷言工廠

　　Spring Cloud Gateway的路由匹配的功能是以Spring WebFlux中的Handler Mapping為基礎實現的。Spring Cloud Gateway也是由許多的路由斷言工廠組成的。Http Request請求進入Spring Cloud Gateway的時候，網關路由斷言工廠對請求進行斷言匹配。匹配成功允許進入，失敗則返回錯誤信息。

（1）內置路由斷言工廠

　　4.1、After Route Predicate Factory

　　After Route Predicate Factory 中獲取一個UTC時間格式的參數， 當請求的當前時間在配置的UTC時間之后，則會成功匹配，否則不能成功匹配。

application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: http://xxx.com
        predicates:
        - After=2021-01-20T17:42:47.789-07:00[Asia/Shanghai]

　　該路由匹配所有UTC時間Jan 20, 2021 17:42后的請求，並且路由到uri:http://xxx.com

　　4.2、Before Route Predicate Factory

　　Before Route Predicate Factory 中獲取一個UTC時間格式的參數， 當請求的當前時間在配置的UTC時間之前，則會成功匹配，否則不能成功匹配。

application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: before_route
        uri: http://xxx.com
        predicates:
        - Before=2021-01-20T17:42:47.789-07:00[Aisa/Shanghai]

　　該路由匹配所有UTC時間Jan 20, 2021 17:42之前的請求，並且路由到uri:http://xxx.com

　　4.3、Between Route Predicate Factory

　　Between Route Predicate Factory 中獲取一個UTC時間格式的參數， 當請求的當前時間在配置的UTC時間之間，則會成功匹配，否則不能成功匹配。

application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: http://xxx.com
        predicates:
        - Between=2021-01-20T17:42:47.789-07:00[Aisa/Shanghai], 2021-01-21T17:42:47.789-07:00[Aisa/Shanghai]

　　如果在這個區間，就可以正常匹配路由並訪問。

　　4.4、Cookie Route Predicate Factory

　　Cookie Route Predicate Factory 會取兩個參數（Header中以“Cookie”命名的名稱，對應的Key和Value）。當請求攜帶的cookie和Cookie斷言工廠配置的一致，則路由匹配成功，否則匹配失敗。

application.yml

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

這個路由將匹配cookie中存在chocolate=ch.p的請求　　

　　4.5、Header Route Predicate Factory

Header Route Predicate Factory 根據配置的路由Header信息進行斷言匹配路由，匹配成功進行轉發，否則不進行轉發。
application.yml

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

這個路由將匹配請求頭中包含X-Request-Id且值為一個或者多個數字的請求。

　　4.6、Host Route Predicate Factory

Host Route Predicate Factory 根據配置的Host，對請求中的Host進行斷言處理，斷言匹配成功進行轉發，否則不進行轉發。

application.yml

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

這個路由將匹配請求的Host頭為www.somehost.org or beta.somehost.org or www.anotherhost.org.　　

　　4.7、Method Route Predicate Factory

Method Route Predicate Factory 根據路由信息配置的Method對請求方式是Get或者Post等進行斷言匹配，斷言匹配成功進行轉發，否則不進行轉發。

application.yml

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

這個路由匹配HttpMethod為Get的請求。

　　4.8、Path Route Predicate Factory

Path Route Predicate Factory 基於Spring PathMatcher 模式的路徑匹配路由。

application.yml

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

如有請求地址如 /foo/1 or /foo/bar or /bar/baz，那么將匹配該路由。

　　4.9、Query Route Predicate Factory

Query Route Predicate Factory 根據請求中的兩個參數進行斷言匹配，斷言匹配成功進行轉發，否則不進行轉發。

application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: http://xxx.com
        predicates:
        - Query=foo,baz

當前路由將匹配路徑參數包含foo=baz的請求。

　　4.10、RemoteAddr Route Predicate Factory

　　RemoteAddr Route Predicate Factory 配置一個IPv4或者IPv6網段的字符串或者IP。當請求IP地址在網段之內或者和配置的IP相同，斷言匹配成功進行轉發，否則不進行轉發。

application.yml

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

請求發起端ip為192.168.1.1~192.168.1.255的請求。

參考鏈接：https://www.jianshu.com/p/14132c18f683

（2）自定義路由斷言工廠

　　自定義路由斷言工廠需要繼承 AbstractRoutePredicateFactory 類，重寫 apply 方法的邏輯和shortcutFieldOrder方法。在 apply 方法中可以通過 exchange.getRequest() 拿到 ServerHttpRequest 對象，從而可以獲取到請求的參數、請求方式、請求頭等信息。apply 方法的參數是自定義的配置類，在使用的時候配置參數，在 apply 方法中直接獲取使用。命名需要以 RoutePredicateFactory 結尾，比如 CheckAuthRoutePredicateFactory，那么在使用的時候 CheckAuth 就是這個路由斷言工廠的名稱。

 

CheckAuthRoutePredicateFactory

/**
 *  自定義路由斷言工廠
 */
@Component
public class CheckAuthRoutePredicateFactory extends AbstractRoutePredicateFactory<CheckAuthRoutePredicateFactory.Config> {

    public CheckAuthRoutePredicateFactory() {
        super(Config.class);
        System.out.println("Loaded RoutePredicateFactory [CheckAuth]");
    }

    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("name");
    }

    /**
     * 自定義斷言規則
     * @param config
     * @return
     */
    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        System.out.println("Name===>:" + config.getName());
        return exchange -> {
            if (config.getName().equals("qt")) {
                return true;
            }
            return false;
        };
    }

    //配置一個內部類
    public static class Config {

        private String name;

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

        public String getName() {
            return name;
        }
    }
}

application.yml中添加路由配置

spring:
  cloud:
    # gateway 配置
    gateway:
      # 路由規則
      routes:
        - id: order_route # 路由的唯一標識，路由到order
          uri: lb://service-openfeign  # 調用接口的服務名，需要轉發的地址  lb：使用nacos本地的負載均衡策略
          # 斷言規則 用於路由規則的匹配
          predicates:
            - Path=/service-order/**
            - CheckAuth=qt
          # 過濾器
          filters:
            - StripPrefix=1 #轉發之前去掉第一層路由

5、過濾器

　　 Spring Cloud Gateway除了具備請求路由功能之外，也支持對請求的過濾。通過Zuul網關類似，也是通過過濾器的形式來實現的。
（1） 過濾器的生命周期
　　Spring Cloud Gateway 的 Filter 的生命周期不像 Zuul 的那么豐富，它只有兩個：“pre” 和 “post”。
PRE ： 這種過濾器在請求被路由之前調用。我們可利用這種過濾器實現身份驗證、在集群中選擇請求的微服務、記錄調試信息等。
POST ：這種過濾器在路由到微服務以后執行。這種過濾器可用來為響應添加標准的 HTTP Header、收集統計信息和指標、將響應從微服務發送給客戶端等。

 （ 2） 過濾器類型
Spring Cloud Gateway 的 Filter 從作用范圍可分為兩種GatewayFilter 與 GlobalFilter。
GatewayFilter （局部過濾器）：應用到單個路由或者一個分組的路由上。
GlobalFilter （全局過濾器）：應用到所有的路由上。

 （3）局部過濾器
　　局部過濾器（GatewayFilter），是針對單個路由的過濾器。可以對訪問的URL過濾，進行切面處理。在Spring Cloud Gateway中通過GatewayFilter的形式內置了很多不同類型的局部過濾器。這里簡單將Spring Cloud Gateway內置的所有過濾器工廠整理成了一張表格，雖然不是很詳細，但能作為速覽使用。如下：

 

 　　每個過濾器工廠都對應一個實現類，並且這些類的名稱必須以 GatewayFilterFactory 結尾，這是Spring Cloud Gateway的一個約定，例如 AddRequestHeader 對應的實現類為AddRequestHeaderGatewayFilterFactory 。對於這些過濾器的使用方式可以參考官方文檔。

（4）全局過濾器

　　全局過濾器（GlobalFilter）作用於所有路由，Spring Cloud Gateway 定義了Global Filter接口，用戶可以自定義實現自己的Global Filter。通過全局過濾器可以實現對權限的統一校驗，安全性驗證等功能，並且全局過濾器也是程序員使用比較多的過濾器。
　　Spring Cloud Gateway內部也是通過一系列的內置全局過濾器對整個路由轉發進行處理如下：

 下面的我們自定義一個GlobalFilter，去校驗所有請求的請求參數中是否包含“token”，如何不包含請求參數“token”則不轉發路由，否則執行正常的邏輯。

/**
 * 自定義一個全局過濾器
 *      實現 globalfilter , ordered接口
 */
@Component
public class LoginFilter implements GlobalFilter,Ordered {

    /**
     * 執行過濾器中的業務邏輯
     *     對請求參數中的access-token進行判斷
     *      如果存在此參數:代表已經認證成功
     *      如果不存在此參數 : 認證失敗.
     *  ServerWebExchange : 相當於請求和響應的上下文(zuul中的RequestContext)
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("執行了自定義的全局過濾器");
        //1.獲取請求參數access-token
        String token = exchange.getRequest().getQueryParams().getFirst("access-token");
        //2.判斷是否存在
        if(token == null) {
            //3.如果不存在 : 認證失敗
            System.out.println("沒有登錄");
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            return exchange.getResponse().setComplete(); //請求結束
        }
        //4.如果存在,繼續執行
        return chain.filter(exchange); //繼續向下執行
    }

    /**
     * 指定過濾器的執行順序 , 返回值越小,執行優先級越高
     */
    @Override
    public int getOrder() {
        return 0;
    }
}

參考鏈接：https://www.cnblogs.com/dalianpai/p/12288884.html

6、跨域處理

　　gateway配置跨域處理有兩種方法，配置文件application.yml和配置類進行配置。

（1）application.yml

spring:
  cloud:
    gateway:
      globalcors:
        # 全局允許跨域訪問
        cors-configurations:
          '[/**]':
            allow-credentials: true
            allowed-origins: "*"
            allowed-headers: "*"
            allowed-methods:
              - OPTIONS
              - GET
              - POST
              - PUT
              - DELETE

（2）配置類配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.reactive.CorsWebFilter;
import org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource;
import org.springframework.web.util.pattern.PathPatternParser;

@Configuration
public class CorsConfig {

    @Bean
    public CorsWebFilter corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser());
        source.registerCorsConfiguration("/**", buildConfig());
        return new CorsWebFilter(source);
    }

    private CorsConfiguration buildConfig() {
        CorsConfiguration corsConfiguration = new CorsConfiguration();
        //在生產環境上最好指定域名，以免產生跨域安全問題
        corsConfiguration.addAllowedOrigin("*");
        corsConfiguration.addAllowedHeader("*");
        corsConfiguration.addAllowedMethod("*");
        return corsConfiguration;
    }
}

7、整合sentinel流控降級