经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » Java相关 » Spring » 查看文章
Spring Cloud灰度部署
来源：cnblogs　　作者：huan1993　　时间：2023/6/21 10:52:26　　对本文有异议

1、背景(灰度部署)

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

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

2、需求

需求

3、实现思路

Spring Cloud Loadbalancer
通过翻阅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 灰度服务实例选择器实现

  1. package com.huan.loadbalancer;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.cloud.client.ServiceInstance;
  5. import org.springframework.cloud.client.loadbalancer.Request;
  6. import org.springframework.cloud.client.loadbalancer.RequestDataContext;
  7. import org.springframework.cloud.loadbalancer.core.DelegatingServiceInstanceListSupplier;
  8. import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
  9. import org.springframework.http.HttpHeaders;
  10. import reactor.core.publisher.Flux;
  12. import java.util.List;
  13. import java.util.Objects;
  14. import java.util.stream.Collectors;
  16. /**
  17.  * 自定义 根据服务名 获取服务实例 列表
  18.  * <p>
  19.  * 需求： 用户通过请求访问 网关<br />
  20.  * 1、如果请求头中的 version 值和 下游服务元数据的 version 值一致，则选择该 服务。<br />
  21.  * 2、如果请求头中的 version 值和 下游服务元数据的 version 值不一致，且 不存在 version 的值 为 default 则直接报错。<br />
  22.  * 3、如果请求头中的 version 值和 下游服务元数据的 version 值不一致，且 存在 version 的值 为 default，则选择该服务。<br />
  23.  * <p>
  24.  * 参考: {@link org.springframework.cloud.loadbalancer.core.HintBasedServiceInstanceListSupplier} 实现
  25.  *
  26.  * @author huan.fu
  27.  * @date 2023/6/19 - 21:14
  28.  */
  29. @Slf4j
  30. public class VersionServiceInstanceListSupplier extends DelegatingServiceInstanceListSupplier {
  32.     /**
  33.      * 请求头的名字， 通过这个 version 字段和 服务中的元数据来version字段进行比较，
  34.      * 得到最终的实例数据
  35.      */
  36.     private static final String VERSION_HEADER_NAME = "version";
  38.     public VersionServiceInstanceListSupplier(ServiceInstanceListSupplier delegate) {
  39.         super(delegate);
  40.     }
  42.     @Override
  43.     public Flux<List<ServiceInstance>> get() {
  44.         return delegate.get();
  45.     }
  47.     @Override
  48.     public Flux<List<ServiceInstance>> get(Request request) {
  49.         return delegate.get(request).map(instances -> filteredByVersion(instances, getVersion(request.getContext())));
  50.     }
  52.     private String getVersion(Object requestContext) {
  53.         if (requestContext == null) {
  54.             return null;
  55.         }
  56.         String version = null;
  57.         if (requestContext instanceof RequestDataContext) {
  58.             version = getVersionFromHeader((RequestDataContext) requestContext);
  59.         }
  60.         log.info("获取到需要请求服务[{}]的version:[{}]", getServiceId(), version);
  61.         return version;
  62.     }
  64.     /**
  65.      * 从请求中获取version
  66.      */
  67.     private String getVersionFromHeader(RequestDataContext context) {
  68.         if (context.getClientRequest() != null) {
  69.             HttpHeaders headers = context.getClientRequest().getHeaders();
  70.             if (headers != null) {
  71.                 return headers.getFirst(VERSION_HEADER_NAME);
  72.             }
  73.         }
  74.         return null;
  75.     }
  77.     private List<ServiceInstance> filteredByVersion(List<ServiceInstance> instances, String version) {
  79.         // 1、获取 请求头中的 version 和 ServiceInstance 中 元数据中 version 一致的服务
  80.         List<ServiceInstance> selectServiceInstances = instances.stream()
  81.                 .filter(instance -> instance.getMetadata().get(VERSION_HEADER_NAME) != null
  82.                         && Objects.equals(version, instance.getMetadata().get(VERSION_HEADER_NAME)))
  83.                 .collect(Collectors.toList());
  84.         if (!selectServiceInstances.isEmpty()) {
  85.             log.info("返回请求服务:[{}]为version:[{}]的有:[{}]个", getServiceId(), version, selectServiceInstances.size());
  86.             return selectServiceInstances;
  87.         }
  89.         // 2、返回 version=default 的实例
  90.         selectServiceInstances = instances.stream()
  91.                 .filter(instance -> Objects.equals(instance.getMetadata().get(VERSION_HEADER_NAME), "default"))
  92.                 .collect(Collectors.toList());
  93.         log.info("返回请求服务:[{}]为version:[{}]的有:[{}]个", getServiceId(), "default", selectServiceInstances.size());
  94.         return selectServiceInstances;
  95.     }
  96. }

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

  1. package com.huan.loadbalancer;
  3. import feign.RequestInterceptor;
  4. import feign.RequestTemplate;
  5. import lombok.extern.slf4j.Slf4j;
  6. import org.springframework.stereotype.Component;
  7. import org.springframework.web.context.request.RequestContextHolder;
  8. import org.springframework.web.context.request.ServletRequestAttributes;
  10. /**
  11.  * 将version请求头通过feign传递到下游
  12.  *
  13.  * @author huan.fu
  14.  * @date 2023/6/20 - 08:27
  15.  */
  16. @Component
  17. @Slf4j
  18. public class VersionRequestInterceptor implements RequestInterceptor {
  20.     @Override
  21.     public void apply(RequestTemplate requestTemplate) {
  22.         String version = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest()
  23.                 .getHeader("version");
  24.         log.info("feign 中传递的 version 请求头的值为:[{}]", version);
  25.         requestTemplate
  26.                 .header("version", version);
  27.     }
  28. }

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

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

  1. package com.huan.loadbalancer;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
  5. import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
  6. import org.springframework.cloud.client.discovery.DiscoveryClient;
  7. import org.springframework.cloud.client.discovery.ReactiveDiscoveryClient;
  8. import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients;
  9. import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
  10. import org.springframework.context.ConfigurableApplicationContext;
  11. import org.springframework.context.annotation.Bean;
  12. import org.springframework.context.annotation.Configuration;
  14. /**
  15.  * 此处选择全局配置
  16.  *
  17.  * @author huan.fu
  18.  * @date 2023/6/19 - 22:16
  19.  */
  20. @Configuration
  21. @Slf4j
  22. @LoadBalancerClients(defaultConfiguration = VersionServiceInstanceListSupplierConfiguration.class)
  23. public class VersionServiceInstanceListSupplierConfiguration {
  25.     @Bean
  26.     @ConditionalOnClass(name = "org.springframework.web.servlet.DispatcherServlet")
  27.     public VersionServiceInstanceListSupplier versionServiceInstanceListSupplierV1(
  28.             ConfigurableApplicationContext context) {
  29.         log.error("===========> versionServiceInstanceListSupplierV1");
  30.         ServiceInstanceListSupplier delegate = ServiceInstanceListSupplier.builder()
  31.                 .withBlockingDiscoveryClient()
  32.                 .withCaching()
  33.                 .build(context);
  34.         return new VersionServiceInstanceListSupplier(delegate);
  35.     }
  37.     @Bean
  38.     @ConditionalOnClass(name = "org.springframework.web.reactive.DispatcherHandler")
  39.     public VersionServiceInstanceListSupplier versionServiceInstanceListSupplierV2(
  40.             ConfigurableApplicationContext context) {
  41.         log.error("===========> versionServiceInstanceListSupplierV2");
  42.         ServiceInstanceListSupplier delegate = ServiceInstanceListSupplier.builder()
  43.                 .withDiscoveryClient()
  44.                 .withCaching()
  45.                 .build(context);
  46.         return new VersionServiceInstanceListSupplier(delegate);
  47.     }
  48. }

