基于Spring Cloud Gateway實現(xiàn)灰度發(fā)布的具體配置示例

更新時間：2025年10月12日 10:02:13 作者：IT橘子皮

這篇文章主要介紹了如何基于 Spring Cloud Gateway 實現(xiàn)灰度發(fā)布,核心思路是通過定義路由規(guī)則,將特定流量導向新版本服務,下面我用一個表格匯總主要策略,然后提供具體配置示例和關鍵說明,需要的朋友可以參考下

灰度發(fā)布策略概覽

策略類型	核心機制	適用場景
?基于請求頭 (Header)??	檢查請求頭中的特定標識（如 X-Gray-Release: true）	內(nèi)部測試、指定體驗用戶
?基于權重 (Weight)??	按配置的百分比隨機分配流量到不同版本	A/B測試、逐步放量
?基于用戶標識/IP?	根據(jù)用戶ID、Cookie或IP地址等條件進行匹配	定向灰度（如特定員工、地區(qū)用戶）

具體配置示例

1. 基于請求頭的灰度路由

此方式常用于內(nèi)部測試人員或通過特定標識觸發(fā)灰度環(huán)境。

spring:
  cloud:
    gateway:
      routes:
        # 灰度路由（高優(yōu)先級）
        - id: user-service-gray
          uri: lb://user-service
          predicates:
            - Path=/api/user/**
            - Header=X-Gray-Release, true # 當請求頭包含 X-Gray-Release: true 時匹配
          filters:
            - AddRequestHeader=X-Request-Version, v2 # 可為下游服務添加標識
          order: 0 # 優(yōu)先級高于默認路由
        # 默認路由（兜底）
        - id: user-service-default
          uri: lb://user-service
          predicates:
            - Path=/api/user/**
          order: 1

?說明?：請求時攜帶 Header X-Gray-Release: true的請求會被路由到灰度服務實例。

2. 基于權重的灰度路由

適用于隨機分配一定比例的流量到新版本，實現(xiàn)金絲雀發(fā)布。

spring:
  cloud:
    gateway:
      routes:
        - id: weight_high
          uri: lb://user-service-v1
          predicates:
            - Path=/api/order/**
            - Weight=user-service-group, 80 # 80%流量到v1
        - id: weight_low
          uri: lb://user-service-v2
          predicates:
            - Path=/api/order/**
            - Weight=user-service-group, 20 # 20%流量到v2

?說明?：同一個組（user-service-group）的權重總和應為100。Gateway 會根據(jù)權重隨機轉(zhuǎn)發(fā)請求。

3. 基于用戶ID或IP的灰度路由

可以實現(xiàn)更精細的流量控制，例如讓用戶ID尾號為0的用戶訪問新版本。

?a) 通過自定義全局過濾器實現(xiàn)?

@Component
@Order(-1)
public class GrayUserFilter implements GlobalFilter {
    // 假設這是灰度用戶名單
    private final Set<String> grayUsers = Set.of("1001", "1002", "1005"); 
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String userId = exchange.getRequest().getHeaders().getFirst("X-User-ID");
        if (grayUsers.contains(userId)) {
            // 將用戶標記為灰度用戶，后續(xù)可通過自定義斷言路由
            exchange.getAttributes().put("GRAY_TAG", true);
        }
        return chain.filter(exchange);
    }
}

?說明?：此過濾器檢查請求頭中的 X-User-ID，若ID在灰度名單內(nèi)，則為其打上標簽。

?b) 配置路由規(guī)則使用該標簽?

可結合自定義的 RoutePredicateFactory來路由標記了 GRAY_TAG的請求到新版本服務。

關鍵實現(xiàn)要點

?服務實例標識?：確保新版本服務在注冊到Nacos或Eureka時帶有元數(shù)據(jù)（Metadata）標識，如 version: v2。
?全鏈路標簽透傳?：為了讓灰度標識在后續(xù)微服務調(diào)用鏈中持續(xù)生效，需要在Gateway的過濾器中將其添加到請求頭，并配置OpenFeign攔截器繼續(xù)傳遞該頭信息。
?動態(tài)配置更新?：結合Spring Cloud Config或Nacos等配置中心，可以動態(tài)調(diào)整灰度規(guī)則（如權重值、灰度用戶列表），無需重啟網(wǎng)關即可生效。