SpringCloud（第 007 篇）電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略

SpringCloud（第 007 篇）電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略






一、大致介紹


1、通過 RibbonClient 注解來設置隨機調度算法方式；
2、通過 restTemplate.getForObject、loadBalancerClient.choose 兩種代碼調用方式來測試客戶端負載均衡算法；


二、實現步驟


2.1 添加 maven 引用包


<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

	<artifactId>springms-consumer-movie-ribbon-custom</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>
	
    <parent>
		<groupId>com.springms.cloud</groupId>
		<artifactId>springms-spring-cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
	
	<dependencies>
        <!-- web模塊 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

        <!-- 客戶端發現模塊 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>

        <!-- 監控和管理生產環境的模塊 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>

</project>


2.2 添加應用配置文件（springms-consumer-movie-ribbon-custom\src\main\resources\application.yml）


spring:
  application:
    name: springms-consumer-movie-ribbon-custom
server:
  port: 8020
#做負載均衡的時候，不需要這個動態配置的地址
#user:
#  userServicePath: http://localhost:7900/simple/
eureka:
  client:
#    healthcheck:
#      enabled: true
    serviceUrl:
      defaultZone: http://admin:admin@localhost:8761/eureka
  instance:
    prefer-ip-address: true
    instance-id: ${spring.application.name}:${spring.cloud.client.ipAddress}:${spring.application.instance_id:${server.port}}


2.3 添加實體用戶類User（springms-consumer-movie-ribbon-custom\src\main\java\com\springms\cloud\entity\User.java）


package com.springms.cloud.entity;

import java.math.BigDecimal;

public class User {

    private Long id;

    private String username;

    private String name;

    private Short age;

    private BigDecimal balance;

    public Long getId() {
        return this.id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUsername() {
        return this.username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Short getAge() {
        return this.age;
    }

    public void setAge(Short age) {
        this.age = age;
    }

    public BigDecimal getBalance() {
        return this.balance;
    }

    public void setBalance(BigDecimal balance) {
        this.balance = balance;
    }

}


2.4 添加 RibbonClient 配置類01（springms-consumer-movie-ribbon-custom\src\main\java\com\springms\cloud\config\TestConfigurationInside2ScanPackage.java）


package com.springms.cloud.config;

import com.netflix.loadbalancer.RoundRobinRule;
import com.springms.cloud.ExcludeFromComponentScan;
import com.netflix.loadbalancer.IRule;
import com.netflix.loadbalancer.RandomRule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 測試定制 Ribbon ,而且該定制的配置文件是在應用掃描的目錄里面，也就是說應用啟動后該文件會被掃描到。
 *
 * RibbonClient 中的 name 名稱，一定要是 eureka 服務中注冊的名稱。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/17
 *
 */
@Configuration
@ExcludeFromComponentScan
public class TestConfigurationInside2ScanPackage {

    /**
     * 采用隨機分配的策略。
     *
     * @return
     */
    @Bean
    public IRule ribbonRule(){
        return new RandomRule();
        //return new RoundRobinRule();
    }
}


2.5 添加 RibbonClient 配置類02（springms-consumer-movie-ribbon-custom\src\main\java\com\springms\config\TestConfigurationOutsideScanPackage.java）


package com.springms.config;

import com.netflix.loadbalancer.IRule;
import com.netflix.loadbalancer.RandomRule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 測試定制 Ribbon ,而且該定制的配置文件是不在應用掃描的目錄里面，也就是說應用啟動后該文件不會被掃描到。
 *
 * RibbonClient 中的 name 名稱，一定要是 eureka 服務中注冊的名稱。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/17
 *
 */
@Configuration
public class TestConfigurationOutsideScanPackage {

//    @Autowired
//    IClientConfig config;
//
//    /**
//     *
//     * 添加這個 Bean 的注解，主要是因為定義 config 的時候報錯，也就是說明 config 沒有被實例化。
//     *
//     */
//    @Bean
//    public IClientConfig config(){
//        return new DefaultClientConfigImpl();
//    }

    /**
     * 采用隨機分配的策略。
     *
     * @return
     */
    @Bean
    public IRule ribbonRule(){
        return new RandomRule();
    }
}


2.6 添加 RibbonClient 配置類03（springms-consumer-movie-ribbon-custom\src\main\java\com\springms\cloud\TestConfigurationInsideScanPackage.java）


package com.springms.cloud;

import com.netflix.loadbalancer.IRule;
import com.netflix.loadbalancer.RandomRule;
import com.netflix.loadbalancer.RoundRobinRule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 測試定制 Ribbon ,而且該定制的配置文件是在應用掃描的目錄里面，也就是說應用啟動后該文件會被掃描到。
 *
 * RibbonClient 中的 name 名稱，一定要是 eureka 服務中注冊的名稱。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/17
 *
 */
@Configuration
@ExcludeFromComponentScan
public class TestConfigurationInsideScanPackage {

    /**
     * 采用隨機分配的策略。
     *
     * @return
     */
    @Bean
    public IRule ribbonRule(){
        // return new RoundRobinRule();
        return new RandomRule();
    }
}


2.7 添加注解，目的就是讓應用啟動后，含有該注解的文件不會被應用掃描到（springms-consumer-movie-ribbon-custom\src\main\java\com\springms\cloud\ExcludeFromComponentScan.java）


package com.springms.cloud;

/**
 * 添加該注解，目的就是讓應用啟動后，含有該注解的文件不會被應用掃描到。
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/17
 *
 */
public @interface ExcludeFromComponentScan {

}


2.8 添加Web訪問層Controller（springms-consumer-movie-ribbon-custom\src\main\java\com\springms\cloud\controller\MovieCustomRibbonController.java）


package com.springms.cloud.controller;

import com.springms.cloud.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.loadbalancer.LoadBalancerClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
public class MovieCustomRibbonController {

    @Autowired
    private RestTemplate restTemplate;

    @Autowired
    private LoadBalancerClient loadBalancerClient;

    @GetMapping("/movie/{id}")
    public User findById(@PathVariable Long id) {
        // http://localhost:7900/simple/
        // VIP：virtual IP
        // HAProxy Heartbeat

        return this.restTemplate.getForObject("http://springms-provider-user/simple/" + id, User.class);
    }

    @GetMapping("/choose")
    public String test() {
        ServiceInstance serviceInstance = this.loadBalancerClient.choose("springms-provider-user");
        System.out.println("00000" + ":" + serviceInstance.getServiceId() + ":" + serviceInstance.getHost() + ":" + serviceInstance.getPort());

        ServiceInstance serviceInstance2 = this.loadBalancerClient.choose("springms-provider-user2");
        System.out.println("222222222222222222" + ":" + serviceInstance2.getServiceId() + ":" + serviceInstance2.getHost() + ":" + serviceInstance2.getPort());

        return "choose successful";
    }
}


2.9 添加電影微服務啟動類（springms-consumer-movie-ribbon-custom\src\main\java\com\springms\cloud\MsConsumerMovieCustomRibbonApplication.java）


package com.springms.cloud;

import com.springms.cloud.config.TestConfigurationInside2ScanPackage;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.ribbon.RibbonClient;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.FilterType;
import org.springframework.web.client.RestTemplate;

/**
 * 電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略。
 *
 * LoadBalanced：該負載均衡注解，已經整合了 Ribbon；
 *
 * Ribbon 的默認負載均衡的算法為：輪詢；
 *
 * @author hmilyylimh
 *
 * @version 0.0.1
 *
 * @date 2017/9/17
 *
 */
@SpringBootApplication
@EnableEurekaClient
@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationInsideScanPackage.class)
@ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.ANNOTATION, value = ExcludeFromComponentScan.class) })
public class MsConsumerMovieCustomRibbonApplication {

