基于 Spring Cloud Gateway 实现灰度发布,核心思路是通过定义路由规则,将特定流量导向新版本服务。下面我用一个表格汇总主要策略,然后提供具体配置示例和关键说明。
🎯 灰度发布策略概览
策略类型 | 核心机制 | 适用场景 |
---|---|---|
基于请求头 (Header) | 检查请求头中的特定标识(如 X-Gray-Release: true ) |
内部测试、指定体验用户 |
基于权重 (Weight) | 按配置的百分比随机分配流量到不同版本 | A/B测试、逐步放量 |
基于用户标识/IP | 根据用户ID、Cookie或IP地址等条件进行匹配 | 定向灰度(如特定员工、地区用户) |
⚙️ 具体配置示例
1. 基于请求头的灰度路由
此方式常用于内部测试人员或通过特定标识触发灰度环境。
yaml
spring:
cloud:
gateway:
routes:
# 灰度路由(高优先级)
- 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 # 优先级高于默认路由
# 默认路由(兜底)
- id: user-service-default
uri: lb://user-service
predicates:
- Path=/api/user/**
order: 1
说明 :请求时携带 Header X-Gray-Release: true
的请求会被路由到灰度服务实例。
2. 基于权重的灰度路由
适用于随机分配一定比例的流量到新版本,实现金丝雀发布。
yaml
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 会根据权重随机转发请求。
3. 基于用户ID或IP的灰度路由
可以实现更精细的流量控制,例如让用户ID尾号为0的用户访问新版本。
a) 通过自定义全局过滤器实现
typescript
@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)) {
// 将用户标记为灰度用户,后续可通过自定义断言路由
exchange.getAttributes().put("GRAY_TAG", true);
}
return chain.filter(exchange);
}
}
说明 :此过滤器检查请求头中的 X-User-ID
,若ID在灰度名单内,则为其打上标签。
b) 配置路由规则使用该标签
可结合自定义的 RoutePredicateFactory
来路由标记了 GRAY_TAG
的请求到新版本服务。
🔧 关键实现要点
- 服务实例标识 :确保新版本服务在注册到Nacos或Eureka时带有元数据(Metadata)标识,如
version: v2
。 - 全链路标签透传:为了让灰度标识在后续微服务调用链中持续生效,需要在Gateway的过滤器中将其添加到请求头,并配置OpenFeign拦截器继续传递该头信息。
- 动态配置更新:结合Spring Cloud Config或Nacos等配置中心,可以动态调整灰度规则(如权重值、灰度用户列表),无需重启网关即可生效。
💡 最佳实践建议
- 从小范围开始:初期选择内部用户或极小流量比例(如1%-5%)进行灰度验证。
- 密切监控:密切关注新版本服务的各项指标,如QPS、响应时间、错误率等,确保稳定性。
- 制定回滚方案:事先规划好一旦发现问题如何快速撤回流量的方案,例如在配置中心迅速修改权重或关闭灰度路由。