1、背景(灰度部署)

在我们系统发布生产环境时，有时为了确保新的服务逻辑没有问题，会让一小部分特定的用户来使用新的版本（比如客户端的内测版本），而其余的用户使用旧的版本，那么这个在Spring Cloud中该如何来实现呢？

负载均衡组件使用：Spring Cloud LoadBalancer

2、需求

3、实现思路



通过翻阅Spring Cloud的官方文档，我们知道，大概可以通过2种方式来达到我们的目的。

  1. 实现 ReactiveLoadBalancer接口，重写负载均衡算法。
  2. 实现ServiceInstanceListSupplier接口，重写get方法，返回自定义的服务列表。

ServiceInstanceListSupplier： 可以实现如下功能，比如我们的 user-service在注册中心上存在5个，此处我可以只返回3个。

4、Spring Cloud中是否有我上方类似需求的例子

查阅Spring Cloud官方文档，发现org.springframework.cloud.loadbalancer.core.HintBasedServiceInstanceListSupplier 类可以实现类似的功能。

那可能有人会说，既然Spring Cloud已经提供了这个功能，为什么你还要重写一个？ 此处只是为了一个记录，因为工作中的需求可能各种各样，万一后期有类似的需求，此处记录了，后期知道怎么实现。

5、核心代码实现

5.1 灰度核心代码

5.1.1 灰度服务实例选择器实现

package com.huan.loadbalancer;

import lombok.extern.slf4j.Slf4j;

import org.springframework.cloud.client.ServiceInstance;

import org.springframework.cloud.client.loadbalancer.Request;

import org.springframework.cloud.client.loadbalancer.RequestDataContext;

import org.springframework.cloud.loadbalancer.core.DelegatingServiceInstanceListSupplier;

import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;

import org.springframework.http.HttpHeaders;

import reactor.core.publisher.Flux;

import java.util.List;

import java.util.Objects;

import java.util.stream.Collectors;

/**

 * 自定义 根据服务名 获取服务实例 列表

 * <p>

 * 需求： 用户通过请求访问 网关<br />

 * 1、如果请求头中的 version 值和 下游服务元数据的 version 值一致，则选择该 服务。<br />

 * 2、如果请求头中的 version 值和 下游服务元数据的 version 值不一致，且 不存在 version 的值 为 default 则直接报错。<br />

 * 3、如果请求头中的 version 值和 下游服务元数据的 version 值不一致，且 存在 version 的值 为 default，则选择该服务。<br />

 * <p>

 * 参考: {@link org.springframework.cloud.loadbalancer.core.HintBasedServiceInstanceListSupplier} 实现

 *

 * @author huan.fu

 * @date 2023/6/19 - 21:14

 */

@Slf4j

public class VersionServiceInstanceListSupplier extends DelegatingServiceInstanceListSupplier {

    /**

     * 请求头的名字， 通过这个 version 字段和 服务中的元数据来version字段进行比较，

     * 得到最终的实例数据

     */

    private static final String VERSION_HEADER_NAME = "version";

    public VersionServiceInstanceListSupplier(ServiceInstanceListSupplier delegate) {

        super(delegate);

    }

    @Override

    public Flux<List<ServiceInstance>> get() {

        return delegate.get();

    }

    @Override

    public Flux<List<ServiceInstance>> get(Request request) {

        return delegate.get(request).map(instances -> filteredByVersion(instances, getVersion(request.getContext())));

    }

    private String getVersion(Object requestContext) {

        if (requestContext == null) {

            return null;

        }

        String version = null;

        if (requestContext instanceof RequestDataContext) {

            version = getVersionFromHeader((RequestDataContext) requestContext);

        }

        log.info("获取到需要请求服务[{}]的version:[{}]", getServiceId(), version);

        return version;

    }

    /**

     * 从请求中获取version

     */

    private String getVersionFromHeader(RequestDataContext context) {

        if (context.getClientRequest() != null) {

            HttpHeaders headers = context.getClientRequest().getHeaders();

            if (headers != null) {

                return headers.getFirst(VERSION_HEADER_NAME);

            }

        }

        return null;

    }

