SpringCloud-Consul

• 2022 年 3 月 22 日
• 筆記
• SpringCloud

1. Consul 簡介

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

2. 專業名詞

• agent

  組成 consul 集群的每個成員上都要運行一個 agent，可以通過 consul agent 命令來啟動。agent可以運行在 server 狀態或者 client 狀態。自然的， 運行在 server 狀態的節點被稱為 server 節點，運行在 client 狀態的節點被稱 為 client 節點。

• server 節點

  負責組成 cluster 的複雜工作(選舉server 自行選舉一個 leader、狀態維 護、轉發請求到 leader)，以及 consul 提供的服務(響應RPC 請求)，以及存放和複製數據。考慮到容錯和可用性，一般部署 3 ~ 5 個比較合適。

• client 節點

  負責轉發所有的 RPC 到 server 節點。本身無狀態，且輕量級，因此，可以部署大量的client 節點。

• 數據中心

  雖然數據中心的定義似乎很明顯，但仍有一些細微的細節必須考慮。我們 將一個數據中心定義為一個私有、低延遲和高頻寬的網路環境。這不包括通過公共互聯網的通訊，但是為了我們的目的，單個EC2 （aws雲主機）區域內的多個可用區域將被視為單個數據中心的一部分。

3. Consul 的優勢

• 使用 Raft 演算法來保證一致性, 比複雜的 Paxos 演算法更直接. 相比較而言, zookeeper 採用的是 Paxos, 而 etcd 使用的則是 Raft。

• 支援多數據中心，內外網的服務採用不同的埠進行監聽。 多數據中心集群可以避免單數據中心 的單點故障,而其部署則需要考慮網路延遲, 分片等情況等。 zookeeper 和 etcd 均不提供多數據中 心功能的支援。

• 支援健康檢查。 etcd 不提供此功能。

• 支援 http 和 dns 協議介面。 zookeeper 的集成較為複雜, etcd 只支援 http 協議。 官方提供 web 管理介面, etcd 無此功能。

• 綜合比較, Consul 作為服務註冊和配置管理的新星, 比較值得關注和研究。

4. 特性

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

5. Consul與Eureka的區別

1. 一致性 Consul強一致性(CP)

   • 服務註冊相比Eureka會稍慢一些。因為Consul的raft協議要求必須過半數的節點都寫入成功才認 為註冊成功
   • Leader掛掉時，重新選舉期間整個consul不可用。保證了強一致性但犧牲了可用性。

2. Eureka保證高可用和最終一致性(AP)

   • 服務註冊相對要快，因為不需要等註冊資訊replicate到其他節點，也不保證註冊資訊是否 replicate成功

   • 當數據出現不一致時，雖然A, B上的註冊資訊不完全相同，但每個Eureka節點依然能夠正常對外提 供服務，這會出現查詢服務資訊時如果請求A查不到，但請求B就能查到。如此保證了可用性但犧牲了一致性。

6. Consul 安裝

consul docker-hub

6.1 docker-compose安裝

以dev模式啟動 且 設置client=0.0.0.0為所有ip都可以連接此服務

version: '2'
services:
  consul-container:
    image: consul
    container_name: consul-dev
    environment:
      - CONSUL_BIND_INTERFACE=eth0
    ports:
      - "8500:8500"
    volumes:
      - "./config:/consul/config/"
      - "./data/:/consul/data/"
    command: agent -dev -client=0.0.0.0

服務啟動成功後，通過瀏覽器訪問localhost:8500,顯示如下頁面即安裝成功。

7. Quick Start

7.1 啟動consul服務

本文使用的是docker-compose方式管理consul服務，直接啟動即可

7.2 創建客戶端-provider

7.2.1 引入依賴坐標

<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>
<!--actuator用於心跳檢查-->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

7.2.2 配置application.yml

server:
  port: ${port:8082}

spring:
  application:
    name: provider
  cloud:
    consul:
      #consul服務地址
      host: 127.0.0.1
      #consul服務埠
      port: 8500
      discovery:
        #是否註冊
        register: true
        #實例ID
        #        instance-id: ${spring.application.name}-${server.port}
        instance-id: ${spring.application.name}:${random.value}
        #服務實例名稱
        service-name: ${spring.application.name}
        #服務實例埠
        port: ${server.port}
        #健康檢查路徑
        healthCheckPath: /actuator/health
        #健康檢查時間間隔
        healthCheckInterval: 15s
        #開啟ip地址註冊
        prefer-ip-address: true
        #實例的請求ip
        ip-address: ${spring.cloud.client.ip-address}

