微服務SpringCloud之註冊中心Consul

  • 2019 年 10 月 3 日
  • 筆記

Consul 介紹

Consul 是 HashiCorp 公司推出的開源工具，用於實現分散式系統的服務發現與配置。與其它分散式服務註冊與發現的方案，Consul 的方案更“一站式”，內置了服務註冊與發現框 架、分布一致性協議實現、健康檢查、Key/Value 存儲、多數據中心方案，不再需要依賴其它工具（比如 ZooKeeper 等）。使用起來也較 為簡單。Consul 使用 Go 語言編寫，因此具有天然可移植性(支援Linux、windows和Mac OS X)；安裝包僅包含一個可執行文件，方便部署，與 Docker 等輕量級容器可無縫配合。

Consul 的優勢：

使用 Raft 演算法來保證一致性, 比複雜的 Paxos 演算法更直接. 相比較而言, zookeeper 採用的是 Paxos, 而 etcd 使用的則是 Raft。
支援多數據中心，內外網的服務採用不同的埠進行監聽。 多數據中心集群可以避免單數據中心的單點故障,而其部署則需要考慮網路延遲, 分片等情況等。 zookeeper 和 etcd 均不提供多數據中心功能的支援。
支援健康檢查。 etcd 不提供此功能。
支援 http 和 dns 協議介面。 zookeeper 的集成較為複雜, etcd 只支援 http 協議。
官方提供 web 管理介面, etcd 無此功能。
綜合比較, Consul 作為服務註冊和配置管理的新星, 比較值得關注和研究。
特性：

服務發現
健康檢查
Key/Value 存儲
多數據中心

Consul 角色

client: 客戶端, 無狀態, 將 HTTP 和 DNS 介面請求轉發給區域網內的服務端集群。
server: 服務端, 保存配置資訊, 高可用集群, 在區域網內與本地客戶端通訊, 通過廣域網與其它數據中心通訊。 每個數據中心的 server 數量推薦為 3 個或是 5 個。
Consul 客戶端、服務端還支援誇中心的使用，更加提高了它的高可用性。

 

Consul 工作原理：

 

1、當 Producer 啟動的時候，會向 Consul 發送一個 post 請求，告訴 Consul 自己的 IP 和 Port
2、Consul 接收到 Producer 的註冊後，每隔10s（默認）會向 Producer 發送一個健康檢查的請求，檢驗Producer是否健康
3、當 Consumer 發送 GET 方式請求 /api/address 到 Producer 時，會先從 Consul 中拿到一個存儲服務 IP 和 Port 的臨時表，從表中拿到 Producer 的 IP 和 Port 後再發送 GET 方式請求 /api/address
4、該臨時表每隔10s會更新，只包含有通過了健康檢查的 Producer

Consul的安裝

 從官網https://www.consul.io/downloads.html下載對應的版本，這裡下載的是window版本，然後cmd命令啟動，在瀏覽器輸入http://localhost:8500，有正常頁面輸出則啟動成功

consul agent -dev        # -dev表示開發模式運行，另外還有-server表示服務模式運行

Consul 服務端

 1.引入依賴

這裡需要引入spring-cloud-starter-consul-discovery、spring-cloud-starter-consul-all、consul-api、spring-boot-starter-actuator，參考部落格未引入spring-cloud-starter-consul-all、consul-api兩個依賴，在我測試的時候報阿里雲倉庫找不到502的錯誤。

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">      <modelVersion>4.0.0</modelVersion>      <parent>          <groupId>org.springframework.boot</groupId>          <artifactId>spring-boot-starter-parent</artifactId>          <version>2.1.8.RELEASE</version>          <relativePath/> <!-- lookup parent from repository -->      </parent>      <groupId>com.example</groupId>      <artifactId>SpringCloudConsulProducer</artifactId>      <version>0.0.1-SNAPSHOT</version>      <name>SpringCloudConsulProducer</name>      <description>Demo project for Spring Boot</description>        <properties>          <java.version>1.8</java.version>          <spring-cloud.version>Greenwich.SR2</spring-cloud.version>      </properties>        <dependencies>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-web</artifactId>          </dependency>  <dependency>      <groupId>org.springframework.cloud</groupId>      <artifactId>spring-cloud-starter-consul-discovery</artifactId>  </dependency>  <dependency>      <groupId>org.springframework.cloud</groupId>      <artifactId>spring-cloud-starter-consul-all</artifactId>      <version>2.1.3.RELEASE</version>  </dependency>  <dependency>      <groupId>com.ecwid.consul</groupId>      <artifactId>consul-api</artifactId>      <version>1.4.2</version>  </dependency>  <dependency>       <groupId>org.springframework.boot</groupId>       <artifactId>spring-boot-starter-actuator</artifactId>  </dependency>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-tomcat</artifactId>              <scope>provided</scope>          </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>        <packaging>war</packaging>  </project>
View Code

