Gateway服務閘道器 (入門到使用)

Gateway服務閘道器

Gateway也要作為微服務註冊到nacos中

Zuul也是閘道器但比較老是一種阻塞式程式設計；Spring Cloud Gateway 是 Spring Cloud 的一個全新專案，該專案是基於 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等響應式程式設計和事件流技術開發的閘道器，它旨在為微服務架構提供一種簡單有效的統一的 API 路由管理方式。

在SpringCloud中閘道器的實現包括兩種：

• gateway
• zuul

Zuul是基於Servlet的實現，屬於阻塞式程式設計。而SpringCloudGateway則是基於Spring5中提供的WebFlux，屬於響應式程式設計的實現，具備更好的效能。

閘道器介紹

Gateway閘道器是我們服務的守門神，所有微服務的統一入口。

閘道器的核心功能特性：

• 請求路由 ：就是傳送請求到相應的微服務
• 許可權控制
• 限流

架構圖：

許可權控制：閘道器作為微服務入口，需要校驗使用者是是否有請求資格，如果沒有則進行攔截。

路由和負載均衡：一切請求都必須先經過gateway，但閘道器不處理業務，而是根據某種規則，把請求轉發到某個微服務，這個過程叫做路由。當然路由的目標服務有多個時，還需要做負載均衡。

限流：當請求流量過高時，在閘道器中按照下流的微服務能夠接受的速度來放行請求，避免服務壓力過大。

閘道器路由流程圖：

使用閘道器步驟

1） 建立gateway微服務，匯入依賴

<!--閘道器-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服務發現依賴 自己也要註冊到nacos-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

2） 編寫啟動類