此处偷懒全局配置了
@Configuration @Slf4j @LoadBalancerClients(defaultConfiguration = VersionServiceInstanceListSupplierConfiguration.class)

5.2 网关核心代码

5.2.1 网关配置文件

  1. spring:
  2.   application:
  3.     name: lobalancer-gateway-8001
  4.   cloud:
  5.     nacos:
  6.       discovery:
  7.         # 配置 nacos 的服务地址
  8.         server-addr: localhost:8848
  9.         group: DEFAULT_GROUP
  10.       config:
  11.         server-addr: localhost:8848
  12.     gateway:
  13.       discovery:
  14.         locator:
  15.           enabled: true
  17. server:
  18.   port: 8001
  20. logging:
  21.   level:
  22.     root: info

5.3 服务提供者核心代码

5.3.1 向外提供一个方法

  1. package com.huan.loadbalancer.controller;
  3. import com.alibaba.cloud.nacos.NacosDiscoveryProperties;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. import javax.annotation.Resource;
  9. /**
  10.  * 提供者控制器
  11.  *
  12.  * @author huan.fu
  13.  * @date 2023/3/6 - 21:58
  14.  */
  15. @RestController
  16. public class ProviderController {
  18.     @Resource
  19.     private NacosDiscoveryProperties nacosDiscoveryProperties;
  21.     /**
  22.      * 获取服务信息
  23.      *
  24.      * @return ip:port
  25.      */
  26.     @GetMapping("serverInfo")
  27.     public String serverInfo() {
  28.         return nacosDiscoveryProperties.getIp() + ":" + nacosDiscoveryProperties.getPort();
  29.     }
  30. }