7.2.3 添加測試方法

package com.ldx.provider.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;

@RestController
public class TestController {
    @Autowired
    private DiscoveryClient discoveryClient;

    @Value("${server.port}")
    private String port;

    @GetMapping("products")
    public String products(){
        List<ServiceInstance> list = discoveryClient.getInstances("consumer");

        if(list != null && list.size() > 0 ) {
            ServiceInstance serviceInstance = list.get(0);
            System.out.println(serviceInstance);
        }

        return "Hello World：" + port;
    }
}

7.3 創建客戶端-comsumer

創建過程和provider一樣 測試方法換一下，並且在啟動類上添加RestTemplate Bean

7.3.1 配置application.yml

server:
  port: ${port:8081}

spring:
  application:
    name: consumer
  cloud:
    consul:
      #consul服務地址
      host: 127.0.0.1
      #consul服務埠
      port: 8500
      discovery:
        #是否註冊
        register: true
        #實例ID
        #        instance-id: ${spring.application.name}-${server.port}
        instance-id: ${spring.application.name}:${random.value}
        #服務實例名稱
        service-name: ${spring.application.name}
        #服務實例埠
        port: ${server.port}
        #健康檢查路徑
        healthCheckPath: /actuator/health
        #健康檢查時間間隔
        healthCheckInterval: 15s
        #開啟ip地址註冊
        prefer-ip-address: true
        #實例的請求ip
        ip-address: ${spring.cloud.client.ip-address}
        metadata:
          #添加自定義元數據
          my-name: zhangtieniu-consumer

7.3.2 添加支援負載均衡的RestTemplate

package com.ldx.consumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class ConsumerApplication {
   @Bean
   @LoadBalanced 
   public RestTemplate loadbalancedRestTemplate(){
      return new RestTemplate();
   }

   public static void main(String[] args) {
      SpringApplication.run(ConsumerApplication.class, args);
   }
}

7.3.3 添加測試方法

package com.ldx.consumer.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
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;
import java.util.List;

@RestController
public class TestController {
    @Autowired
    private RestTemplate restTemplate;

    @GetMapping()
    public String consumer(){
        return this.restTemplate.getForObject("//provider/products", String.class);
    }
}

7.4 啟動

啟動了兩個 provider 和一個 consumer

瀏覽器輸入localhost:8500 查看consul控制台，顯示服務註冊成功

測試服務調用

其中provider 輸出的 實例資訊如下：

[ConsulServiceInstance@4c2b7437 instanceId = 'consumer-6cfd981c90545313155d1f43c3ed23a5', serviceId = 'consumer', host = '192.168.0.101', port = 8081, secure = false, metadata = map['my-name' -> 'zhangtieniu-consumer', 'secure' -> 'false'], uri = //192.168.0.101:8081, healthService = HealthService{node=Node{id='3fe6ea9e-3846-ff8d-b01f-a6528caaa3fd', node='44a66c1caa9c', address='172.26.0.2', datacenter='dc1', taggedAddresses={lan=172.26.0.2, lan_ipv4=172.26.0.2, wan=172.26.0.2, wan_ipv4=172.26.0.2}, meta={consul-network-segment=}, createIndex=11, modifyIndex=13}, service=Service{id='consumer-6cfd981c90545313155d1f43c3ed23a5', service='consumer', tags=[], address='192.168.0.101', meta={my-name=zhangtieniu-consumer, secure=false}, port=8081, enableTagOverride=false, createIndex=275, modifyIndex=275}, checks=[Check{node='44a66c1caa9c', checkId='serfHealth', name='Serf Health Status', status=PASSING, notes='', output='Agent alive and reachable', serviceId='', serviceName='', serviceTags=[], createIndex=11, modifyIndex=11}, Check{node='44a66c1caa9c', checkId='service:consumer-6cfd981c90545313155d1f43c3ed23a5', name='Service 'consumer' check', status=PASSING, notes='', output='HTTP GET //192.168.0.101:8081/actuator/health: 200  Output: {"status":"UP"}', serviceId='consumer-6cfd981c90545313155d1f43c3ed23a5', serviceName='consumer', serviceTags=[], createIndex=275, modifyIndex=278}]}]