SpringCloud 中使用 Ribbon（默认轮询规则 + 自定义规则）

SpringCloud 中使用 Ribbon

在前两章已经给大家讲解了Ribbon负载均衡的规则以及如何搭建Ribbon并调用服务，那么在这一章呢将会给大家说一说如何在SpringCloud中去使用Ribbon。在搭建之前我们需要做一些准备工作。

1. 搭建Eureka服务器：springCloud-ribbon-server（项目名称）
2. 服务提供者：springCloud-ribbon-police（项目名称）
3. 服务调用者：springCloud-ribbon-person（项目名称）

搭建Eureka服务器

配置 pom.xml，加入springCloud核心依赖、配置及eureka服务器依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.13.RELEASE</version>
</parent>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Dalston.SR5</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-eureka-server</artifactId>
    </dependency>
</dependencies>

配置 application.yml（红色部分是必须要写的，黑色部分不写也能正常运行但是建议写上，在这里笔者将官网的代码贴上）

server:
  port: 8761
eureka:
  instance:
    hostname: localhost
  client:
    registerWithEureka: false  禁止向eureka注册服务，因为它自己本身就是服务器
    fetchRegistry: false  这里不需要抓取注册表
    serviceUrl:
      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

创建启动类：Application.java（将服务跑起来放着，稍后会用到）配置 pom.xml，加入springCloud核心依赖、配置及eureka服务依赖

@SpringBootApplication
@EnableEurekaServer
public class Application {
    
    public static void main(String[] args) {
        new SpringApplicationBuilder(Application.class).web(true).run(args);
    }
    
}

服务提供者

配置 pom.xml，加入springCloud核心依赖、配置及eureka客户端依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.13.RELEASE</version>
</parent>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Dalston.SR5</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-eureka</artifactId>
    </dependency>
</dependencies>

配置 application.yml（需要使用defaultZone向服务器注册服务，否则就算该服务运行起来了，但没有向服务器注册服务，也是使用不了的）（name 这个名称是显示在服务列表中的名称，养成好习惯，一定要起有意义的名称）

spring:
  application:
    name: springCloud-ribbon-police
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

因为该服务是提供服务的，所以下面会建一个实体类及Controller用来对外提供服务，创建实体类：Police.java

public class Police {
    
    private String id;// 警察编号，用来保存用户输入的参数
    private String url;// 处理请求的服务器url
    private String message;// 提示信息
    
    
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getUrl() {
        return url;
    }
    public void setUrl(String url) {
        this.url = url;
    }
    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }
    
}

创建对外提供服务的Controller：PoliceController.java（@RestController注解中包含了@Controller+@ResponseBody）

@RestController
public class PoliceController {

    @RequestMapping(value="/getPolice", method=RequestMethod.GET, produces=MediaType.APPLICATION_JSON_VALUE)
    public Police getPolice(HttpServletRequest request){
        Police p = new Police();
        p.setUrl(request.getRequestURL().toString());
        p.setMessage("警察派出成功");
        return p;
    }
    
    @RequestMapping(value="/getPoliceById/{id}", method=RequestMethod.GET, produces=MediaType.APPLICATION_JSON_VALUE)
    public Police getPolice(HttpServletRequest request, @PathVariable("id") String id){
        Police p = new Police();
        p.setId(id);
        p.setUrl(request.getRequestURL().toString());
        p.setMessage("指定警察派出成功");
        return p;
    }
}

因为我们要测试负载均衡，所以这里的服务提供者需要开启多个服务实例，下面我们用读取手动输入端口号的方法，启动多个服务实例，笔者在这里启动了两个服务实例：8080、8081

@SpringBootApplication
@EnableEurekaClient
public class PoliceApplication {
    
    public static void main(String[] args) {
        Scanner scan = new Scanner(System.in);
        String port = scan.nextLine();
        new SpringApplicationBuilder(PoliceApplication.class).properties("server.port="+port).run(args);
    }
    
}

如下图，出现了两个服务实例，分别是：8080、8081，红色的信息咱们先不管他，如果实在有看着不顺眼的小伙伴，可以配置心跳（简单的来说，就是配置服务器每隔多久检查一次服务实例状态，如果某个服务因为某些原因停掉不能用了，那么就将该服务从服务列表中移除掉）

服务调用者

配置 pom.xml，加入springCloud核心依赖、配置及eureka客户端依赖、Ribbon依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.13.RELEASE</version>
</parent>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Dalston.SR5</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-eureka</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-ribbon</artifactId>
    </dependency>
</dependencies>

配置 application.yml（这里也将该服务注册到服务器，一定要进行注册）

server:
  port: 9090
spring:
  application:
    name: springCloud-ribbon-person
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

创建调用服务Controller：PersonController.java

RestTemplate 是由 Spring Web 模块提供的工具类，与 SpringCloud 无关，是独立存在的

因 SpringCloud 对 RestTemplate 进行了一定的扩展，所以 RestTemplate 具备了负载均衡的功能

@RestController
@Configuration
public class PersonController {

    @Bean
    @LoadBalanced
    public RestTemplate getRestTemplate(){
        return new RestTemplate();
    }
    
    @RequestMapping("/getPolice")
    public String getPolice(){
        RestTemplate rt = getRestTemplate();
        String result = rt.getForObject("http://springCloud-ribbon-police/getPolice", String.class);
        return result;
    }
    
    @RequestMapping("/getPoliceById/{id}")
    public String getPoliceById(@PathVariable("id") String id){
        RestTemplate rt = getRestTemplate();
        String result = rt.getForObject("http://springCloud-ribbon-police/getPoliceById/"+id, String.class);
        return result;
    }

}

创建启动类：PersonApplication.java

@SpringBootApplication
@EnableEurekaClient
public class PersonApplication {
    
    public static void main(String[] args) {
        new SpringApplicationBuilder(PersonApplication.class).web(true).run(args);
    }
    
}

到目前为止，eureka服务器、服务提供者、服务调用者（负载均衡）就已经全写好了，下面我们访问接口，来试一下服务到底能不能调通

我们分别调用：http://localhost:9090/getPolice、http://localhost:9090/getPoliceById/100

上面是默认的轮询规则，8080、8081轮询去访问服务，，，那么下面说一下如何自定义规则，在上一章的 “Ribbon 负载均衡机制（自定义负载均衡规则）” 中有贴过自定义负载均衡的自定义规则类，在这里就不再重复的贴了，大家可以到文章中去看一下。

那么下面就直接说，既然Ribbon和SpringCloud一起使用了，在这里给大家说一下如何使用配置类或者配置文件进行配置。

下面直接用一个配置类，直接搞定。这样每当请求过来的时候，那么该请求就会走咱们配置的自定义规则类了

//name：建议写服务名称     configuration：配置类
//http://springCloud-ribbon-police/getPolice 调用"springCloud-ribbon-police"这个服务ID的时候，将会启用下面的配置
@RibbonClient(name="springCloud-ribbon-police", configuration=LbConfig.class)
public class LbConfig {

    @Bean
    public IRule getRule(){
        return new MyRule();
    }
    
}

再说一下，如何使用配置文件进行配置：

格式是：服务ID >>> 命名空间 >>> 配置属性

springCloud-ribbon-police:
  ribbon:
    NFLoadBalancerRuleClassName: com.lpx.pro.utils.MyRule

以上两种配置方法都是有效的，，由此可以看出，我们配置的自定义规则起作用了。那么以上就是本章讲解的全部内容，通过这个简单的例子，希望可以帮到大家，感谢大家的支持！

来源：oschina

链接：https://my.oschina.net/u/4278635/blog/3278367

标签

eureka