SpringCloud自界说loadbalancer实现标签路由

一、配景

  近来前端反应开发环境有时间调接口会很慢，原因是有开发图方便将本地服务注册到开发环境，请求路由到开发本地导致，
为了解决该问题想到可以通过标签路由的方式克制该问题，实现前端联调和开发自测互不干扰。
  该方案除了用于本地调试，还可以用于用户灰度发布。
二、实现方案

  关于负载均衡，低版本的SpringCloud用的是Spring Cloud Ribbon，高版本用Spring Cloud LoadBalancer替换了，
Ribbon可以通过实现IRlue接口实现，这里只先容高版本的实现方案。
实现方案：

• idea在环境变量中设置tag，本地服务启动时读取环境变量将tag注册到nacos的元数据
  
• 重写网关的负载均衡算法，从请求头中获取到的request-tag和服务实例的元数据进行匹配，如果匹配到则返回对应的
  服务实例，否则提示服务未找到。
  

三、编码实现

3.1 order服务

新建一个SpringCloud服务order-service，注册元数据很简单，只需要清除掉NacosDiscoveryClientConfiguration，再写一个自己的NacosDiscoveryClientConfiguration设置类即可。
创建MyNacosDiscoveryClientConfiguration

1. /**
2. * @Author: Ship
3. * @Description:
4. * @Date: Created in 2025/2/12
5. */
6. @Configuration(
7.         proxyBeanMethods = false
8. )
9. @ConditionalOnDiscoveryEnabled
10. @ConditionalOnBlockingDiscoveryEnabled
11. @ConditionalOnNacosDiscoveryEnabled
12. @AutoConfigureBefore({SimpleDiscoveryClientAutoConfiguration.class, CommonsClientAutoConfiguration.class})
13. @AutoConfigureAfter({NacosDiscoveryAutoConfiguration.class})
14. public class MyNacosDiscoveryClientConfiguration {
18.     @Bean
19.     public DiscoveryClient nacosDiscoveryClient(NacosServiceDiscovery nacosServiceDiscovery) {
20.         return new NacosDiscoveryClient(nacosServiceDiscovery);
21.     }
23.     @Bean
24.     @ConditionalOnProperty(
25.             value = {"spring.cloud.nacos.discovery.watch.enabled"},
26.             matchIfMissing = true
27.     )
28.     public NacosWatch nacosWatch(NacosServiceManager nacosServiceManager, NacosDiscoveryProperties nacosDiscoveryProperties,
29.                                  ObjectProvider<ThreadPoolTaskScheduler> taskExecutorObjectProvider, Environment environment) {
30.         // 环境变量读取标签
31.         String tag = environment.getProperty("tag");
32.         nacosDiscoveryProperties.getMetadata().put("request-tag", tag);
33.         return new NacosWatch(nacosServiceManager, nacosDiscoveryProperties, taskExecutorObjectProvider);
34.     }
35. }

复制代码

这里代码基本与NacosDiscoveryClientConfiguration一致，只是加上了设置元数据的逻辑。

1. @SpringBootApplication(exclude = NacosDiscoveryClientConfiguration.class)
2. public class OrderApplication {
4.     public static void main(String[] args) {
5.         SpringApplication.run(OrderApplication.class, args);
6.     }
8. }

复制代码

启动类上需要清除默认的NacosDiscoveryClientConfiguration，不然启动会报bean重复注册的错误，或者设置添加spring.main.allow-bean-definition-overriding=true允许重复注册也行。
写一个测试接口，方便背面测试

1. /**
2. * @Author: Ship
3. * @Description:
4. * @Date: Created in 2025/2/12
5. */
6. @RequestMapping("test")
7. @RestController
8. public class TestController {
11.     @GetMapping("")
12.     public String sayHello(){
13.         return "hello";
14.     }
15. }

复制代码

3.2 gateway服务

新建一个网关服务，pom文件如下：

