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

HMILYYLIMH發表於2017-09-18
SpringGCCloud微服務客戶端負載

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-customsrcmainresourcesapplication.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-customsrcmainjavacomspringmscloudentityUser.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-customsrcmainjavacomspringmscloudconfigTestConfigurationInside2ScanPackage.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-customsrcmainjavacomspringmsconfigTestConfigurationOutsideScanPackage.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-customsrcmainjavacomspringmscloudTestConfigurationInsideScanPackage.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-customsrcmainjavacomspringmscloudExcludeFromComponentScan.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-customsrcmainjavacomspringmscloudcontrollerMovieCustomRibbonController.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-customsrcmainjavacomspringmscloudMsConsumerMovieCustomRibbonApplication.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（之所以輪詢是因為沒有任何配置，預設排程演算法就是輪詢演算法）；
 ****************************************************************************************/

四、下載地址

https://gitee.com/ylimhhmily/SpringCloudTutorial.git

SpringCloudTutorial交流QQ群: 235322432

SpringCloudTutorial交流微信群: 微信溝通群二維碼圖片連結

歡迎關注，您的肯定是對我最大的支援!!!

相關文章