如何使用 Spring Cloud 2020 中重磅推荐的负载均衡器 Spring Cloud LoadBalancer （下文简称 SCL），如何扩展负载均衡策略？ 你将从本文中获取到答案
快速上手 SCL
-
如果项目中想使用 SCL，则仅需要添加如下 maven 依赖即可
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-loadbalancer</artifactId> </dependency> -
SCL 是构建服务发现的基础上，由于目前 Spring Cloud Alibaba 并未兼容 SCL （具体兼容方案可以参考 pig），当然你可以选择使用Eureka 测试。
-
若将 RestTemplate 和 客户端负载均衡结合使用，在 bean 定义上增加
@LoadBalanced注解即可.@Bean @LoadBalanced public RestTemplate restTemplate() { return new RestTemplate(); }
个性化负载均衡策略
-
目前版本 （spring cloud 2020） 内置轮询、随机的负载均衡策略，默认轮询策略。
-
当然可以通过
LoadBalancerClient注解，指定服务级别的负载均衡策略@LoadBalancerClient(value = "demo-provider", configuration = RandomLoadbalancerConfig.class)
public class RandomLoadbalancerConfig { @Bean public ReactorLoadBalancer<ServiceInstance> reactorServiceInstanceLoadBalancer(Environment environment, LoadBalancerClientFactory loadBalancerClientFactory) { String name = environment.getProperty(LoadBalancerClientFactory.PROPERTY_NAME); return new RandomLoadBalancer( loadBalancerClientFactory.getLazyProvider(name, ServiceInstanceListSupplier.class), name); } }
自定义负载均衡策略
-
通过上文可知，目前 SCL 支持的负载均衡策略相较于
Ribbon还是较少，需要开发者自行实现，好在 SCL 提供了便捷的 API 方便扩展使用。 这里演示自定义一个基于注册中心元数据的灰度负载均衡策略。 -
定义灰度负载均衡策略
@Slf4j public class GrayRoundRobinLoadBalancer extends RoundRobinLoadBalancer {
1private ObjectProvider<ServiceInstanceListSupplier> serviceInstanceListSupplierProvider; 2 3private String serviceId; 4 5@Override 6public Mono<Response<ServiceInstance>> choose(Request request) { 7 ServiceInstanceListSupplier supplier = serviceInstanceListSupplierProvider 8 .getIfAvailable(NoopServiceInstanceListSupplier::new); 9 return supplier.get(request).next().map(serviceInstances -> getInstanceResponse(serviceInstances, request)); 10} 11 12Response<ServiceInstance> getInstanceResponse(List<ServiceInstance> instances, Request request) { 13 14 // 注册中心无可用实例 抛出异常 15 if (CollUtil.isEmpty(instances)) { 16 log.warn("No instance available {}", serviceId); 17 return new EmptyResponse(); 18 } 19 20 DefaultRequestContext requestContext = (DefaultRequestContext) request.getContext(); 21 RequestData clientRequest = (RequestData) requestContext.getClientRequest(); 22 HttpHeaders headers = clientRequest.getHeaders(); 23 24 String reqVersion = headers.getFirst(CommonConstants.VERSION); 25 if (StrUtil.isBlank(reqVersion)) { 26 return super.choose(request).block(); 27 } 28 29 // 遍历可以实例元数据，若匹配则返回此实例 30 for (ServiceInstance instance : instances) { 31 NacosServiceInstance nacosInstance = (NacosServiceInstance) instance; 32 Map<String, String> metadata = nacosInstance.getMetadata(); 33 String targetVersion = MapUtil.getStr(metadata, CommonConstants.VERSION); 34 if (reqVersion.equalsIgnoreCase(targetVersion)) { 35 log.debug("gray requst match success :{} {}", reqVersion, nacosInstance); 36 return new DefaultResponse(nacosInstance); 37 } 38 } 39 // 降级策略，使用轮询策略 40 return super.choose(request).block(); 41}}
-
针对客户端注入灰度负载均衡策略
@LoadBalancerClient(value = "demo-provider", configuration = GrayRoundLoadbalancerConfig.class)
-
服务实例定义版本号
-
请求携带版本号，测试使用
curl --location --request GET 'http://localhost:6060/req?key=b'
--header 'VERSION: b'
优化负载均衡策略注入
- 如上文所述，所有的个性化负载策略都需要手动通过
LoadBalancerClient注入非常的不方便。 我们可以参考LoadBalancerClients的批量注入逻辑构造自己的 BeanRegistrar
1public class GrayLoadBalancerClientConfigurationRegistrar implements ImportBeanDefinitionRegistrar { 2 3 @Override 4 public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { 5 Field[] fields = ReflectUtil.getFields(ServiceNameConstants.class); 6 7 // 遍历服务名称，注入支持灰度策略的负载均衡器 8 for (Field field : fields) { 9 Object fieldValue = ReflectUtil.getFieldValue(ServiceNameConstants.class, field); 10 registerClientConfiguration(registry, fieldValue, GrayLoadBalancerClientConfiguration.class); 11 } 12 } 13}