	@Bean
	@LoadBalanced
	public RestTemplate restTemplate(){
		return new RestTemplate();
	}

	public static void main(String[] args) {
		SpringApplication.run(MsConsumerMovieCustomRibbonApplication.class, args);
		System.out.println("【【【【【【 電影微服務-定制Ribbon 】】】】】】已啟動.");
	}
}


三、測試


/****************************************************************************************
 一、電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略（測試輪詢分配服務器地址 TestConfigurationOutsideScanPackage））：

 1、使用注解：@SpringBootApplication、@EnableEurekaClient；
 2、使用注解：@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationOutsideScanPackage.class)
 3、TestConfigurationInsideScanPackage 類中采用 RoundRobinRule 輪詢調度算法；
 4、啟動 springms-provider-user 模塊服務，啟動3個端口（7900、7899、7898）；
 5、啟動 springms-consumer-movie-ribbon-custom 模塊服務，啟動1個端口；
 6、在瀏覽器輸入地址http://localhost:8020/movie/2，然后看看 springms-provider-user 的三個端口的服務打印的信息是否均勻，正常情況下應該是輪詢打印；

 總結：客戶端之所以會輪詢調用各個微服務，是因為在 TestConfigurationOutsideScanPackage 類中配置了負載均衡調度算法：輪詢 RoundRobinRule 策略算法；
 ****************************************************************************************/