1. <properties>
2.         <java.version>1.8</java.version>
3.         <spring-cloud.version>2020.0.3</spring-cloud.version>
4.         <spring-cloud-alibaba.version>2021.1</spring-cloud-alibaba.version>
5.         <spring-boot.version>2.5.1</spring-boot.version>
6.         <maven-compiler-plugin.version>3.1</maven-compiler-plugin.version>
7.     </properties>
8.     <dependencies>
9.         <dependency>
10.             <groupId>org.springframework.boot</groupId>
11.             <artifactId>spring-boot-starter-web</artifactId>
12.         </dependency>
13.         <dependency>
14.             <groupId>org.springframework.cloud</groupId>
15.             <artifactId>spring-cloud-starter-loadbalancer</artifactId>
16.         </dependency>
17.         <dependency>
18.             <groupId>org.springframework.cloud</groupId>
19.             <artifactId>spring-cloud-starter-openfeign</artifactId>
20.         </dependency>
22.         <dependency>
23.             <groupId>org.springframework.boot</groupId>
24.             <artifactId>spring-boot-starter-test</artifactId>
25.             <version>${spring-boot.version}</version>
26.             <scope>test</scope>
27.         </dependency>
29.         <dependency>
30.             <groupId>org.springframework.boot</groupId>
31.             <artifactId>spring-boot-starter</artifactId>
32.             <version>${spring-boot.version}</version>
33.         </dependency>
35.         <dependency>
36.             <groupId>com.alibaba.cloud</groupId>
37.             <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
38.             <version>${spring-cloud-alibaba.version}</version>
39.         </dependency>
41.         <dependency>
42.             <groupId>com.alibaba.cloud</groupId>
43.             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
44.             <version>${spring-cloud-alibaba.version}</version>
45.         </dependency>
46.     </dependencies>
47.     <dependencyManagement>
48.         <dependencies>
49.             <dependency>
50.                 <groupId>org.springframework.cloud</groupId>
51.                 <artifactId>spring-cloud-dependencies</artifactId>
52.                 <version>${spring-cloud.version}</version>
53.                 <type>pom</type>
54.                 <scope>import</scope>
55.             </dependency>
57.             <dependency>
58.                 <groupId>org.springframework.boot</groupId>
59.                 <artifactId>spring-boot-dependencies</artifactId>
60.                 <version>${spring-boot.version}</version>
61.                 <type>pom</type>
62.                 <scope>import</scope>
63.             </dependency>
65.             <dependency>
66.                 <groupId>org.springframework.cloud</groupId>
67.                 <artifactId>spring-cloud-starter-bootstrap</artifactId>
68.             </dependency>
69.         </dependencies>
72.     </dependencyManagement>
74.     <build>
75.         <plugins>
76.             <plugin>
77.                 <artifactId>maven-compiler-plugin</artifactId>
78.                 <version>${maven-compiler-plugin.version}</version>
79.                 <configuration>
80.                     <source>${java.version}</source>
81.                     <target>${java.version}</target>
82.                 </configuration>
83.             </plugin>
84.             <plugin>
85.                 <groupId>org.springframework.boot</groupId>
86.                 <artifactId>spring-boot-maven-plugin</artifactId>
87.             </plugin>
88.         </plugins>
89.     </build>

复制代码

Spring-Cloud-loadBalancer默认使用轮询的算法，即org.springframework.cloud.loadbalancer.core.RoundRobinLoadBalancer类实现，因此可以参考RoundRobinLoadBalancer实现一个TagLoadBalancer，代码如下：

1. /**
2. * @Author: Ship
3. * @Description:
4. * @Date: Created in 2025/2/12
5. */
6. public class TagLoadBalancer implements ReactorServiceInstanceLoadBalancer {
8.     private static final String TAG_HEADER = "request-tag";
10.     private static final Log log = LogFactory.getLog(TagLoadBalancer.class);
11.     final AtomicInteger position;
12.     final String serviceId;
13.     ObjectProvider<ServiceInstanceListSupplier> serviceInstanceListSupplierProvider;
15.     public TagLoadBalancer(ObjectProvider<ServiceInstanceListSupplier> serviceInstanceListSupplierProvider, String serviceId) {
16.         this(serviceInstanceListSupplierProvider, serviceId, (new Random()).nextInt(1000));
17.     }
19.     public TagLoadBalancer(ObjectProvider<ServiceInstanceListSupplier> serviceInstanceListSupplierProvider, String serviceId, int seedPosition) {
20.         this.serviceId = serviceId;
21.         this.serviceInstanceListSupplierProvider = serviceInstanceListSupplierProvider;
22.         this.position = new AtomicInteger(seedPosition);
23.     }
25.     @Override
26.     public Mono<Response<ServiceInstance>> choose(Request request) {
27.         ServiceInstanceListSupplier supplier = (ServiceInstanceListSupplier) this.serviceInstanceListSupplierProvider.getIfAvailable(NoopServiceInstanceListSupplier::new);
28.         return supplier.get(request).next().map((serviceInstances) -> {
29.             return this.processInstanceResponse(supplier, serviceInstances, request);
30.         });
31.     }
33.     private Response<ServiceInstance> processInstanceResponse(ServiceInstanceListSupplier supplier, List<ServiceInstance> serviceInstances, Request request) {
34.         Response<ServiceInstance> serviceInstanceResponse = this.getInstanceResponse(serviceInstances, request);
35.         if (supplier instanceof SelectedInstanceCallback && serviceInstanceResponse.hasServer()) {
36.             ((SelectedInstanceCallback) supplier).selectedServiceInstance((ServiceInstance) serviceInstanceResponse.getServer());
37.         }
39.         return serviceInstanceResponse;
40.     }
42.     private Response<ServiceInstance> getInstanceResponse(List<ServiceInstance> instances, Request request) {
43.         if (instances.isEmpty()) {
44.             if (log.isWarnEnabled()) {
45.                 log.warn("No servers available for service: " + this.serviceId);
46.             }
47.             return new EmptyResponse();
48.         }
49.         if (request instanceof DefaultRequest) {
50.             DefaultRequest<RequestDataContext> defaultRequest = (DefaultRequest) request;
51.             // 上下文获取请求头
52.             HttpHeaders headers = defaultRequest.getContext().getClientRequest().getHeaders();
53.             List<String> list = headers.get(TAG_HEADER);
54.             if (!CollectionUtils.isEmpty(list)) {
55.                 String requestTag = list.get(0);
56.                 for (ServiceInstance instance : instances) {
57.                     String str = instance.getMetadata().getOrDefault(TAG_HEADER, "");
58.                     if (requestTag.equals(str)) {
59.                         return new DefaultResponse(instance);
60.                     }
61.                 }
62.                 log.error(String.format("No servers available for service:%s,tag:%s ", this.serviceId, requestTag));
63.                 return new EmptyResponse();
64.             }
65.         }
67.         int pos = Math.abs(this.position.incrementAndGet());
68.         ServiceInstance instance = instances.get(pos % instances.size());
69.         return new DefaultResponse(instance);
70.     }
71. }