5.3.2 提供者端口8005配置信息

  1. spring:
  2.   application:
  3.     name: provider
  4.   cloud:
  5.     nacos:
  6.       discovery:
  7.         # 配置 nacos 的服务地址
  8.         server-addr: localhost:8848
  9.         # 配置元数据
  10.         metadata:
  11.           version: v1
  12.       config:
  13.         server-addr: localhost:8848
  14. server:
  15.   port: 8005

注意 metadata中version的值

5.3.2 提供者端口8006配置信息

  1. spring:
  2.   application:
  3.     name: provider
  4.   cloud:
  5.     nacos:
  6.       discovery:
  7.         # 配置 nacos 的服务地址
  8.         server-addr: localhost:8848
  9.         # 配置元数据
  10.         metadata:
  11.           version: v1
  12.       config:
  13.         server-addr: localhost:8848
  14. server:
  15.   port: 8006

注意 metadata中version的值

5.3.3 提供者端口8007配置信息

  1. spring:
  2.   application:
  3.     name: provider
  4.   cloud:
  5.     nacos:
  6.       discovery:
  7.         # 配置 nacos 的服务地址
  8.         server-addr: localhost:8848
  9.         # 配置元数据
  10.         metadata:
  11.           version: default
  12.       config:
  13.         server-addr: localhost:8848
  14. server:
  15.   port: 8007

注意 metadata中version的值

5.4 服务消费者代码

5.4.1 通过 feign 调用提供者方法

  1. /**
  2.  * @author huan.fu
  3.  * @date 2023/6/19 - 22:21
  4.  */
  5. @FeignClient(value = "provider")
  6. public interface FeignProvider {
  8.     /**
  9.      * 获取服务信息
  10.      *
  11.      * @return ip:port
  12.      */
  13.     @GetMapping("serverInfo")
  14.     String fetchServerInfo();
  16. }

5.4.2 向外提供一个方法

  1. package com.huan.loadbalancer.controller;
  3. import com.alibaba.cloud.nacos.NacosDiscoveryProperties;
  4. import com.huan.loadbalancer.feign.FeignProvider;
  5. import org.springframework.web.bind.annotation.GetMapping;
  6. import org.springframework.web.bind.annotation.RestController;
  8. import javax.annotation.Resource;
  9. import java.util.HashMap;
  10. import java.util.Map;
  12. /**
  13.  * 消费者控制器
  14.  *
  15.  * @author huan.fu
  16.  * @date 2023/6/19 - 22:21
  17.  */
  18. @RestController
  19. public class ConsumerController {
  21.     @Resource
  22.     private FeignProvider feignProvider;
  23.     @Resource
  24.     private NacosDiscoveryProperties nacosDiscoveryProperties;
  26.     @GetMapping("fetchProviderServerInfo")
  27.     public Map<String, String> fetchProviderServerInfo() {
  28.         Map<String, String> ret = new HashMap<>(4);
  29.         ret.put("consumer信息", nacosDiscoveryProperties.getIp() + ":" + nacosDiscoveryProperties.getPort());
  30.         ret.put("provider信息", feignProvider.fetchServerInfo());
  31.         return ret;
  32.     }
  33. }

消费者端口 8002 配置信息

  1. spring:
  2.   application:
  3.     name: consumer
  4.   cloud:
  5.     nacos:
  6.       discovery:
  7.         # 配置 nacos 的服务地址
  8.         server-addr: localhost:8848
  9.         register-enabled: true
  10.         service: nacos-feign-consumer
  11.         group: DEFAULT_GROUP
  12.         metadata:
  13.           version: v1
  14.       config:
  15.         server-addr: localhost:8848
  16. server:
  17.   port: 8002