    private List<ServiceInstance> filteredByVersion(List<ServiceInstance> instances, String version) {

        // 1、获取 请求头中的 version 和 ServiceInstance 中 元数据中 version 一致的服务

        List<ServiceInstance> selectServiceInstances = instances.stream()

                .filter(instance -> instance.getMetadata().get(VERSION_HEADER_NAME) != null

                        && Objects.equals(version, instance.getMetadata().get(VERSION_HEADER_NAME)))

                .collect(Collectors.toList());

        if (!selectServiceInstances.isEmpty()) {

            log.info("返回请求服务:[{}]为version:[{}]的有:[{}]个", getServiceId(), version, selectServiceInstances.size());

            return selectServiceInstances;

        }

        // 2、返回 version=default 的实例

        selectServiceInstances = instances.stream()

                .filter(instance -> Objects.equals(instance.getMetadata().get(VERSION_HEADER_NAME), "default"))

                .collect(Collectors.toList());

        log.info("返回请求服务:[{}]为version:[{}]的有:[{}]个", getServiceId(), "default", selectServiceInstances.size());

        return selectServiceInstances;

    }

}

5.1.2 灰度feign请求头传递拦截器

package com.huan.loadbalancer;

import feign.RequestInterceptor;

import feign.RequestTemplate;

import lombok.extern.slf4j.Slf4j;

import org.springframework.stereotype.Component;

import org.springframework.web.context.request.RequestContextHolder;

import org.springframework.web.context.request.ServletRequestAttributes;

/**

 * 将version请求头通过feign传递到下游

 *

 * @author huan.fu

 * @date 2023/6/20 - 08:27

 */

@Component

@Slf4j

public class VersionRequestInterceptor implements RequestInterceptor {

    @Override

    public void apply(RequestTemplate requestTemplate) {

        String version = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest()

                .getHeader("version");

        log.info("feign 中传递的 version 请求头的值为:[{}]", version);

        requestTemplate

                .header("version", version);

    }

}

注意： 此处全局配置了，配置了一个feign的全局拦截器，进行请求头version的传递。

5.1.3 灰度服务实例选择器配置

package com.huan.loadbalancer;

import lombok.extern.slf4j.Slf4j;

import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;

import org.springframework.cloud.client.discovery.DiscoveryClient;

import org.springframework.cloud.client.discovery.ReactiveDiscoveryClient;

import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients;

import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;

import org.springframework.context.ConfigurableApplicationContext;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

/**

 * 此处选择全局配置

 *

 * @author huan.fu

 * @date 2023/6/19 - 22:16

 */

@Configuration

@Slf4j

@LoadBalancerClients(defaultConfiguration = VersionServiceInstanceListSupplierConfiguration.class)

public class VersionServiceInstanceListSupplierConfiguration {

    @Bean

    @ConditionalOnClass(name = "org.springframework.web.servlet.DispatcherServlet")

    public VersionServiceInstanceListSupplier versionServiceInstanceListSupplierV1(

            ConfigurableApplicationContext context) {

        log.error("===========> versionServiceInstanceListSupplierV1");

        ServiceInstanceListSupplier delegate = ServiceInstanceListSupplier.builder()

                .withBlockingDiscoveryClient()

                .withCaching()

                .build(context);

        return new VersionServiceInstanceListSupplier(delegate);

    }

    @Bean

    @ConditionalOnClass(name = "org.springframework.web.reactive.DispatcherHandler")

    public VersionServiceInstanceListSupplier versionServiceInstanceListSupplierV2(

            ConfigurableApplicationContext context) {

        log.error("===========> versionServiceInstanceListSupplierV2");

        ServiceInstanceListSupplier delegate = ServiceInstanceListSupplier.builder()

                .withDiscoveryClient()

                .withCaching()

                .build(context);

        return new VersionServiceInstanceListSupplier(delegate);

    }

}

此处偷懒全局配置了

@Configuration @Slf4j @LoadBalancerClients(defaultConfiguration = VersionServiceInstanceListSupplierConfiguration.class)