2.配置文件

server.port=8764  spring.application.name=consul-provider  spring.cloud.consul.host=127.0.0.1  spring.cloud.consul.port=8500  spring.cloud.consul.discovery.service-name=consul-provider

3.在main類中添加@EnableDiscoveryClient註解

4.增加Controller

這裡創建了HelloController，這裡需要添加@RestController註解，如果沒添加在客戶端調用的時候就會報404的錯誤。

package com.example.demo;    import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RequestParam;  import org.springframework.web.bind.annotation.RestController;    @RestController  public class HelloController {      @RequestMapping("/hello")      public String hello(@RequestParam(value = "name") String name) {          return "helle consul  "+name;      }  }
View Code

Consul 消費者

1.引入依賴

在上面的基礎上增加feign的引入

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">      <modelVersion>4.0.0</modelVersion>      <parent>          <groupId>org.springframework.boot</groupId>          <artifactId>spring-boot-starter-parent</artifactId>          <version>2.1.8.RELEASE</version>          <relativePath/> <!-- lookup parent from repository -->      </parent>      <groupId>com.example</groupId>      <artifactId>SpringCloudConsulConsumer</artifactId>      <version>0.0.1-SNAPSHOT</version>      <packaging>war</packaging>      <name>SpringCloudConsulConsumer</name>      <description>Demo project for Spring Boot</description>        <properties>          <java.version>1.8</java.version>          <spring-cloud.version>Greenwich.SR2</spring-cloud.version>      </properties>        <dependencies>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-web</artifactId>          </dependency>          <dependency>              <groupId>org.springframework.cloud</groupId>              <artifactId>spring-cloud-starter-consul-discovery</artifactId>          </dependency>          <dependency>              <groupId>org.springframework.cloud</groupId>              <artifactId>spring-cloud-starter-consul-all</artifactId>              <version>2.1.3.RELEASE</version>          </dependency>          <dependency>              <groupId>com.ecwid.consul</groupId>              <artifactId>consul-api</artifactId>              <version>1.4.2</version>          </dependency>          <dependency>              <groupId>org.springframework.cloud</groupId>              <artifactId>spring-cloud-starter-openfeign</artifactId>          </dependency>          <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-openfeign-core -->          <dependency>              <groupId>org.springframework.cloud</groupId>              <artifactId>spring-cloud-openfeign-core</artifactId>              <version>2.1.2.RELEASE</version>          </dependency>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-actuator</artifactId>          </dependency>          <dependency>              <groupId>org.springframework.boot</groupId>              <artifactId>spring-boot-starter-tomcat</artifactId>              <scope>provided</scope>          </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>    </project>
View Code

2.配置文件

spring.application.name=spring-cloud-consul-consumer  server.port=8507  spring.cloud.consul.host=127.0.0.1  spring.cloud.consul.port=8500  #設置不需要註冊到 consul 中  spring.cloud.consul.discovery.register=false  feign.hystrix.enabled=false

3.增加註解

在main類中增加@EnableFeignClients註解

4.參考Eureka中feign的調用

首先創建HelloRemote介面

package com.example.demo;    import org.springframework.cloud.openfeign.FeignClient;  import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RequestParam;    @FeignClient(name= "consul-provider")  public interface HelloRemote {        @RequestMapping(value = "/hello")      public String hello(@RequestParam(value = "name") String name);    }

然後創建介面的實現

package com.example.demo;    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 CallHelloController {      @Autowired      HelloRemote HelloRemote;        @RequestMapping("/hello")      public String index(@RequestParam String name) {          return HelloRemote.hello(name);      }  }
View Code

測試

依次啟動SpringCloudConsulProducer、SpringCloudConsulConsumer，在瀏覽器輸入http://localhost:8507/hello?name=cuiyw

 

負載均衡

修改SpringCloudConsulProducer項目的埠，在HelloController中修改hello方法以區分調用

package com.example.demo;    import org.springframework.web.bind.annotation.RequestMapping;  import org.springframework.web.bind.annotation.RequestParam;  import org.springframework.web.bind.annotation.RestController;    @RestController  public class HelloController {      @RequestMapping("/hello")      public String hello(@RequestParam(value = "name") String name) {          return "helle consul  two"+name;      }  }

啟動實例之後瀏覽器刷新http://localhost:8507/hello?name=cuiyw，可以看到下面兩個響應內容，從而實現負載均衡的效果。

 

 參考：http://www.ityouknow.com/springcloud/2018/07/20/spring-cloud-consul.html

Tags:

VirMach 便宜 VPS