/****************************************************************************************
 二、電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略（測試輪詢分配服務器地址 TestConfigurationInsideScanPackage）：

 1、使用注解：@SpringBootApplication、@EnableEurekaClient；
 2、使用注解：@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationInsideScanPackage.class)
 3、使用注解：@ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.ANNOTATION, value = ExcludeFromComponentScan.class) })
 4、TestConfigurationInsideScanPackage 類中采用 RoundRobinRule 輪詢調度算法；
 5、啟動 springms-provider-user 模塊服務，啟動3個端口（7900、7899、7898）；
 6、啟動 springms-consumer-movie-ribbon-custom 模塊服務，啟動1個端口；
 7、在瀏覽器輸入地址http://localhost:8020/movie/2，然后看看 springms-provider-user 的三個端口的服務打印的信息是否均勻，正常情況下應該是輪詢打印；

 總結一：客戶端之所以會輪詢分配調用各個微服務，是因為在注解方面采用了注解 ComponentScan 使配置文件 TestConfigurationOutsideScanPackage 不被掃描到，然后再結合 TestConfigurationOutsideScanPackage 類中配置了負載均衡調度算法：輪詢 RoundRobinRule 策略算法；
 總結二：可以發現規律，當使用 “restTemplate.getForObject("http://springms-provider-user/simple/" + id, User.class)” 這種方式負載均衡調用各個微服務跟配置文件 TestConfigurationOutsideScanPackage 在哪里沒有關系；
 ****************************************************************************************/

/****************************************************************************************
 三、電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略（測試隨機分配服務器地址 TestConfigurationOutsideScanPackage））：

 1、使用注解：@SpringBootApplication、@EnableEurekaClient；
 2、使用注解：@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationOutsideScanPackage.class)
 3、TestConfigurationInsideScanPackage 類中采用 RandomRule 隨機調度算法；
 4、啟動 springms-provider-user 模塊服務，啟動3個端口（7900、7899、7898）；
 5、啟動 springms-consumer-movie-ribbon-custom 模塊服務，啟動1個端口；
 6、在瀏覽器輸入地址http://localhost:8020/movie/2，然后看看 springms-provider-user 的三個端口的服務打印的信息是否均勻，正常情況下應該是隨機打印；

 總結：客戶端之所以會隨機調用各個微服務，是因為在 TestConfigurationOutsideScanPackage 類中配置了負載均衡調度算法：隨機 RandomRule 策略算法；
 ****************************************************************************************/

/****************************************************************************************
 四、電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略（測試隨機分配服務器地址 TestConfigurationInsideScanPackage）：

 1、使用注解：@SpringBootApplication、@EnableEurekaClient；
 2、使用注解：@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationInsideScanPackage.class)
 3、使用注解：@ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.ANNOTATION, value = ExcludeFromComponentScan.class) })
 4、TestConfigurationInsideScanPackage 類中采用 RandomRule 隨機調度算法；
 5、啟動 springms-provider-user 模塊服務，啟動3個端口（7900、7899、7898）；
 6、啟動 springms-consumer-movie-ribbon-custom 模塊服務，啟動1個端口；
 7、在瀏覽器輸入地址http://localhost:8020/movie/2，然后看看 springms-provider-user 的三個端口的服務打印的信息是否均勻，正常情況下應該是隨機打印；

 總結一：客戶端之所以會輪詢分配調用各個微服務，是因為在注解方面采用了注解 ComponentScan 使配置文件 TestConfigurationOutsideScanPackage 不被掃描到，然后再結合 TestConfigurationOutsideScanPackage 類中配置了負載均衡調度算法：隨機 RandomRule 策略算法；
 總結二：可以發現規律，當使用 “restTemplate.getForObject("http://springms-provider-user/simple/" + id, User.class)” 這種方式負載均衡調用各個微服務跟配置文件 TestConfigurationOutsideScanPackage 在哪里沒有關系；

 總結三：由（測試一、測試二）和（測試三、測試四）對比可知，當使用 “restTemplate.getForObject("http://springms-provider-user/simple/" + id, User.class)” 這種方式負載均衡調用各個微服務不需要考慮配置文件的放在哪個包下面。
 ****************************************************************************************/

/****************************************************************************************
 五、電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略（測試自定義分配服務器地址 TestConfigurationInside2ScanPackage 調度方式）：

 1、使用注解：@SpringBootApplication、@EnableEurekaClient；
 2、使用注解：@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationInside2ScanPackage.class)
 3、使用注解：@ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.ANNOTATION, value = ExcludeFromComponentScan.class) })
 3、TestConfigurationInside2ScanPackage 類中采用 RoundRobinRule 輪詢調度算法；
 4、在 MovieCustomRibbonController 里面添加 test 方法來做測試；
 5、啟動 springms-provider-user 模塊服務，啟動3個端口（7900、7899、7898）；
 6、啟動 springms-provider-user2 模塊服務，啟動2個端口（7997、7996）（直接將用戶微服務 spring.application.name 改了個名字為 springms-provider-user2 再啟動而已）；
 7、啟動 springms-consumer-movie-ribbon-custom 模塊服務；

 8、在瀏覽器輸入地址http://localhost:8020/choose，然后看看 springms-provider-user、springms-provider-user2 的各個對應的端口的服務打印的信息是否均勻，正常情況下應該是輪詢分配打印的；

 總結：springms-provider-user（之所以輪詢是因為使用了 RibbonClient 配置采用 RoundRobinRule 輪詢調度算法）、springms-provider-user2（之所以輪詢是因為沒有任何配置，默認調度算法就是輪詢算法）；
 ****************************************************************************************/