复制代码

这里需要实现ReactorServiceInstanceLoadBalancer接口，如果请求头带有标签则根据标签路由，否则使用默认的轮询算法。
还要把TagLoadBalancer用起来，所以需要界说一个设置类TagLoadBalancerConfig，并通过@LoadBalancerClients注解添加默认设置，代码如下：

1. /**
2. * @Author: Ship
3. * @Description:
4. * @Date: Created in 2025/2/12
5. */
6. public class TagLoadBalancerConfig {
8.     @Bean
9.     public ReactorLoadBalancer reactorTagLoadBalancer(Environment environment, LoadBalancerClientFactory loadBalancerClientFactory) {
10.         String name = environment.getProperty(LoadBalancerClientFactory.PROPERTY_NAME);
11.         return new TagLoadBalancer(loadBalancerClientFactory.getLazyProvider(name, ServiceInstanceListSupplier.class), name);
12.     }
13. }
15. @LoadBalancerClients(defaultConfiguration = {TagLoadBalancerConfig.class})
16. @SpringBootApplication
17. public class GatewayApplication {
19.     public static void main(String[] args) {
20.         SpringApplication.run(GatewayApplication.class, args);
21.     }
23. }

复制代码

最后在application.yml文件添加网关路由设置

1. spring:
2.   application:
3.     name: gateway
4.   cloud:
5.     nacos:
6.       config:
7.         server-addr: 127.0.0.1:8848
8.         namespace: dev
9.         group: DEFAULT_GROUP
10.       discovery:
11.         server-addr: 127.0.0.1:8848
12.         namespace: dev
13.     gateway:
14.       routes:
15.         - id: order-service
16.           uri: lb://order-service
17.           predicates:
18.             - Path=/order/**
19.           filters:
20.             - StripPrefix=1
21. server:
22.   port: 9000

复制代码

3.3 代码测试

• 本地启动nacos后启动order（注意需要在idea设置环境变量tag=ship）和gateway服务，可以看到order服务已经成功注册了元数据
  
  
  
  
• 然后用Postman请求网关http://localhost:9000/order/test
  

可以看到请求成功路由到了order服务，说明根据tag路由成功了。

• 去掉环境变量tag后重新启动Order服务，再次请求相应报文如下：
  1. {
  2.     "timestamp": "2025-02-14T12:10:44.294+00:00",
  3.     "path": "/order/test",
  4.     "status": 503,
  5.     "error": "Service Unavailable",
  6.     "requestId": "41651188-4"
  7. }

  复制代码

说明根据requst-tag找不到对应的服务实例，代码逻辑生效了。
四、总结


  聪明的人已经发现了，本文只实现了网关路由到下游服务这部分的标签路由，下游服务A调服务B的标签路由并未实现，实在现方案也不难，只需要通过上下文通报+feign拦截器就可以做到全链路的标签路由，有兴趣的可以自己试试。

  本文代码已上传github，趁便推广下前段时间写的idea插件CodeFaster（快速生成常用流操作的代码，Marketplace搜索下载即可体验）
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。