Spring Cloud Gateway 扩展支持多版本控制及灰度发布

灰度发布

什么是灰度发布，概念请参考,咱们来简单的经过下图来看下，通俗的讲：为了保证服务升级过程的平滑过渡提升客户体验，会一部分用户 一部分用户递进更新，这样生产中会同时出现多个版本的客户端，为了保证多个版本客户端的可用须要对应的多个版本的服务端版本。灰度发布就是经过必定策略保证 多个版本客户端、服务端间可以正确对应。

所谓灰度发布，即某个服务存在多个实例时，而且实例版本间的版本并不一致，经过

实现方案

nginx + lua (openresty)

Netflix Zuul

只须要自定义ribbon 的断言便可，核心是经过TTL 获取上下请求header中的版本号

1. @Slf4j

2. public class MetadataCanaryRuleHandler extends ZoneAvoidanceRule {

3. 
   

4.    @Override

5.    public AbstractServerPredicate getPredicate() {

6.        return new AbstractServerPredicate() {

7.            @Override

8.            public boolean apply(PredicateKey predicateKey) {

9.                String targetVersion = RibbonVersionHolder.getContext();

10.                RibbonVersionHolder.clearContext();

11.                if (StrUtil.isBlank(targetVersion)) {

12.                    log.debug("客户端未配置目标版本直接路由");

13.                    return true;

14.                }

15. 
    

16.                DiscoveryEnabledServer server = (DiscoveryEnabledServer) predicateKey.getServer();

17.                final Map<String, String> metadata = server.getInstanceInfo().getMetadata();

18.                if (StrUtil.isBlank(metadata.get(SecurityConstants.VERSION))) {

19.                    log.debug("当前微服务{} 未配置版本直接路由");

20.                    return true;

21.                }

22. 
    

23.                if (metadata.get(SecurityConstants.VERSION).equals(targetVersion)) {

24.                    return true;

25.                } else {

26.                    log.debug("当前微服务{} 版本为{}，目标版本{} 匹配失败", server.getInstanceInfo().getAppName()

27.                            , metadata.get(SecurityConstants.VERSION), targetVersion);

28.                    return false;

29.                }

30.            }

31.        };

32.    }

33. }

维护请求中的版本号

1. public class RibbonVersionHolder {

2.    private static final ThreadLocal<String> context = new TransmittableThreadLocal<>();

3. 
   

4.    public static String getContext() {

5.        return context.get();

6.    }

7. 
   

8.    public static void setContext(String value) {

9.        context.set(value);

10.    }

11. 
    

12.    public static void clearContext() {

13.        context.remove();

14.    }

15. }

Spring Cloud Gateway 中实现

第一反应，参考zuul 的实现，自定义断言，而后从上下中获取版本信息便可。但因为 spring cloud gateway 是基于webflux 的反应式编程，因此传统的TTL或者 RequestContextHolder 都不能正确的维护上下文请求。

先来看 spring clou的 gateway 默认的lb 策略实现 LoadBalancerClientFilter

1. public class LoadBalancerClientFilter implements GlobalFilter, Ordered {

2.    @Override

3.    public int getOrder() {

4.        return LOAD_BALANCER_CLIENT_FILTER_ORDER;

5.    }

6. 
   

7.    @Override

8.    @SuppressWarnings("Duplicates")

9.    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

10.        return chain.filter(exchange);

11.    }

12. 
    

13.    protected ServiceInstance choose(ServerWebExchange exchange) {

14.        return loadBalancer.choose(

15.                ((URI) exchange.getAttribute(GATEWAY_REQUEST_URL_ATTR)).getHost());

16.    }

17. }

咱们只须要重写 choose 方法，把上下文请求传递到路由断言中便可，以下

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

而后在路由断言中经过 PredicateKey获取到便可

1. public abstract class AbstractDiscoveryEnabledPredicate extends AbstractServerPredicate {

2. 
   

3.    /**

4.     * {@inheritDoc}

5.     */

6.    @Override

7.    public boolean apply(@Nullable PredicateKey input) {

8.        return input != null

9.                && input.getServer() instanceof NacosServer

10.                && apply((NacosServer) input.getServer(), (HttpHeaders) input.getLoadBalancerKey());

11.    }

12. }

最后根据版原本计算

1.    public class GrayMetadataAwarePredicate extends AbstractDiscoveryEnabledPredicate {

2. 
   

3.    @Override

4.    protected boolean apply(NacosServer server, HttpHeaders headers) {

5.        PigxRibbonRuleProperties ribbonProperties = SpringContextHolder.getBean(PigxRibbonRuleProperties.class);

6. 
   

7.        if (!ribbonProperties.isGrayEnabled()) {

8.            log.debug("gray closed,GrayMetadataAwarePredicate return true");

9.            return true;

10.        }

11. 
    

12.        final Map<String, String> metadata = server.getMetadata();

13.        String version = metadata.get(CommonConstants.VERSION);

14.        // 判断Nacos服务是否有版本标签

15.        if (StrUtil.isBlank(version)) {

16.            log.debug("nacos server tag is blank ,GrayMetadataAwarePredicate return true");

17.            return true;

18.        }

19. 
    

20.        // 判断请求中是否有版本

21.        String target = headers.getFirst(CommonConstants.VERSION);

22.        if (StrUtil.isBlank(target)) {

23.            log.debug("request headers version is blank,GrayMetadataAwarePredicate return true");

24.            return true;

25.        }

26. 
    

27.        log.debug("请求版本:{} ,当前服务版本:{}", target, version);

28.        return target.equals(version);

29.    }

30. 
    

31. }

整合nacos

结合nacos的动态配置能够很是方便的实现灰度

总结

• 以上源码参考我的项目 基于Spring Cloud、OAuth2.0开发基于Vue先后分离的开发平台

• QQ: 2270033969 一块儿来聊聊大家是咋用 spring cloud 的吧。欢迎关注咱们得到更多的好玩JavaEE 实践