Spring Cloud Gateway 擴展支持多版本控制及灰度發佈

時間 2021-03-04

標籤 nginx web spring 編程 app ide 微服務 lua spa debug 欄目 Spring 简体版

原文原文鏈接

灰度發佈

什麼是灰度發佈，概念請參考,咱們來簡單的經過下圖來看下，通俗的講：爲了保證服務升級過程的平滑過渡提升客戶體驗，會一部分用戶一部分用戶遞進更新，這樣生產中會同時出現多個版本的客戶端，爲了保證多個版本客戶端的可用須要對應的多個版本的服務端版本。灰度發佈就是經過必定策略保證多個版本客戶端、服務端間可以正確對應。
nginx

所謂灰度發佈，即某個服務存在多個實例時，而且實例版本間的版本並不一致，經過web

實現方案

nginx + lua (openresty)

Netflix Zuul

只須要自定義ribbon 的斷言便可，核心是經過TTL 獲取上下請求header中的版本號spring

@Slf4j編程
public class MetadataCanaryRuleHandler extends ZoneAvoidanceRule {app
@Overrideide
public AbstractServerPredicate getPredicate() {微服務
return new AbstractServerPredicate() {lua
@Overridespa
public boolean apply(PredicateKey predicateKey) {debug
String targetVersion = RibbonVersionHolder.getContext();
RibbonVersionHolder.clearContext();
if (StrUtil.isBlank(targetVersion)) {
log.debug("客戶端未配置目標版本直接路由");
return true;
}
DiscoveryEnabledServer server = (DiscoveryEnabledServer) predicateKey.getServer();
final Map<String, String> metadata = server.getInstanceInfo().getMetadata();
if (StrUtil.isBlank(metadata.get(SecurityConstants.VERSION))) {
log.debug("當前微服務{} 未配置版本直接路由");
return true;
}
if (metadata.get(SecurityConstants.VERSION).equals(targetVersion)) {
return true;
} else {
log.debug("當前微服務{} 版本爲{}，目標版本{} 匹配失敗", server.getInstanceInfo().getAppName()
, metadata.get(SecurityConstants.VERSION), targetVersion);
return false;
}
}
};
}
}

維護請求中的版本號

public class RibbonVersionHolder {
private static final ThreadLocal<String> context = new TransmittableThreadLocal<>();
public static String getContext() {
return context.get();
}
public static void setContext(String value) {
context.set(value);
}
public static void clearContext() {
context.remove();
}
}

Spring Cloud Gateway 中實現

第一反應，參考zuul 的實現，自定義斷言，而後從上下中獲取版本信息便可。但因爲 spring cloud gateway 是基於webflux 的反應式編程，因此傳統的TTL或者 RequestContextHolder 都不能正確的維護上下文請求。

先來看 spring clou的 gateway 默認的lb 策略實現 LoadBalancerClientFilter

public class LoadBalancerClientFilter implements GlobalFilter, Ordered {
@Override
public int getOrder() {
return LOAD_BALANCER_CLIENT_FILTER_ORDER;
}
@Override
@SuppressWarnings("Duplicates")
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
return chain.filter(exchange);
}
protected ServiceInstance choose(ServerWebExchange exchange) {
return loadBalancer.choose(
((URI) exchange.getAttribute(GATEWAY_REQUEST_URL_ATTR)).getHost());
}
}

咱們只須要重寫 choose 方法，把上下文請求傳遞到路由斷言中便可，以下

@Overrideprotected ServiceInstance choose(ServerWebExchange exchange) {    HttpHeaders headers = exchange.getRequest().getHeaders();    return loadBalancer.choose(((URI) exchange.getAttribute(GATEWAY_REQUEST_URL_ATTR)).getHost(), headers);}

而後在路由斷言中經過 PredicateKey獲取到便可

public abstract class AbstractDiscoveryEnabledPredicate extends AbstractServerPredicate {
/**
* {@inheritDoc}
*/
@Override
public boolean apply(@Nullable PredicateKey input) {
return input != null
&& input.getServer() instanceof NacosServer
&& apply((NacosServer) input.getServer(), (HttpHeaders) input.getLoadBalancerKey());
}
}

最後根據版原本計算

public class GrayMetadataAwarePredicate extends AbstractDiscoveryEnabledPredicate {
@Override
protected boolean apply(NacosServer server, HttpHeaders headers) {
PigxRibbonRuleProperties ribbonProperties = SpringContextHolder.getBean(PigxRibbonRuleProperties.class);
if (!ribbonProperties.isGrayEnabled()) {
log.debug("gray closed,GrayMetadataAwarePredicate return true");
return true;
}
final Map<String, String> metadata = server.getMetadata();
String version = metadata.get(CommonConstants.VERSION);
// 判斷Nacos服務是否有版本標籤
if (StrUtil.isBlank(version)) {
log.debug("nacos server tag is blank ,GrayMetadataAwarePredicate return true");
return true;
}
// 判斷請求中是否有版本
String target = headers.getFirst(CommonConstants.VERSION);
if (StrUtil.isBlank(target)) {
log.debug("request headers version is blank,GrayMetadataAwarePredicate return true");
return true;
}
log.debug("請求版本:{} ,當前服務版本:{}", target, version);
return target.equals(version);
}
}