/****************************************************************************************
 六、電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略（測試自定義分配服務器地址 TestConfigurationInside2ScanPackage 調度方式）：

 1、使用注解：@SpringBootApplication、@EnableEurekaClient；
 2、使用注解：@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationInside2ScanPackage.class)
 3、使用注解：@ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.ANNOTATION, value = ExcludeFromComponentScan.class) })
 3、TestConfigurationInside2ScanPackage 類中采用 RandomRule 隨機調度算法；
 4、在 MovieCustomRibbonController 里面添加 test 方法來做測試；
 5、啟動 springms-provider-user 模塊服務，啟動3個端口（7900、7899、7898）；
 6、啟動 springms-provider-user2 模塊服務，啟動2個端口（7997、7996）（直接將用戶微服務 spring.application.name 改了個名字為 springms-provider-user2 再啟動而已）；
 7、啟動 springms-consumer-movie-ribbon-custom 模塊服務；

 8、在瀏覽器輸入地址http://localhost:8020/choose，然后看看 springms-provider-user、springms-provider-user2 的各個對應的服務打印的信息是否均勻，正常情況下應該是 springms-provider-user 隨機分配，springms-provider-user2 輪詢分配；

 總結：springms-provider-user（之所以隨機是因為使用了 RibbonClient 配置采用 RandomRule 隨機調度算法）、springms-provider-user2（之所以輪詢是因為沒有任何配置，默認調度算法就是輪詢算法）；
 ****************************************************************************************/

/****************************************************************************************
 七、電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略（測試自定義分配服務器地址 TestConfigurationInsideScanPackage 調度方式）：

 1、注解：@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationInsideScanPackage.class)
 2、注解：@ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.ANNOTATION, value = ExcludeFromComponentScan.class) })
 3、TestConfigurationInsideScanPackage 類中采用 RoundRobinRule 輪詢調度算法；
 4、在 MovieCustomRibbonController 里面添加 test 方法來做測試；
 5、啟動 springms-provider-user 模塊服務，啟動3個端口（7900、7899、7898）；
 6、啟動 springms-provider-user2 模塊服務，啟動2個端口（7997、7996）（直接將用戶微服務 spring.application.name 改了個名字為 springms-provider-user2 再啟動而已）；
 7、啟動 springms-consumer-movie-ribbon-custom 模塊服務；
 8、在瀏覽器輸入地址http://localhost:8020/choose，然后看看 springms-provider-user、springms-provider-user2 的兩個端口的服務打印的信息是否均勻，正常情況下都是輪詢打印；

 總結：springms-provider-user（之所以隨機是因為使用了 RibbonClient 配置采用 RoundRobinRule 輪詢調度算法）、springms-provider-user2（之所以輪詢是因為沒有任何配置，默認調度算法就是輪詢算法）；
 ****************************************************************************************/

/****************************************************************************************
 八、電影微服務，使用定制化 Ribbon 在客戶端進行負載均衡，使用 RibbonClient 不同服務不同配置策略（測試自定義分配服務器地址 TestConfigurationInsideScanPackage 調度方式）：

 1、注解：@RibbonClient(name = "springms-provider-user", configuration = TestConfigurationInsideScanPackage.class)
 2、注解：@ComponentScan(excludeFilters = { @ComponentScan.Filter(type = FilterType.ANNOTATION, value = ExcludeFromComponentScan.class) })
 3、TestConfigurationInsideScanPackage 類中采用 RandomRule 隨機調度算法；
 4、在 MovieCustomRibbonController 里面添加 test 方法來做測試；
 5、啟動 springms-provider-user 模塊服務，啟動3個端口（7900、7899、7898）；
 6、啟動 springms-provider-user2 模塊服務，啟動2個端口（7997、7996）（直接將用戶微服務 spring.application.name 改了個名字為 springms-provider-user2 再啟動而已）；
 7、啟動 springms-consumer-movie-ribbon-custom 模塊服務；
 8、在瀏覽器輸入地址http://localhost:8020/choose，然后看看 springms-provider-user、springms-provider-user2 的兩個端口的服務打印的信息是否均勻，正常情況下應該是 springms-provider-user 隨機分配，springms-provider-user2 輪詢分配；

 總結：springms-provider-user（之所以隨機是因為使用了 RibbonClient 配置采用 RandomRule 隨機調度算法）、springms-provider-user2（之所以輪詢是因為沒有任何配置，默認調度算法就是輪詢算法）；
 ****************************************************************************************/

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容