前面一篇
SpringCloud学习-(3)服务消费与负载均衡(ribbon)
介绍了ribbon对客户端请求的负载均衡操作,从刷新浏览器端口变化规律可以看到ribbon默认使用的是轮询的方式对服务提供者提供的服务进行访问。那么如果我们想按照自己的规则进行负载均衡该怎么操作呢。本篇将介绍如何自定义负载均衡规则。
本篇继续延续前面几篇介绍的例子向下进行,不建议读者从本篇文章作为起始点阅读。
1.eureka服务注册中心
继续沿用前几篇的eureka服务注册中心,端口号8761
2.服务提供者
service-sayHello8762和service-sayHello8763
3.自定义ribbon-使用程序
3.1创建maven工程
GroupId:com.tangjinyi
ArtifactId:springcloud-eureka-ribbon-custom
3.2pom.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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.tangjinyi</groupId>
<artifactId>springcloud-eureka-ribbon-custom</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>springcloud-eureka-ribbon-custom</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-cloud.version>Finchley.M9</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--由于使用的是springboot2.x,所以在jar包的坐标都需要加上netflix-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-ribbon</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>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
</project>
3.3创建自定义注解
ExcludeFromComponentScan,该注解仅作为一个标识。没有实际含义,也没有固定注解名称。
package com.tangjinyi.config;
/**
* 在配置自定义ribbon的时候要求配置不能在spring componentScan扫描的包下面。所以定义该注解就是为了在扫描的时候将自定义ribbon排除扫描。
*/
public @interface ExcludeFromComponentScan {
}
3.4创建配置文件类
TestConfiguration
在这里配置ribbon的负载均衡规则为随机
ackage com.tangjinyi.config;
import com.netflix.loadbalancer.IRule;
import com.netflix.loadbalancer.RandomRule;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* 使用ExcludeFromComponentScan注解标记。在使用ComponentScan扫描的时候,不扫描使用该注解标记的类
*/
@Configuration
@ExcludeFromComponentScan
public class TestConfiguration {
@Bean
public IRule ribbonRule() {
System.out.println("ribbonRule:随机");
return new RandomRule();
}
}
3.5创建ribbon业务流程类(同上一篇)
UserController
package com.tangjinyi.controller;
import com.tangjinyi.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
@Autowired
private UserService userService;
@RequestMapping(value = "/sayHello")
public String sayHello(@RequestParam String name){
return userService.sayHello(name);
}
}
UserService
package com.tangjinyi.service;
import com.tangjinyi.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class UserService {
@Autowired
public UserRepository userRepository;
public String sayHello(String name){
return userRepository.sayHello(name);
}
}
UserRepository
package com.tangjinyi.repository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;
import org.springframework.web.client.RestTemplate;
@Repository
public class UserRepository {
@Autowired
public RestTemplate restTemplate;
public String sayHello(String name){
String value = restTemplate.getForObject("http://service-sayHello:8761/sayHello?name="+name,String.class);
return value;
}
}
3.6修改启动类
@RibbonClient(name = "service-sayHello", configuration = TestConfiguration.class)
注解指定Ribbon配置的负载均衡规则。
@ComponentScan(excludeFilters={@ComponentScan.Filter(type= FilterType.ANNOTATION,value=ExcludeFromComponentScan.class)})
自定义包扫描规则过滤,不扫描自定义注解标识的类,也就是TestConfiguration类。
@LoadBalanced
表示使用ribbon整合restTemplate调用。
package com.tangjinyi;
import com.tangjinyi.config.ExcludeFromComponentScan;
import com.tangjinyi.config.TestConfiguration;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
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;
@SpringBootApplication
@EnableDiscoveryClient
@RibbonClient(name = "service-sayHello", configuration = TestConfiguration.class)
@ComponentScan(excludeFilters = {@ComponentScan.Filter(type= FilterType.ANNOTATION,value=ExcludeFromComponentScan.class)})
public class SpringcloudEurekaRibbonCustomApplication {
public static void main(String[] args) {
SpringApplication.run(SpringcloudEurekaRibbonCustomApplication.class, args);
}
@Bean
@LoadBalanced
public RestTemplate restTemplate(){
return new RestTemplate();
}
}
3.7修改application.properties配置文件
eureka.client.service-url.defaultZone=http://localhost:8761/eureka/
server.port=8765
spring.application.name=service-ribbon-custom
配置完成后的最终结构如下:
4.启动所有服务
依次启动eureka server
再启动client1和client2
再启动ribbon-consum
每个工程的启动类执行run as即可
5.访问测试
启动完成后
服务注册成功
浏览器访问ribbon-consum8765
刷新浏览器,发现端口号并不是按照轮询规则显示,而是无规则的显示8762和8763。
6.自定义ribbon-使用配置文件
上面通过代码的形式实现了自定义ribbon。实际上springcloud为我们提供了很多的策略供选择,如果不是特殊需求,springcloud提供的负载均衡策略应该可以满足。
为了保留上面的自定义ribbon,重新创建一个工程springcloud-eureka-ribbon
修改配置文件application.properties
eureka.client.service-url.defaultZone=http://localhost:8761/eureka/
server.port=8764
spring.application.name=service-ribbon
#service-syaHello为服务提供者提供的服务名
#NFLoadBalancerRuleClassName为springcloud提供的固定某几种写法
#com.netflix.loadbalancer.RandomRule为springcloud提供的负载均衡规则,相应的可从com.netflix.loadbalancer包中选择符合自己的策略
service-sayHello.ribbon.NFLoadBalancerRuleClassName=com.netflix.loadbalancer.RandomRule
启动该项目,将服务注册到eureka注册中心上。
浏览器访问http://localhost:8764/sayHello?name=123
不断刷新浏览器,观察端口变化,发现此时负载均衡是无规则的在8762和8763之间切换,说明配置文件配置的ribbon负载均衡策略已经生效。
自定义ribbon到此就完成了。