Nepxion Discovery Gray是Nepxion Discovery的极简示例,有助于使用者快速入门。它基于Spring Cloud Greenwich版本而制作(使用者可自行改成Finchley版和Edgware版),主要功能包括:
网关灰度路由。采用配置中心配置路由规则映射在网关过滤器中植入Header信息而实现,主要包括版本路由和区域路由两种。
服务灰度权重。采用配置中心配置权重规则映射在全链路而实现,主要包括版本权重和区域区域两种。
自定义网关和服务的路由策略。采用简单编程方式,根据业务参数绑定路由策略。
代码地址:
https://github.com/Nepxion/DiscoveryGray
Nacos 是新一代集服务注册发现中心和配置中心为一体的中间件。它是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施,支持几乎所有主流类型的“服务”的发现、配置和管理,更敏捷和容易地构建、交付和管理微服务平台。
本文示例以 Nacos 为服务注册中心和配置中心,通过 Gateway 和 Zuul 调用两个版本或者区域的服务,模拟网关灰度路由和服务灰度权重的功能。
如果使用者需要更强大的功能,请参考:
https://github.com/Nepxion/Discovery
环境搭建和运行
1、下载代码并导入 IDE
2、启动 Nacos 服务器
从以下地址获取nacos-server-x.x.x.zip,并解压:
https://github.com/alibaba/nacos/releases
运行bin目录下的startup命令行。
3、启动四个实例服务和两个网关服务,如下:
类名
微服务
服务端口
版本
区域
DiscoveryGrayServiceA1.java
A1
3001
1.0
dev
DiscoveryGrayServiceA2.java
A2
3002
1.1
qa
DiscoveryGrayServiceB1.java
B1
4001
1.0
dev
DiscoveryGrayServiceB2.java
B2
4002
1.1
qa
DiscoveryGrayGateway.java
Gateway
5001
1.0
无
DiscoveryGrayZuul.java
Zuul
5002
1.0
无
验证无灰度发布和路由的调用
在浏览器中执行http://localhost:5001/discovery-gray-service-a/invoke/gateway。测试没有灰度配置的情况下,通过Spring Cloud Gateway网关的调用结果。该结果显示,在反复执行下,所有服务都会被调用到,如下:
gateway -> discovery-gray-service-a[192.168.0.107:3001][V1.0][Region=dev]
-> discovery-gray-service-b[192.168.0.107:4001][V1.0][Region=qa]
在浏览器中执行http://localhost:5002/discovery-gray-service-a/invoke/zuul。测试没有灰度路由的情况下,通过Zuul网关的调用结果。该结果显示,在反复执行下,所有服务都会被调用到,如下:
zuul -> discovery-gray-service-a[192.168.0.107:3001][V1.0][Region=dev]
-> discovery-gray-service-b[192.168.0.107:4001][V1.0][Region=qa]
网关灰度路由策略
配置网关灰度路由规则
在Nacos配置中心,增加网关灰度路由规则
增加Zuul的基于区域路由的灰度规则,Group为discovery-gray-group,Data Id为discovery-gray-zuul,规则内容如下,实现从Zuul发起的调用都走区域为dev的服务:
dev每个服务调用的区域都可以自行指定,见下面第二条。当所有服务都选同一区域的时候,可以简化成下面第一条
dev
{“discovery-gray-service-a”:“dev”, “discovery-gray-service-b”:“dev”}
增加Spring Cloud Gateway的基于版本路由的灰度规则,Group为discovery-gray-group,Data Id为discovery-gray-gateway,规则内容如下,实现从Spring Cloud Gateway发起的调用都走版本为1.0的服务:
1.0每个服务调用的版本都可以自行指定,见下面第二条。当所有服务都选同一版本的时候,可以简化成下面第一条:
1.0
{“discovery-gray-service-a”:“1.0”, “discovery-gray-service-b”:“1.0”}
验证网关灰度路由调用
重复“验证无灰度发布和路由的调用”步骤,结果显示,在反复执行下,只会调用到符合网关灰度路由规则的服务,请仔细观察。
其他网关灰度路由策略
除了上面通过配置中心发布灰度规则外,还有如下三种方式:
通过前端传入灰度路由规则
通过前端(Postman)方式传入灰度路由规则,来代替配置中心方式。注意:当配置中心和界面都配置后,以界面传入优先
区域规则,Header格式如下任选一个:
n-d-region=dev
n-d-region={“discovery-gray-service-a”:“dev”, “discovery-gray-service-b”:“dev”}
版本规则,Header格式如下任选一个:
n-d-version=1.0
n-d-version={“discovery-gray-service-a”:“1.0”, “discovery-gray-service-b”:“1.0”}
通过自定义网关Filter设置灰度路由规则
继承覆盖GatewayStrategyRouteFilter和ZuulStrategyRouteFilter,并覆盖掉如下方法:
protected String getRouteVersion();
protected String getRouteRegion();
protected String getRouteAddress();
通过跟业务参数绑定自定义路由规则
根据业务参数绑定路由。下面代码既适用于Zuul和Spring Cloud Gateway网关,也适用于Service微服务:
// 实现了组合策略,版本路由策略+区域路由策略+IP和端口路由策略+自定义策略
public class DiscoveryGrayEnabledStrategy extends AbstractDiscoveryEnabledStrategy {
private static final Logger LOG = LoggerFactory.getLogger(DiscoveryGrayEnabledStrategy.class);
@Override
public boolean apply(Server server) {
// 对Rest调用传来的Header参数(例如:mobile)做策略
String mobile = strategyContextHolder.getHeader("mobile");
String serviceId = pluginAdapter.getServerServiceId(server);
String version = pluginAdapter.getServerMetadata(server).get(DiscoveryConstant.VERSION);
LOG.info("负载均衡用户定制触发:mobile={}, serviceId={}, version={}", mobile, serviceId, version);
if (StringUtils.isNotEmpty(mobile)) {
// 手机号以移动138开头,路由到1.0版本的服务上
if (mobile.startsWith("138") && StringUtils.equals(version, "1.0")) {
return true;
// 手机号以联通133开头,路由到2.0版本的服务上
} else if (mobile.startsWith("133") && StringUtils.equals(version, "1.1")) {
return true;
} else {
// 其它情况,直接拒绝请求
return false;
}
}
return true;
}
}
服务灰度权重策略
配置服务灰度权重规则
在Nacos配置中心,增加服务灰度权重规则。
注意:网关灰度路由和服务灰度权重功能会叠加,为了不影响演示效果,请先清除网关灰度路由的规则(在Nacos上删除对应的两条配置即可)。
增加区域权重的灰度规则,Group为discovery-gray-group,Data Id为discovery-gray-group(全局发布,两者都是组名),规则内容如下,实现区域为dev的服务提供90%的流量,区域为qa的服务提供10%的流量:
增加服务权重的灰度规则,Group为discovery-gray-group,Data Id为discovery-gray-group(全局发布,两者都是组名),规则内容如下,实现a服务1.0版本提供90%的流量,1.1版本提供10%的流量;b服务1.0版本提供20%的流量,1.1版本提供80%的流量:
验证服务灰度权重调用
重复“验证无灰度发布和路由的调用”步骤,结果显示,在反复执行下,只会调用到符合服务灰度权重的服务,请仔细观察被随机权重调用到的概率。