@SpringBootApplication
public class GatewayApplication {

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

3）編寫基礎配置和路由規則

路由配置包括：

1. 路由id：路由的唯一標示

2. 路由目標（uri）：路由的目標地址，http代表固定地址，lb代表根據服務名負載均衡

3. 路由斷言（predicates）：判斷路由的規則，

4. 路由過濾器（filters）：對請求或響應做處理

建立application.yml檔案，內容如下：

server:
  port: 10010 # 閘道器埠
spring:
  application:
    name: gateway # 服務名稱
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 閘道器路由配置
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/user/**
            - After=2021-01-20T17:42:47.789-07:00[America/Denver] #斷言：只有在這個事件後傳送的請求才可以
        - id: user-service # 路由id，自定義，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目標地址 http就是固定地址
          uri: lb://userservice # 路由的目標地址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/user/** # 這個是按照路徑匹配，只要以/user/開頭就符合要求
          filters: # 過濾器（當前過濾器寫在userservice路由下，因此僅僅對訪問userservice的請求有效）
            - AddRequestHeader=Conan, isMe! # 新增請求頭
      default-filters: # 預設過濾項（對所有路由都有效）
        - AddRequestHeader=Truth, Itcast is freaking awesome!

我們將符合Path 規則的一切請求，都代理到 uri引數指定的地址。

本例中，我們將 /user/**開頭的請求，代理到lb://userservice，lb是負載均衡，根據服務名拉取服務列表，實現負載均衡。

重啟閘道器，訪問http://localhost:10010/user/1時，符合/user/**規則，請求轉發到uri：http://userservice/user/1，得到了結果：

4） 自定義全域性過濾器

可有可無，在需要做一些複雜的過濾情況時使用，如：只允許authorization=admin的使用者傳送請求

在gateway中定義一個全域性過濾器：

package cn.itcast.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
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;

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.獲取請求引數
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.獲取authorization引數
        String auth = params.getFirst("authorization");
        // 3.校驗
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.攔截
        // 4.1.禁止訪問，設定狀態碼
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.結束處理
        return exchange.getResponse().setComplete();
    }
}

5） 解決跨域問題

spring:
  cloud:
    gateway:
      #解決跨域問題
      globalcors: # 全域性的跨域處理
        add-to-simple-url-handler-mapping: true # 解決options請求被攔截問題
        corsConfigurations:
          '[/**]': # /**是說攔截所有請求
            allowedOrigins: # 允許哪些網站的跨域請求 
              - "http://localhost:8090"
            allowedMethods: # 允許的跨域ajax的請求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允許在請求中攜帶的頭資訊
            allowCredentials: true # 是否允許攜帶cookie
            maxAge: 360000 # 這次跨域檢測的有效期

斷言工廠

斷言更像是一種對請求做限制條件，只有符合的請求才能成功訪問請求

我們在配置檔案中寫的斷言規則只是字串，這些字串會被Predicate Factory讀取並處理，轉變為路由判斷的條件

例如Path=/user/**是按照路徑匹配，這個規則是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory類來

處理的，像這樣的斷言工廠在SpringCloudGateway還有十幾個: 【需要時要哪個再學著用哪個】

名稱	說明	示例
After	是某個時間點後的請求	- After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before	是某個時間點之前的請求	- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between	是某兩個時間點之前的請求	- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie	請求必須包含某些cookie	- Cookie=chocolate, ch.p
Header	請求必須包含某些header	- Header=X-Request-Id, \d+
Host	請求必須是訪問某個host（域名）	- Host=.somehost.org,.anotherhost.org
Method	請求方式必須是指定方式	- Method=GET,POST
Path	請求路徑必須符合指定規則	- Path=/red/{segment},/blue/**
Query	請求引數必須包含指定引數	- Query=name, Jack或者- Query=name
RemoteAddr	請求者的ip必須是指定範圍	- RemoteAddr=192.168.1.1/24
Weight	權重處理

過濾器工廠

這裡的過濾器不是springMVC的過濾器，而是對進來的請求進行加工處理。

過濾器作用：

① 對路由的請求或響應做加工處理，比如新增請求頭

② 配置在路由下的過濾器只對當前路由的請求生效

GatewayFilter是閘道器中提供的一種過濾器，可以對進入閘道器的請求和微服務返回的響應做處理：

路由過濾器的種類

Spring提供了31種不同的路由過濾器工廠。例如：如下舉例五種

名稱	說明
AddRequestHeader	給當前請求新增一個請求頭
RemoveRequestHeader	移除請求中的一個請求頭
AddResponseHeader	給響應結果中新增一個響應頭
RemoveResponseHeader	從響應結果中移除有一個響應頭
RequestRateLimiter	限制請求的流量

請求頭過濾器

下面我們以AddRequestHeader 為例來講解。

需求：給所有進入userservice的請求新增一個請求頭：Truth=itcast is freaking awesome!

AddRequestHeader= Truth, Itcast is freaking awesome! 逗號前面是key，後面是value

只需要修改gateway服務的application.yml檔案，新增路由過濾即可：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 過濾器
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 新增請求頭

當前過濾器寫在userservice路由下，因此僅僅對訪問userservice的請求有效。

預設過濾器

如果要對所有的路由都生效，則可以將過濾器工廠寫到default下。格式如下：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 預設過濾項
      - AddRequestHeader=Truth, Itcast is freaking awesome! 

全域性過濾器

閘道器提供了31種，但每一種過濾器的作用都是固定的。如果我們希望攔截請求，做自己的業務邏輯則沒辦法實現。

全域性過濾器作用

全域性過濾器的作用也是處理一切進入閘道器的請求和微服務響應，與GatewayFilter的作用一樣。區別在於GatewayFilter透過配置定義，處理邏輯是固定的；而GlobalFilter的邏輯需要自己寫程式碼實現。

定義方式是實現GlobalFilter介面。

public interface GlobalFilter {
    /**
     *  處理當前請求，有必要的話透過{@link GatewayFilterChain}將請求交給下一個過濾器處理
     *
     * @param exchange 請求上下文，裡面可以獲取Request、Response等資訊
     * @param chain 用來把請求委託給下一個過濾器 
     * @return {@code Mono<Void>} 返回標示當前過濾器業務結束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

在filter中編寫自定義邏輯，可以實現下列功能：

• 登入狀態判斷
• 許可權校驗
• 請求限流等

自定義全域性過濾器

需求：定義全域性過濾器，攔截請求，判斷請求的引數是否滿足下麵條件：

• 引數中是否有authorization，

• authorization引數值是否為admin

如果同時滿足則放行，否則攔截

實現：

在gateway中定義一個過濾器：

package cn.itcast.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
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;

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.獲取請求引數
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.獲取authorization引數
        String auth = params.getFirst("authorization");
        // 3.校驗
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.攔截
        // 4.1.禁止訪問，設定狀態碼
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.結束處理
        return exchange.getResponse().setComplete();
    }
}

過濾器執行順序【重要】

請求進入閘道器會碰到三類過濾器：當前路由的過濾器、DefaultFilter、GlobalFilter

請求路由後，會將當前路由過濾器和DefaultFilter、GlobalFilter，合併到一個過濾器鏈（集合）中，排序後依次執行每個過濾器：

排序的規則是什麼呢？

• 每一個過濾器都必須指定一個int型別的order值，order值越小，優先順序越高，執行順序越靠前。
• GlobalFilter透過實現Ordered介面，或者新增@Order(1) 註解來指定order值，由我們自己指定
• 路由過濾器和defaultFilter的order由Spring指定，預設是按照宣告順序從1遞增。
• 當過濾器的order值一樣時，會按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執行。

詳細內容，可以檢視原始碼：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先載入defaultFilters，然後再載入某個route的filters，然後合併。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法會載入全域性過濾器，與前面的過濾器合併後根據order排序，組織過濾器鏈

跨域問題

什麼是跨域問題

跨域：域名不一致就是跨域，主要包括：

• 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

• 域名相同，埠不同：localhost:8080和localhost8081

跨域問題：瀏覽器禁止請求的發起者與服務端發生跨域ajax請求，請求被瀏覽器攔截的問題

所以只是單純的服務之間的請求是沒有ajax請求所以不會出現跨域問題，但前端傳送請求就有ajax，此時需要考慮跨域問題。

解決方案：CORS，這個以前應該學習過，這裡不再贅述了。不知道的小夥伴可以檢視https://www.ruanyifeng.com/blog/2016/04/cors.html

模擬跨域問題

找到課前資料的頁面檔案：

放入tomcat或者nginx這樣的web伺服器中，啟動並訪問。

可以在瀏覽器控制檯看到下面的錯誤：

從localhost:8090訪問localhost:10010，埠不同，顯然是跨域的請求。

解決跨域問題

在gateway服務的application.yml檔案中，新增下面的配置：

spring:
  cloud:
    gateway:
      #解決跨域問題
      globalcors: # 全域性的跨域處理
        add-to-simple-url-handler-mapping: true # 解決options請求被攔截問題
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允許哪些網站的跨域請求 
              - "http://localhost:8090"
            allowedMethods: # 允許的跨域ajax的請求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允許在請求中攜帶的頭資訊
            allowCredentials: true # 是否允許攜帶cookie
            maxAge: 360000 # 這次跨域檢測的有效期