Gateway 服務閘道器

📢 本文由 gemini-2.5-flash 翻譯

Gateway 是所有微服務的統一入口點，具有以下功能：

身份驗證與權限檢查：閘道器作為微服務入口點，需要驗證使用者是否有請求資格，如果沒有則進行攔截。
請求路由、負載平衡：所有請求都必須先經過Gateway，但閘道器不處理商業邏輯，而是根據某種規則，將請求轉發到某個微服務，這個過程稱為路由。當然，當路由的目標服務有多個時，還需要進行負載平衡。
流量限制：當請求流量過高時，在閘道器中依照下游微服務能夠接受的速度來放行請求，避免服務壓力過大。

SpringCloud 的閘道器實作有兩種：

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

簡單入門

建立專案，引入依賴：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<!--閘道器-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服務發現依賴-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

編寫基本設定和路由規則：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
server:
  port: 10010 # 閘道器埠號
spring:
  application:
    name: gateway # 服務名稱
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos位址
    gateway:
      routes: # 閘道器路由設定
        - id: user-service # 路由ID，自訂，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目標位址 http就是固定位址
          uri: lb://userService # 路由的目標位址 lb就是負載平衡，後面接服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/user/** # 這個是依照路徑匹配，只要以/user/開頭就符合要求

然後存取 <localhost:10010/user/1> 進行測試。

路由設定包含：

路由ID：路由的唯一識別。
路由目標 (uri)：路由的目標位址，http 代表固定位址，lb 代表根據服務名稱負載平衡。
路由斷言 (predicates)：判斷路由的規則，符合則轉發到路由目的地。
路由過濾器 (filters)：對請求或回應進行處理。

斷言工廠

在設定檔中編寫的斷言規則僅是字串，這些字串會被 Predicate Factory 讀取並處理，轉換為路由判斷的條件。

例如上述範例 Path=/user/** 是依照路徑匹配，這個規則是由 org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory 類別來處理的，類似的斷言工廠有：

名稱	說明	範例
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=X-Request-Id, \d+
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	權重處理

過濾器工廠

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

Spring 提供了 31 種不同的路由過濾器工廠，例如：

名稱	說明
AddRequestHeader	給當前請求添加一個請求標頭
RemoveRequestHeader	移除請求中的一個請求標頭
AddResponseHeader	給回應結果中添加一個回應標頭
RemoveResponseHeader	從回應結果中移除一個回應標頭
RequestRateLimiter	限制請求的流量

更多參考： https://docs.spring.io/spring-cloud-gateway/reference/spring-cloud-gateway/gatewayfilter-factories.html

請求標頭過濾器

以請求標頭過濾器為例，給所有進入 userService 的請求添加一個請求標頭：Hello=World。

在 gateway 中修改 application.yml，添加路由過濾：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 過濾器
        - AddRequestHeader=Hello, World # 添加請求標頭

然後可以修改 Controller 進行測試：

1
2
3
4
5
@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id, @RequestHeader("Hello") String hello) {
    System.out.println(hello);
    return userService.queryById(id);
}

預設過濾器

如果想對所有的路由都生效，則可以將過濾器工廠寫在 default 下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 預設過濾項
      - AddRequestHeader=Hello, World

全域過濾器

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

而全域過濾器的作用也是處理所有進入閘道器的請求和微服務回應，與 GatewayFilter 的作用一樣。區別在於 GatewayFilter 透過設定定義，處理邏輯是固定的；而 GlobalFilter 的邏輯需要自己編寫程式碼實作，定義方式是實作 GlobalFilter 介面：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 中定義一個過濾器：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
@Order(-1) // 優先處理
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 取得請求參數
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 取得AuthorizeFilter參數，此處約定第一個為認證參數
        String authorize = params.getFirst("AuthorizeFilter");
        // 檢查
        if("admin".equals(authorize)){
            // 放行
            return chain.filter(exchange);
        }
        // 攔截，禁止存取
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 結束處理
        return exchange.getResponse().setComplete();
    }
}

過濾器執行順序

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

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

每個過濾器都有 int 類型的 order 值，order 值越小，優先序越高，執行順序越靠前。

路由過濾器和 defaultFilter 的 order 值由 Spring 指定，預設從 1 開始遞增。

GlobalFilter 透過實作 Ordered 介面，或是添加 @Order 註解來指定 order 值，由我們自己指定。

當過濾器的 order 值相同時，會依照 defaultFilter > 路由過濾器 > GlobalFilter 的順序執行。

其中透過實作介面指定 order 值：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
//@Order(-1) // 優先處理
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 取得請求參數
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 取得AuthorizeFilter參數，此處約定第一個為認證參數
        String authorize = params.getFirst("AuthorizeFilter");
        // 檢查
        if("admin".equals(authorize)){
            // 放行
            return chain.filter(exchange);
        }
        // 攔截，禁止存取
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 結束處理
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

跨網域問題

同網域表示協定相同、IP 或網域名稱相同、埠號相同。

跨網域問題：瀏覽器禁止請求發起者與伺服端發生跨網域 AJAX 請求，請求被瀏覽器攔截的問題，解決方案便是 CORS。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
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 # 這次跨網域偵測的有效期限