5.2 网关核心代码

5.2.1 网关配置文件

spring:

  application:

    name: lobalancer-gateway-8001

  cloud:

    nacos:

      discovery:

        # 配置 nacos 的服务地址

        server-addr: localhost:8848

        group: DEFAULT_GROUP

      config:

        server-addr: localhost:8848

    gateway:

      discovery:

        locator:

          enabled: true

server:

  port: 8001

logging:

  level:

    root: info

5.3 服务提供者核心代码

5.3.1 向外提供一个方法

package com.huan.loadbalancer.controller;

import com.alibaba.cloud.nacos.NacosDiscoveryProperties;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**

 * 提供者控制器

 *

 * @author huan.fu

 * @date 2023/3/6 - 21:58

 */

@RestController

public class ProviderController {

    @Resource

    private NacosDiscoveryProperties nacosDiscoveryProperties;

    /**

     * 获取服务信息

     *

     * @return ip:port

     */

    @GetMapping("serverInfo")

    public String serverInfo() {

        return nacosDiscoveryProperties.getIp() + ":" + nacosDiscoveryProperties.getPort();

    }

}

5.3.2 提供者端口8005配置信息

spring:

  application:

    name: provider

  cloud:

    nacos:

      discovery:

        # 配置 nacos 的服务地址

        server-addr: localhost:8848

        # 配置元数据

        metadata:

          version: v1

      config:

        server-addr: localhost:8848

server:

  port: 8005

注意 metadata中version的值

5.3.2 提供者端口8006配置信息

spring:

  application:

    name: provider

  cloud:

    nacos:

      discovery:

        # 配置 nacos 的服务地址

        server-addr: localhost:8848

        # 配置元数据

        metadata:

          version: v1

      config:

        server-addr: localhost:8848

server:

  port: 8006

注意 metadata中version的值

5.3.3 提供者端口8007配置信息

spring:

  application:

    name: provider

  cloud:

    nacos:

      discovery:

        # 配置 nacos 的服务地址

        server-addr: localhost:8848

        # 配置元数据

        metadata:

          version: default

      config:

        server-addr: localhost:8848

server:

  port: 8007

注意 metadata中version的值

5.4 服务消费者代码

5.4.1 通过 feign 调用提供者方法

/**

 * @author huan.fu

 * @date 2023/6/19 - 22:21

 */

@FeignClient(value = "provider")

public interface FeignProvider {

    /**

     * 获取服务信息

     *

     * @return ip:port

     */

    @GetMapping("serverInfo")

    String fetchServerInfo();

}

5.4.2 向外提供一个方法

package com.huan.loadbalancer.controller;

import com.alibaba.cloud.nacos.NacosDiscoveryProperties;

import com.huan.loadbalancer.feign.FeignProvider;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

import java.util.HashMap;

import java.util.Map;

/**

 * 消费者控制器

 *

 * @author huan.fu

 * @date 2023/6/19 - 22:21

 */

@RestController

public class ConsumerController {

    @Resource

    private FeignProvider feignProvider;

    @Resource

    private NacosDiscoveryProperties nacosDiscoveryProperties;

    @GetMapping("fetchProviderServerInfo")

    public Map<String, String> fetchProviderServerInfo() {

        Map<String, String> ret = new HashMap<>(4);

        ret.put("consumer信息", nacosDiscoveryProperties.getIp() + ":" + nacosDiscoveryProperties.getPort());

        ret.put("provider信息", feignProvider.fetchServerInfo());

        return ret;

    }

}

消费者端口 8002 配置信息

spring:

  application:

    name: consumer

  cloud:

    nacos:

      discovery:

        # 配置 nacos 的服务地址

        server-addr: localhost:8848

        register-enabled: true

        service: nacos-feign-consumer

        group: DEFAULT_GROUP

        metadata:

          version: v1

      config:

        server-addr: localhost:8848

server:

  port: 8002

注意 metadata中version的值

消费者端口 8003 配置信息

