Spring Cloud Consul：服務治理與配置中心

MacroZheng發表於2019-10-23
SpringCloud

SpringBoot實戰電商專案mall（20k+star）地址：github.com/macrozheng/…

摘要

Spring Cloud Consul 為 SpringBoot 應用提供了 Consul的支援，Consul既可以作為註冊中心使用，也可以作為配置中心使用，本文將對其用法進行詳細介紹。

Consul 簡介

Consul是HashiCorp公司推出的開源軟體，提供了微服務系統中的服務治理、配置中心、控制匯流排等功能。這些功能中的每一個都可以根據需要單獨使用，也可以一起使用以構建全方位的服務網格，總之Consul提供了一種完整的服務網格解決方案。

Spring Cloud Consul 具有如下特性：

  • 支援服務治理：Consul作為註冊中心時，微服務中的應用可以向Consul註冊自己，並且可以從Consul獲取其他應用資訊；
  • 支援客戶端負責均衡：包括Ribbon和Spring Cloud LoadBalancer；
  • 支援Zuul：當Zuul作為閘道器時，可以從Consul中註冊和發現應用；
  • 支援分散式配置管理：Consul作為配置中心時，使用鍵值對來儲存配置資訊；
  • 支援控制匯流排：可以在整個微服務系統中通過 Control Bus 分發事件訊息。

使用Consul作為註冊中心

安裝並執行Consul

Spring Cloud Consul：服務治理與配置中心

  • 下載完成後只有一個exe檔案，雙擊執行；

  • 在命令列中輸入以下命令可以檢視版本號：

consul --version
複製程式碼
  • 檢視版本號資訊如下：
Consul v1.6.1
Protocol 2 spoken by default, understands 2 to 3 (agent will automatically use protocol >2 when speaking to compatible agents)
複製程式碼
  • 使用開發模式啟動：
consul agent -dev 
複製程式碼

Spring Cloud Consul：服務治理與配置中心

建立應用註冊到Consul

我們通過改造user-service和ribbon-service來演示下服務註冊與發現的功能，主要是將應用原來的Eureka註冊中心支援改為Consul註冊中心支援。

  • 建立consul-user-service模組和consul-ribbon-service模組；

  • 修改相關依賴，把原來的Eureka註冊發現的依賴改為Consul的，並新增SpringBoot Actuator的依賴：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-consul-discovery</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
複製程式碼
  • 修改配置檔案application.yml，將Eureka的註冊發現配置改為Consul的：
server:
  port: 8206
spring:
  application:
    name: consul-user-service
  cloud:
    consul: #Consul服務註冊發現配置
      host: localhost
      port: 8500
      discovery:
        service-name: ${spring.application.name}
複製程式碼
  • 執行兩個consul-user-service和一個consul-ribbon-service，在Consul頁面上可以看到如下資訊：

Spring Cloud Consul：服務治理與配置中心

負載均衡功能

由於我們執行了兩個consul-user-service，而consul-ribbon-service預設會去呼叫它的介面，我們呼叫consul-ribbon-service的介面來演示下負載均衡功能。

多次呼叫介面：http://localhost:8308/user/1 ，可以發現兩個consul-user-service的控制檯交替列印如下資訊。

2019-10-20 10:39:32.580  INFO 12428 --- [io-8206-exec-10] c.macro.cloud.controller.UserController  : 根據id獲取使用者資訊，使用者名稱稱為：macro
複製程式碼

使用Consul作為配置中心

我們通過建立consul-config-client模組，並在Consul中新增配置資訊來演示下配置管理的功能。

建立consul-config-client模組

  • 在pom.xml中新增相關依賴：
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-consul-config</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-consul-discovery</artifactId>
</dependency>
複製程式碼
  • 新增配置檔案application.yml，啟用的是dev環境的配置：
spring:
  profiles:
    active: dev
複製程式碼
  • 新增配置檔案bootstrap.yml，主要是對Consul的配置功能進行配置：
server:
  port: 9101
spring:
  application:
    name: consul-config-client
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        serviceName: consul-config-client
      config:
        enabled: true #是否啟用配置中心功能
        format: yaml #設定配置值的格式
        prefix: config #設定配置所在目錄
        profile-separator: ':' #設定配置的分隔符
        data-key: data #配置key的名字，由於Consul是K/V儲存，配置儲存在對應K的V中
複製程式碼
  • 建立ConfigClientController，從Consul配置中心中獲取配置資訊：
/**
 * Created by macro on 2019/9/11.
 */
@RestController
@RefreshScope
public class ConfigClientController {

    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo() {
        return configInfo;
    }
}
複製程式碼

在Consul中新增配置

  • 在consul中新增配置儲存的key為:
config/consul-config-client:dev/data
複製程式碼
  • 在consul中新增配置儲存的value為：
config:
  info: "config info for dev"
複製程式碼
  • 儲存資訊截圖如下：

Spring Cloud Consul：服務治理與配置中心

config info for dev
複製程式碼

Consul的動態重新整理配置

我們只要修改下Consul中的配置資訊，再次呼叫檢視配置的介面，就會發現配置已經重新整理。回想下在使用Spring Cloud Config的時候，我們需要呼叫介面，通過Spring Cloud Bus才能重新整理配置。Consul使用其自帶的Control Bus 實現了一種事件傳遞機制，從而實現了動態重新整理功能。

使用到的模組

springcloud-learning
├── consul-config-client -- 用於演示consul作為配置中心的consul客戶端
├── consul-user-service -- 註冊到consul的提供User物件CRUD介面的服務
└── consul-service -- 註冊到consul的ribbon服務呼叫測試服務
複製程式碼

專案原始碼地址

github.com/macrozheng/…

公眾號

mall專案全套學習教程連載中，關注公眾號第一時間獲取。

公眾號圖片

相關文章