Spring Cloud全链路灰度发布

一、前言

实际生产中如有需求变更，并不会直接更新线上服务，最通常的做法便是：切出线上的小部分流量进行体验测试，经过测试后无问题则全面的上线。这样做的好处也是非常明显，一旦出现了BUG，能够保证大部分的客户端正常使用。要实现这种平滑过渡的方式就需要用到本篇文章介绍到的全链路灰度发布

1、什么是灰度发布

灰度发布（又名金丝雀发布）是指在黑与白之间，能够平滑过渡的一种发布方式。在其上可以进行A/B testing，即让一部分用户继续用产品特性A，一部分用户开始用产品特性B，如果用户对B没有什么反对意见，那么逐步扩大范围，把所有用户都迁移到B上面来。灰度发布可以保证整体系统的稳定，在初始灰度的时候就可以发现、调整问题，以保证其影响度。

2、为什么是全链路灰度发布

网关灰度发布实现的是网关通过灰度标记路由到用户服务B（灰度服务），至于从商品服务B到评论服务是通过openFeign内部调用的，默认无法实现灰度标记grayTag的透传，因此用户服务B最终调用的是无法保证调用商品服务的那个，也就是整个链路调用并不全是走灰度服务。

全链路灰度发布需要实现两个点：

1. 网关路由转发实现灰度发布
2. 服务内部通过openFeign调用实现灰度发布（透传灰度标记grayTag）。

二、网关层的灰度路由转发

具体实现步骤：

1. 请求头Header上需有灰度grayTag=true标记
2. gateway网关层定义全局过滤器，把灰度标记设置到请求头，把grayTag标识放入ThreadLocal
3. 自定义负载均衡规则，根据grayTag标识调用服务（true调用下游灰度服务，否则相反）

1、自定义全局过滤器

可以参考：gateway定义全局过滤器demo

@Slf4j
@Component
public class GlobalGrayFilter implements GlobalFilter{
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
         //① 解析请求头，查看是否存在灰度发布的请求头信息，如果存在则将其放置在ThreadLocal中
        HttpHeaders headers = exchange.getRequest().getHeaders();
        if (headers.containsKey(GrayConstant.GRAY_HEADER)){
            String gray = headers.getFirst(GrayConstant.GRAY_HEADER);
            if (StrUtil.equals(gray,GrayConstant.GRAY_VALUE)){
                //②设置灰度标记
                GrayRequestContextHolder.setGrayTag(true);
            }
        }
       //③ 将灰度标记放入请求头中
   ServerHttpRequest tokenRequest = exchange.getRequest().mutate()
    //将灰度标记传递过去
    .header(GrayConstant.GRAY_HEADER,GrayRequestContextHolder.getGrayTag().toString())
    .build();
            ServerWebExchange build = exchange.mutate().request(tokenRequest).build();
            return chain.filter(build);
    }
}

2、自定义负载均衡策略

具体逻辑：

1. 获取灰度标记
2. 从Nacos注册中心获取灰度服务和正常服务
3. 根据灰度标记去判断，如果灰度发布则选择特定的灰度服务进行转发

**
 * 灰度发布的规则
 */
public class GrayRule extends ZoneAvoidanceRule {

    @Override
    public void initWithNiwsConfig(IClientConfig clientConfig) {
    }

    @Override
    public Server choose(Object key) {
        try {
            //从ThreadLocal中获取灰度标记
            boolean grayTag = GrayRequestContextHolder.getGrayTag().get();
            //获取所有可用服务
            List<Server> serverList = this.getLoadBalancer().getReachableServers();
            //灰度发布的服务
            List<Server> grayServerList = new ArrayList<>();
            //正常的服务
            List<Server> normalServerList = new ArrayList<>();
            for(Server server : serverList) {
                NacosServer nacosServer = (NacosServer) server;
                //从nacos中获取元素剧进行匹配
                if(nacosServer.getMetadata().containsKey(GrayConstant.GRAY_HEADER)
                        && nacosServer.getMetadata().get(GrayConstant.GRAY_HEADER).equals(GrayConstant.GRAY_VALUE)) {
                    grayServerList.add(server);
                } else {
                    normalServerList.add(server);
                }
            }
            //如果被标记为灰度发布，则调用灰度发布的服务
            if(grayTag) {
                return originChoose(grayServerList,key);
            } else {
                return originChoose(normalServerList,key);
            }
        } finally {
            //清除灰度标记
            GrayRequestContextHolder.remove();
        }
    }

    private Server originChoose(List<Server> noMetaServerList, Object key) {
        Optional<Server> server = getPredicate().chooseRoundRobinAfterFiltering(noMetaServerList, key);
        if (server.isPresent()) {
            return server.get();
        } else {
            return null;
        }
    }
}

定义一个配置类，注入改造的灰度策略GrayRule，如下：
注意：这个GrayRuleConfig不能被扫描进入IOC容器，一旦扫描进入则全局生效

**
 * 灰度部署的负载规则配置类
 * 注意：这个类一定不要被Spring Boot 扫描进入IOC容器中，一旦扫描进入则对全部的服务都将生效
 */
public class GrayRuleConfig {
    @Bean
    public GrayRule grayRule(){
        return new GrayRule();
    }
}

配合@RibbonClients ，可以使单个服务（用户服务）灰度发布

@RibbonClients(value ={
        //只对用户服务进行灰度发布
        @RibbonClient(value = "user-server",configuration = GrayRuleConfig.class)
} )
@SpringBootApplication
public class GatewayApplication {
   
}

3、openFeign调用透传灰度标记grayTag

    openFeign在调用时并不是用的原先的Request，而是内部新建了一个Request，其中复制了请求的URL、请求参数一些信息，但是请求头并没有复制过去，因此openFeign调用会丢失请求头中的信息。

因此我们的新建个拦截器，把用户服务请求中的grayTag标识拷贝到openFeign新的request上

@Component
@Slf4j
public class FeignRequestInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        HttpServletRequest httpServletRequest = RequestContextUtils.getRequest();
        Map<String, String> headers = getHeaders(httpServletRequest);
        for (Map.Entry<String, String> entry : headers.entrySet()) {
            //② 设置请求头到新的Request中
            template.header(entry.getKey(), entry.getValue());
        }
    }

    /**
     * 获取原请求头
     */
    private Map<String, String> getHeaders(HttpServletRequest request) {
        Map<String, String> map = new LinkedHashMap<>();
        Enumeration<String> enumeration = request.getHeaderNames();
        if (enumeration != null) {
            while (enumeration.hasMoreElements()) {
                String key = enumeration.nextElement();
                String value = request.getHeader(key);
                //将灰度标记的请求头透传给下个服务
                if (StrUtil.equals(GrayConstant.GRAY_HEADER,key)&&Boolean.TRUE.toString().equals(value)){
                    //① 保存灰度发布的标记
                    GrayRequestContextHolder.setGrayTag(true);
                    map.put(key, value);
                }
            }
        }
        return map;
    }
}

4、nacos中配置服务是否是灰度服务

两种方式：
1、在配置文件中指定，如下：

spring:
  cloud:
    nacos:
      discovery:
        metadata:
          ## 灰度标记
          grayTag: true

2、在Nacos中动态的指定灰度标记

参考：
https://mp.weixin.qq.com/s/ftoXARaqOmNJVOIsU40myQ
https://www.cnblogs.com/kjcc/p/14378326.html