spring:

  application:

    name: consumer

  cloud:

    nacos:

      discovery:

        # 配置 nacos 的服务地址

        server-addr: localhost:8848

        register-enabled: true

        service: nacos-feign-consumer

        group: DEFAULT_GROUP

        metadata:

          version: v2

      config:

        server-addr: localhost:8848

server:

  port: 8003

注意 metadata中version的值

消费者端口 8004 配置信息

spring:

  application:

    name: consumer

  cloud:

    nacos:

      discovery:

        # 配置 nacos 的服务地址

        server-addr: localhost:8848

        register-enabled: true

        service: nacos-feign-consumer

        group: DEFAULT_GROUP

        metadata:

          version: default

      config:

        server-addr: localhost:8848

server:

  port: 8003

注意 metadata中version的值

6、测试

6.1 请求头中携带 version=v1

从上图中可以看到，当version=v1时，服务消费者为consumer-8002, 提供者为provider-8005和provider-8006

➜  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo' \

--header 'version: v1'

{"consumer信息":"192.168.8.168:8002","provider信息":"192.168.8.168:8005"}%

➜  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo' \

--header 'version: v1'

{"consumer信息":"192.168.8.168:8002","provider信息":"192.168.8.168:8006"}%

➜  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo' \

--header 'version: v1'

{"consumer信息":"192.168.8.168:8002","provider信息":"192.168.8.168:8005"}%

➜  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo' \

--header 'version: v1'

{"consumer信息":"192.168.8.168:8002","provider信息":"192.168.8.168:8006"}%

➜  ~

可以看到，消费者返回的端口是8002，提供者返回的端口是8005|8006是符合预期的。

6.2 不传递version

从上图中可以看到，当不携带时，服务消费者为consumer-8004, 提供者为provider-8007和

➜  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo'

{"consumer信息":"192.168.8.168:8004","provider信息":"192.168.8.168:8007"}%

➜  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo'

{"consumer信息":"192.168.8.168:8004","provider信息":"192.168.8.168:8007"}%

➜  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo'

{"consumer信息":"192.168.8.168:8004","provider信息":"192.168.8.168:8007"}%

➜  ~

可以看到，消费者返回的端口是8004，提供者返回的端口是8007是符合预期的。

7、完整代码

https://gitee.com/huan1993/spring-cloud-alibaba-parent/tree/master/loadbalancer-supply-service-instance

8、参考文档

1、https://docs.spring.io/spring-cloud-commons/docs/current/reference/html/#spring-cloud-loadbalancer

