Skip to content

feat:support setting load balancing strategy per service. #1516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat:support setting load balancing strategy per service. #1516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions ...va/org/springframework/cloud/loadbalancer/annotation/LoadBalancerClientConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.cloud.client.discovery.ReactiveDiscoveryClient;
import org.springframework.cloud.loadbalancer.core.RandomLoadBalancer;
import org.springframework.cloud.loadbalancer.core.ReactorLoadBalancer;
import org.springframework.cloud.loadbalancer.core.RetryAwareServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.core.RoundRobinLoadBalancer;
Expand Down Expand Up @@ -59,6 +60,7 @@
* @author BaoLin Zhu
* @author changjin wei(魏昌进)
* @author Zhuozhi Ji
* @author Haotian Zhang
*/
@Configuration(proxyBeanMethods = false)
@ConditionalOnDiscoveryEnabled
Expand All @@ -68,13 +70,24 @@ public class LoadBalancerClientConfiguration {

@Bean
@ConditionalOnMissingBean
@Conditional(DefaultStrategyCondition.class)
public ReactorLoadBalancer<ServiceInstance> reactorServiceInstanceLoadBalancer(Environment environment,
LoadBalancerClientFactory loadBalancerClientFactory) {
String name = environment.getProperty(LoadBalancerClientFactory.PROPERTY_NAME);
return new RoundRobinLoadBalancer(
loadBalancerClientFactory.getLazyProvider(name, ServiceInstanceListSupplier.class), name);
}

@Bean
@ConditionalOnMissingBean
@Conditional(RandomStrategyCondition.class)
public ReactorLoadBalancer<ServiceInstance> randomLoadBalancer(Environment environment,
LoadBalancerClientFactory loadBalancerClientFactory) {
String name = environment.getProperty(LoadBalancerClientFactory.PROPERTY_NAME);
return new RandomLoadBalancer(
loadBalancerClientFactory.getLazyProvider(name, ServiceInstanceListSupplier.class), name);
}

@Configuration(proxyBeanMethods = false)
@ConditionalOnReactiveDiscoveryEnabled
@Order(REACTIVE_SERVICE_INSTANCE_SUPPLIER_ORDER)
Expand Down Expand Up @@ -309,6 +322,26 @@ public ServiceInstanceListSupplier retryAwareDiscoveryClientServiceInstanceListS

}

static class DefaultStrategyCondition implements Condition {

@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
return LoadBalancerEnvironmentPropertyUtils.equalToForClientOrDefault(context.getEnvironment(),
"strategies", "default");
}

}

static class RandomStrategyCondition implements Condition {

@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
return LoadBalancerEnvironmentPropertyUtils.equalToForClientOrDefault(context.getEnvironment(),
"strategies", "random");
}

}

static final class BlockingOnAvoidPreviousInstanceAndRetryEnabledCondition extends AllNestedConditions {

private BlockingOnAvoidPreviousInstanceAndRetryEnabledCondition() {
Expand Down
22 changes: 22 additions & 0 deletions ...g/springframework/cloud/loadbalancer/annotation/LoadBalancerClientConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,11 @@
import org.springframework.cloud.loadbalancer.core.DelegatingServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.core.DiscoveryClientServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.core.HealthCheckServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.core.RandomLoadBalancer;
import org.springframework.cloud.loadbalancer.core.ReactorLoadBalancer;
import org.springframework.cloud.loadbalancer.core.RequestBasedStickySessionServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.core.RetryAwareServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.core.RoundRobinLoadBalancer;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.core.WeightedServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.core.ZonePreferenceServiceInstanceListSupplier;
Expand All @@ -54,6 +57,7 @@
*
* @author Olga Maciaszek-Sharma
* @author Zhuozhi Ji
* @author Haotian Zhang
*/
class LoadBalancerClientConfigurationTests {

Expand Down Expand Up @@ -221,6 +225,24 @@ void shouldInstantiateBlockingWeightedServiceInstanceListSupplier() {
});
}

@Test
void shouldInstantiateRoundRobinLoadBalancer() {
blockingDiscoveryClientRunner.withPropertyValues("spring.cloud.loadbalancer.strategies=default")
.run(context -> {
ReactorLoadBalancer<?> reactorLoadBalancer = context.getBean(ReactorLoadBalancer.class);
then(reactorLoadBalancer).isInstanceOf(RoundRobinLoadBalancer.class);
});
}

@Test
void shouldInstantiateRandomLoadBalancer() {
blockingDiscoveryClientRunner.withPropertyValues("spring.cloud.loadbalancer.strategies=random")
.run(context -> {
ReactorLoadBalancer<?> reactorLoadBalancer = context.getBean(ReactorLoadBalancer.class);
then(reactorLoadBalancer).isInstanceOf(RandomLoadBalancer.class);
});
}

private static Stream<Arguments> blockingConfigurations() {
return Stream.of(Arguments.of(RestTemplateTestConfig.class), Arguments.of(RestClientTestConfig.class),
Arguments.of(RestTemplateAndRestClientConfig.class));
Expand Down