更改 spring cloud loadbalancer 默认 RoundRobin 算法

Question

我正在尝试从 Ribbon 迁移到 Spring Cloud LoadBalancer，因为 Ribbon 现在处于维护模式，并且我无法使用默认的 spring-boot 2.4.2 版本在 spring 初始化中添加 Ribbon 依赖项。我目前正在使用 OpenFeign，并且正在做一些测试，试图将默认的 RoundRobin 负载均衡器配置更改为随机规则。这就是我所拥有的

使用 Ribbon 时，我只需要更改默认配置

@Configuration
public class RibbonConfiguration {

    @Bean
    public IRule loadBalancingRule() {
//        return new RoundRobinRule();
        return new RandomRule();
    }

}

并在客户端添加注解@RibbonClient（也可以在MainApplication类中添加）

@FeignClient("first-service")
@RibbonClient(name = "first-service", configuration = RibbonConfiguration.class)
public interface HelloClient {
    @GetMapping("/hello")
    String hello();
}

但我无法使用 spring-cloud-loadbalancer 使其工作。我知道默认情况下包含在 spring-cloud-starter-openfeign 依赖项中，所以我的 pom 是这样的

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.demo</groupId>
    <artifactId>edge-service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>edge-service</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>11</java.version>
        <spring-cloud.version>2020.0.1</spring-cloud.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

拥有这样的 FeignClients（没有任何 Ribbon 注释）

@FeignClient("first-service")
public interface HelloClient {
    @GetMapping("/hello")
    String hello();
}

@FeignClient("second-service")
public interface WorldClient {
    @GetMapping("/world")
    String world();
}

我的 RestController 是这样的

@RestController
public class HelloWorldController {
    @Autowired
    private HelloClient helloClient;
    @Autowired
    private WorldClient worldClient;

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    
    @GetMapping("/hello-world")
    public String helloWorld() {
        logger.info("Calling the clients");
        return helloClient.hello() + " - " + worldClient.world();
    }
}

没有做任何其他事情，它似乎可以工作负载平衡（两个 hello-service 实例仍在运行并且正在调用备用），但我想将默认负载平衡器算法（RoundRobin）更改为另一个（如随机或任何人）自定义）来测试差异。我想我必须更改 FeignConfiguration 类中的某些内容，但我搜索没有成功。

希望您能帮助我，这样我就可以摆脱 Ribbon 并毫无问题地开始使用 Spring Cloud LoadBalancer ！ :C

Answer 1

我认为您只需要创建类型为 ReactorServiceInstanceLoadBalancer 的 bean，它将用于代替默认的 RoundRobin bean。

@Configuration
public class LoadBalancingConfiguration {

    @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);
    }

}

上面的例子是从 spring-cloud-loadbalancer 项目的 LoadBalancerClientConfiguration 类中的默认 bean 创建复制而来的

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

我目前正在尝试弄清楚这一切是如何工作的，这样我就可以获取负载平衡代码，以便在不需要发现服务器的情况下使用wiremock 服务器进行测试。但是，我没有找到太多有用的文档来解释如何从 Ribbon 迁移到 Spring 负载均衡器。

以下内容可以让我在测试中使用wiremock。假设我有wiremock服务器在本地运行并监听端口9999。

@Bean
public RoundRobinLoadBalancer loadBalancer() {
  DefaultServiceInstance wiremock = new DefaultServiceInstance("", "", "localhost", 9999, false);
  return new RoundRobinLoadBalancer(ServiceInstanceListSuppliers.toProvider("", wiremock), "");
}

Answer 2

功能区配置不适用于 Spring Cloud LoadBalancer。如果你添加 spring-cloud-starter-loadbalancer，默认的 RoundRobin bean 会为你创建，所以你不需要设置它。但是，如果您想切换到随机算法，则需要添加 bean 以覆盖默认配置，如下所示：

public class CustomLoadBalancerConfiguration {

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

您可以阅读更多关于它的信息here。

一旦您添加了新 bean 的 LoadBalancer 配置类，您就可以设置您的客户端使用 @LoadBalancerClient 或 @LoadBalancerClients 注释。你可以详细阅读如何做到这一点in the docs。