Spring Cloud 全链路灰度发布方案-CFANZ编程社区

如果实际生产有需求变更的话, 不会立刻在线上服务修改, 而是会切成一小部分流量进行修改测试。经过测试后无问题则全面的上线。

文章目录

1.什么是灰度发布
2.什么是全链路灰度发布
3.网关层的灰度路由转发
4.openFeign透传灰度标记
5.Nacos中服务如何做灰度标记
6.总结

1.什么是灰度发布

灰度发布（又名金丝雀发布）是指在黑与白之间，能够平滑过渡的一种发布方式。在上面可以进行A/B测试, 即让一部分用户继续用产品特性A, 一部分用户使用产品特性B, 如果用户B没有反对意见的话, 那么会逐渐扩大范围, 把用户都往特性B 上改。

灰度发布可以保证系统的稳定性, 在初始灰度的时候可以发现, 调整问题, 保证其影响度。

2.什么是全链路灰度发布

1.网关灰度发布: 网关通过灰度标记路由到文章服务B, 至于从文章服务B到评论服务是通过openfeign内部调用的, 默认无法实现灰度标记grayTag的透传, 因此文章服务B 最终调用的是评论服务A, 并不是评论服务B。

Spring Cloud 全链路灰度发布方案_spring cloud
全链路灰度发布需要实现的是:

网关通过灰度标记将部分流量转发给文章服务B
文章服务B能够实现灰度标记grayTag的透传，最终调用评论服务B

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

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

3.网关层的灰度路由转发

Ribbon+Spring Cloud Gateway 进行改造负载均衡策略实现灰度发布.

在网关的全局过滤器中根据业务规则给流量打上灰度标记
将灰度标记放入请求头中，传递给下游服务
改造Ribbon负载均衡策略，根据流量标记从注册中心获取灰度服务
请求路由转发

根据什么条件打上灰度标记

这个需要根据实际的业务需要，比如根据用户所在的地区、使用客户端类型、随机截取流量

这里我将直接使用一个标记grayTag，只要客户端请求头中携带了这个参数，并且设置为true，则走灰度发布逻辑。

grayTag=true

为什么要在请求头中添加灰度标记传递给下游服务

这一步非常关键，实现灰度标记透传给下游服务的关键，将灰度标记放在请求头中，下游服务只需要从请求头中获取灰度标记便知道是否是灰度发布，这个和令牌中继一个原理。

灰度标记如何请求隔离

Spring MVC中的每个请求都是开启一个线程进行处理，因此可以将灰度标记放置在ThreadLocal中进行线程隔离。

如何知道注册中心的服务哪个是灰度服务

Nacos支持在服务中配置一些元数据，可以将灰度标记配置在元数据中，这样就能区分哪些是灰度服务，哪些是正常服务。

如何针对特定的服务进行灰度发布

Spring Cloud 全链路灰度发布方案_灰度_02
我们知道网关路由中配置的服务很多，如何只针对文章服务进行灰度发布

只需要将自定义的Ribbon灰度发布规则只对文章服务生效
利用注解RibbonClients, 指定特定微服务

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

@RibbonClients其中有一个属性defaultConfiguration，一旦使用这个属性，那么灰度发布的策略对网关路由中配置的所有服务都将生效。

具体如何实现

网关中首先需要定义一个全局过滤器：

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);
    }
}

GrayRule:

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;
        }
    }
}

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

定义一个配置类，注入改造的灰度策略GrayRule

public class GrayRuleConfig {
    @Bean
    public GrayRule grayRule(){
        return new GrayRule();
    }
}

这个GrayRuleConfig不能被扫描进入IOC容器，一旦扫描进入则全局生效

4.openFeign透传灰度标记

如何从请求头中取出灰度标记

可以通过实现RequestInterceptor将原先的请求头给复制过去

@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;
    }
}

也需要使用@RibbonClients注解去标注文章服务调用的哪些服务需要灰度发布。

@RibbonClients(value = {
        //指定对comments这个服务开启灰度部署
        @RibbonClient(value = "comments",configuration = GrayRuleConfig.class)
})
public class ArticleApplication {}

5.Nacos中服务如何做灰度标记

配置文件:

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

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

Spring Cloud 全链路灰度发布方案_灰度_03
配置完成之后，在客户端请求的时候只需要携带grayTag=true这个请求头即可调用灰度服务。

6.总结

网关中通过全局过滤器实现灰度打标，将灰度标记放入请求头中传递给下游服务
网关通过自定义的负载均衡策略，从注册中心获取灰度服务，进行转发
在openFeign调用时需要从请求头中获取灰度标记，放入上下文中
openFeign调用同样是根据自定义的负载均衡策略从注册中心获取灰度服务，进行调用。
Nacos进行灰度服务调用