注意 metadata中version的值

消费者端口 8003 配置信息

  1. spring:
  2.   application:
  3.     name: consumer
  4.   cloud:
  5.     nacos:
  6.       discovery:
  7.         # 配置 nacos 的服务地址
  8.         server-addr: localhost:8848
  9.         register-enabled: true
  10.         service: nacos-feign-consumer
  11.         group: DEFAULT_GROUP
  12.         metadata:
  13.           version: v2
  14.       config:
  15.         server-addr: localhost:8848
  16. server:
  17.   port: 8003

注意 metadata中version的值

消费者端口 8004 配置信息

  1. spring:
  2.   application:
  3.     name: consumer
  4.   cloud:
  5.     nacos:
  6.       discovery:
  7.         # 配置 nacos 的服务地址
  8.         server-addr: localhost:8848
  9.         register-enabled: true
  10.         service: nacos-feign-consumer
  11.         group: DEFAULT_GROUP
  12.         metadata:
  13.           version: default
  14.       config:
  15.         server-addr: localhost:8848
  16. server:
  17.   port: 8003

注意 metadata中version的值

6、测试

代码与图的对应关系

6.1 请求头中携带 version=v1

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

  1. ?  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo' --header 'version: v1'
  2. {"consumer信息":"192.168.8.168:8002","provider信息":"192.168.8.168:8005"}%
  3. ?  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo' --header 'version: v1'
  4. {"consumer信息":"192.168.8.168:8002","provider信息":"192.168.8.168:8006"}%
  5. ?  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo' --header 'version: v1'
  6. {"consumer信息":"192.168.8.168:8002","provider信息":"192.168.8.168:8005"}%
  7. ?  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo' --header 'version: v1'
  8. {"consumer信息":"192.168.8.168:8002","provider信息":"192.168.8.168:8006"}%
  9. ?  ~

请求头中携带 version=v1

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

6.2 不传递version

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

  1. ?  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo'
  2. {"consumer信息":"192.168.8.168:8004","provider信息":"192.168.8.168:8007"}%
  3. ?  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo'
  4. {"consumer信息":"192.168.8.168:8004","provider信息":"192.168.8.168:8007"}%
  5. ?  ~ curl --location --request GET 'http://localhost:8001/nacos-feign-consumer/fetchProviderServerInfo'
  6. {"consumer信息":"192.168.8.168:8004","provider信息":"192.168.8.168:8007"}%
  7. ?  ~

可以看到，消费者返回的端口是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

原文链接：https://www.cnblogs.com/huan1993/p/17494527.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Spring热门文章

  • 解决springboot+activemq启动报注解错误的问题
  • Springboot整合Rabbitmq之Confirm和Return机制
  • SpringBoot SpringEL表达式的使用
  • SpringBoot自动配置原理,你真的懂吗?(简单易懂)
  • Spring源码：Bean生命周期（终章）
  • Springboot-Management的项目实践
  • 解决springboot 启动找不到主类的问题
  • Spring5路径匹配器PathPattern解析
  • SpringAOP如何获取方法参数上的注解
  • java与es8实战之五：SpringBoot应用中操作es8(带安全检查：https、账号密码、API Key)

    • Spring推荐文章

  • SpringBoot Session共享，配置不生效问题排查 → 你竟然在代码里下毒！
  • 【Spring源码分析】Spring Scope功能中的动态代理 - Scoped Proxy
  • Spring AOP概念及原理
  • SpringBoot2.7还是任性的，就是不支持Logback1.3，你能奈他何
  • SpringBoot+ Sharding Sphere 轻松实现数据库字段加解密
  • Spring MVC 中视图的实现原理，在Spring MVC 中实现重定向和转发，以及访问静态资源 - Rainbow-Sea
  • Spring MVC 中 HttpMessageConverter 转换器 - Rainbow-Sea
  • SpringBoot+mail 轻松实现各类邮件自动推送
  • Spring MVC 获取三个域(request请求域，session 会话域，application 应用域)对象的方式 - Rainbow-Sea
  • SpringBoot3整合SpringDoc实现在线接口文档

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号