Spring Cloud灰度部署的更多相关文章

  1. Spring Cloud灰度发布之Nepxion Discovery

    <蓝绿部署.红黑部署.AB测试.灰度发布.金丝雀发布.滚动发布的概念与区别> 最近公司项目在做架构升级,升级为 Spring Cloud,我们希望能够做到服务的灰度发布,根据访问量逐渐切换 ...

  2. 【架构】Kubernetes和Spring Cloud哪个部署微服务更好？

    Spring Cloud 和Kubernetes都自称自己是部署和运行微服务的最好环境,但是它们在本质上和解决不同问题上是有很大差异的.在本文中,我们将看到每个平台如何帮助交付基于微服务的架构(MSA ...

  3. 微服务开发平台 Spring Cloud Blade 部署实践

    本文介绍使用 Rainbond 快速部署 Spring Cloud Blade 微服务平台.Spring Cloud Blade 是一个由商业级项目升级优化而来的微服务架构,采用Spring Boot ...

  4. 一句话概括下spring框架及spring cloud框架主要组件

    作为java的屌丝,基本上跟上spring屌丝的步伐,也就跟上了主流技术.spring 顶级项目:Spring IO platform:用于系统部署,是可集成的,构建现代化应用的版本平台,具体来说当你 ...

  5. Spring顶级项目以及Spring cloud组件

    作为java的屌丝,基本上跟上spring屌丝的步伐,也就跟上了主流技术. spring 顶级项目: Spring IO platform:用于系统部署,是可集成的,构建现代化应用的版本平台,具体来说 ...

  6. 【译文】用Spring Cloud和Docker搭建微服务平台

    by Kenny Bastani Sunday, July 12, 2015 转自:http://www.kennybastani.com/2015/07/spring-cloud-docker-mi ...

  7. Spring cloud定义学习

    今天讲到的最重要的内容: Spring cloud是什么? Spring cloud项目 spring cloud版本     什么事springcloud? spring cloud 为开发人员提供 ...

  8. 简述 Spring Cloud 是什么2

    一.概念定义       Spring Cloud是一个微服务框架,相比Dubbo等RPC框架, Spring Cloud提供的全套的分布式系统解决方案. Spring Cloud对微服务基础框架Ne ...

  9. spring 和spring cloud 组成

    spring 顶级项目:Spring IO platform:用于系统部署,是可集成的,构建现代化应用的版本平台,具体来说当你使用maven dependency引入spring jar包时它就在工作 ...

  10. Spring Boot + Spring Cloud 实现权限管理系统 后端篇（一）：Kitty 系统介绍

    在线演示 演示地址:http://139.196.87.48:9002/kitty 用户名:admin 密码:admin 温馨提示: 有在演示环境删除数据的童鞋们,如果可以的话,麻烦动动小指,右键头像 ...

随机推荐

  1. 在Android应用中通过Chaquopy使用Python

    在Android应用中通过Chaquopy使用Python [译] 通过Python脚本和包为Android应用带来更多的功能 翻译自https://proandroiddev.com/chaquop ...

  2. 高尔顿钉板的统计意义—R实现

    提到高尔顿,人们总是把他和钉板实验联系在一起,偶尔也会有人提及他是达尔文的表弟.实际上,作为维多利亚时代的人类学家.统计学家.心理学家和遗传学家,同时又是热带探险家.地理学家.发明家.气象学家,高尔顿 ...

  3. 开源项目audioFlux: 针对音频领域的深度学习工具库

    目录 时频变换 频谱重排 倒谱系数 解卷积 谱特征 音乐信息检索 audioFlux是一个Python和C实现的库,提供音频领域系统.全面.多维度的特征提取与组合,结合各种深度学习网络模型,进行音频领 ...

  4. Binder机制及底层实现

    <1>进程间的内存空间是进程私有的<2>进程间和内核的空间是互通的<3>进程1空间<--->内核空间<-->进程2空间Binder跨进程通信 ...

  5. mysql 命令批量修改一个字段/帝国cms sql命令修改一个字段

    UPDATE phome_enewstagsdata SET classid=5 where classid=1 UPDATE phome_ecms_news SET classid=8 where ...

  6. C# 如何设计一个好用的日志库？【架构篇】

    〇.前言 相信你在实际工作期间经常遇到或听到这样的说法:   "我现在加一下日志,等会儿你再操作下."   "只有在程序出问题以后才会知道打一个好的日志有多么重要.&qu ...

  7. CSS实现单行或者多行文本溢出隐藏并且显示省略号

    一.单行超出显示省略号如果文字超出父元素指定宽度,文字会自动换行,而连续不间断数字和英文字母(没有其他字符)不会自动换行: 详细步骤: 第一步(不换行):white-space:nowrop;(对于连 ...

  8. Appuploader证书申请教程

    转载:http://kxdang.com/topic/appuploader/certification.html IOS证书制作教程 点击苹果证书 按钮 点击新增 输入证书密码,名称 这个密码不是账 ...

  9. PowerBI（一） : 如何将powerBI报表嵌入内部web应用程序？

    最近做了一个PowerBI报表嵌入内部web应用系统的项目,分享一下主要步骤以及踩坑记录. 微软官网完整教程这里:https://learn.microsoft.com/zh-cn/power-bi/ ...

  10. 在web浏览器中如何操作复合IC卡

    在web浏览器中如何操作复合IC卡呢, 对于使用javascript的工程师而言,非常简单,只需要几行代码即可实现.当然在写代码之前, 需要安装友我NFC读写器web插件, 然后插上NFC读写器YW- ...