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

 

 

以上兩種配置方法都是有效的，，由此可以看出，我們配置的自定義規則起作用了。那么以上 就是本章講解的全部內容，通過這個簡單的例子，希望可以幫到大家，感謝大家的支持！