為Spring Cloud Config插上管理的翅膀

程式猿DD發表於2018-07-29
SpringCloud

最近一致在更新Spring Cloud Config的相關內容，主要也是為這篇埋個伏筆，相信不少調研過Spring Cloud Config的使用者都會吐槽它的管理能力太弱。因此，就有了下面為講推薦的這個開源專案，希望對已經入坑Spring Cloud Config的童鞋們有所幫助！

簡介

在Spring Cloud的微服務架構方案中雖然提供了Spring Cloud Config來擔任配置中心的角色，但是該專案的功能在配置的管理層面還是非常欠缺的。初期我們可以依賴選取的配置儲存系統（比如：Gitlab、Github）給我們提供的配置管理介面來操作所有的配置資訊，但是這樣的管理還是非常粗粒度的，因此這個專案的目的就是解決這個問題，通過此專案，我們將提供一套基於Spring Cloud Config配置中心的視覺化管理系統。

在該專案中，我們對於服務治理、配置儲存、視覺化操作都做了抽象，只要目的就是為了儘可能的相容所有Spring Cloud Config的使用者。任何Spring Cloud Config僅需要通過一些簡單的配置，或者遷移工具就能將原來正在使用的配置中心統一的管理起來。

專案地址

  • Github: https://github.com/dyc87112/spring-cloud-config-admin

  • Gitee：https://gitee.com/didispace/spring-cloud-config-admin

  • 前端Github: https://github.com/stone-jin/spring-cloud-config-admin-web

  • 前端Gitee: https://gitee.com/stone-jin/spring-cloud-config-admin-web

如果您覺得該專案對您有用，歡迎Star、Follow支援我們！

架構概覽

本專案採用了前後端分離的架構，通過core模組抽象了前端需要的操作，再通過persistence和discovery模組隔離不同的配置倉庫和不同的服務註冊中心，從而達到前端程式不需要關心到底使用了什麼儲存配置以及使用了什麼註冊中心，這樣使用者可以根據自己的需要自由的組合不同的配置儲存和服務治理機制，儘可能的匹配大部分Spring Cloud使用者的需求。

WechatIMG126.jpeg

部署方式

由於SCCA的架構對各個功能模組做了比較細緻的拆分，所以它存在多種不同模式的部署方式，所以它既可以為已經在使用Spring Cloud Config提供服務，也可以為從零開始使用Spring Cloud Config的使用者。

在SCCA中我們的可部署內容自底向上分為三個部分：

  • Spring Cloud 配置中心：基於Spring Cloud Config構建的配置中心服務端。
  • SCCA REST 服務端：SCCA的核心模組，實現了SCCA配置管理的持久化內容以及所有的管理操作API。
  • SCCA UI 服務端：SCCA的前端模組，實現了視覺化的配置管理操作介面。

下面我們來看看SCCA支援哪些多樣的部署方式。

全分離模式

全分離模式就是將上述三個部分都以獨立的程式進行部署，每一個部分都可以做高可用，具體部署結構可以如下圖所示：

scca-deploy-1.png

這種模式既可以適用於已經在使用Spring Cloud Config的使用者，也適用於正準備開始適用的使用者。其中，位於最底層的Spring Cloud配置中心就是一個最原始的Spring Cloud Config Server。所以，對於已經在使用Spring Cloud Config的使用者只需要再部署一套SCCA REST 服務端和SCCA UI 服務端，並做一些配置就可以使用SCCA來管理所有的配置資訊了。

案例

半分離模式

所謂的半分離模式就是將上述的三個模組中的兩個進行組合部署，以降低複雜度的部署方式。
SCCA UI模組與SCCA REST模組合併

如下圖所示，我們可以將SCCA UI服務端與SCCA REST服務端組合在一個程式中來部署，這樣可以有效的降低全分離模式的部署複雜度，同時對於已經在使用Spring Cloud Config的使用者來說非常友好，已經部署的配置中心可以繼續沿用。

scca-deploy-2.png

案例

注意：對接不同儲存配置中心的配置參考分離部署中兩個SCCA REST服務端的不同配置內容進行調整。

All-In-One模式

最後介紹一種比較暴力的使用模式，SCCA支援將所有三個模組整合在一起使用和部署，在一個Spring Boot應用中同時包含：Spring Cloud 配置中心、SCCA REST 服務端以及SCCA UI 服務端，具體如下所示：

scca-deploy-4.png

案例

配置詳解

本章節分別對三個核心模組的構建方式以及核心的配置內容。下面所有的構建都是基於Spring Boot構建的，所以您需要對Spring Boot專案的構建有基本的認識，這裡不做介紹。

Spring Cloud配置中心的構建與配置

在SCCA的架構中，配置中心的核心完全採用Spring Cloud Config，所以如何構建一個配置中心完全遵循Spring Cloud Config的使用方法。由於目前SCCA的REST模組主要實現了對Git儲存和DB儲存的綜合管理，所以對於Spring Cloud Config的使用也只能支援這兩種模式。下面分別介紹兩種配置中心的搭建與配置。

Git儲存模式

這裡主要介紹幾種主要的並且SCCA能夠比較好支援的配置模式：

第一種：多個專案使用多個不同Git倉庫儲存的模式

spring.cloud.config.server.git.uri=https://github.com/dyc87112/{application}.git
spring.cloud.config.server.git.username=
spring.cloud.config.server.git.password=

這種模式下不同的專案會對應的不同的Git倉庫，如果專案中spring.application.name=user-service，那麼它的配置倉庫會定位到https://github.com/dyc87112/user-service.git倉庫下的配置。配置檔案按application-{profile}.properties的格式儲存，{profile}代表環境名。

第二種：多個專案公用一個Git倉庫不同目錄的儲存模式

spring.cloud.config.server.git.uri=https://github.com/dyc87112/config-repo.git
spring.cloud.config.server.git.search-paths=/{application}
spring.cloud.config.server.git.username=
spring.cloud.config.server.git.password=

這種模式下不同的專案會對應到https://github.com/dyc87112/config-repo.git倉庫下的不同目錄，如果專案中spring.application.name=user-service，那麼它的配置倉庫會定位到https://github.com/dyc87112/config-repo.git倉庫下的/user-service目錄。配置檔案按application-{profile}.properties的格式儲存，{profile}代表環境名。

案例：Spring Cloud 配置中心（Git儲存）

Db儲存模式

在使用Db儲存模式的時候，必須使用Spring Cloud的Edgware版本以上。比如，可以採用下面的配置：

# config server with jdbc
spring.profiles.active=jdbc
spring.cloud.config.server.jdbc.sql=SELECT `p_key`, `p_value` FROM property a, project b, env c, label d where a.project_id=b.id and a.env_id=c.id and a.label_id=d.id and b.name=? and c.name=? and d.name=?

# Datasource, share with scca-rest-server
spring.datasource.url=jdbc:mysql://localhost:3306/config-db
spring.datasource.username=root
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

主要分為兩個部分：

  • 啟用採用DB儲存的模式：將spring.profiles.active設定為jdbc，同時指定獲取配置的SQL，使用者直接複製採用一樣的配置即可。
  • 指定儲存配置的DB連線資訊，除了mysql之外也可以使用其他主流關係型資料庫。

這裡需要注意的，使用的DB要與後續介紹的SCCA REST模組採用同一個DB

案例：Spring Cloud 配置中心（DB儲存）

SCCA REST服務端的構建與配置

在構建SCCA REST服務端的時候針對對接不同的配置儲存有一些不同的配置要求，所以下面按目前支援的儲存模式做不同的介紹。

Git儲存模式

當對接的配置中心採用Git儲存的時候，需要引入以下核心依賴：

<dependency>
    <groupId>com.didispace</groupId>
    <artifactId>scca-rest</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

<!-- scca persistence dependency -->
<dependency>
    <groupId>com.didispace</groupId>
    <artifactId>scca-persistence-git</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

需要按如下配置：

# if config server use git, need config these properties
scca.git.username=
scca.git.password=
scca.git.repo-uri=https://github.com/dyc87112/{application}.git
scca.git.base-path=
scca.git.file-pattern=application-{profile}.properties

# Datasource
spring.datasource.url=jdbc:mysql://localhost:3306/config-db
spring.datasource.username=root
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

主要兩部分：

  • 對接的git儲存的配置：
    • scca.git.username：訪問git的使用者名稱
    • scca.git.password：訪問git的密碼
    • scca.git.repo-uri：配置git倉庫的地址，與配置中心的spring.cloud.config.server.git.uri配置一致
    • scca.git.base-path：配置檔案儲存的相對路徑，與配置中心的spring.cloud.config.server.git.search-paths配置一致
    • scca.git.file-pattern：配置檔案的命名規則
  • SCCA內部邏輯的儲存庫資料來源資訊

案例：SCCA REST 服務端（對接Git儲存的配置中心）

Db儲存模式

當對接的配置中心採用Git儲存的時候，需要引入以下核心依賴：

<dependency>
    <groupId>com.didispace</groupId>
    <artifactId>scca-rest</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

<!-- scca persistence dependency -->
<dependency>
    <groupId>com.didispace</groupId>
    <artifactId>scca-persistence-db</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

需要按如下配置：

# Datasource
spring.datasource.url=jdbc:mysql://localhost:3306/config-db
spring.datasource.username=root
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

需要注意，當配置中心採用DB儲存的時候，這裡的資料來源需要一致

案例：SCCA REST 服務端（對接DB儲存的配置中心）

服務發現支援

如果SCCA REST模組在訪問配置中心的時候基於服務發現的話還需要引入對應的支援依賴和配置

與Eureka的整合

如果使用eureak，那麼需要引入如下依賴：

<!-- scca discovery dependency-->
<dependency>
    <groupId>com.didispace</groupId>
    <artifactId>scca-discovery-eureka</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

並且在配置中加入eureka的配置，比如：

eureka.client.serviceUrl.defaultZone=http://eureka.didispace.com/eureka/

更多相關配置請參與Spring Cloud Netflix Eureka的配置文件。

與Consul的整合

如果使用consul，那麼需要引入如下依賴：

<!-- scca discovery dependency-->
<dependency>
    <groupId>com.didispace</groupId>
    <artifactId>scca-discovery-consul</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

並且在配置中加入consul的相關配置，比如：

spring.cloud.consul.host=localhost
spring.cloud.consul.port=8500

更多相關配置請參與Spring Cloud Consul的配置文件。

公共配置

SCCA REST模組還有一個特別的配置scca.rest.context-path=/xhr，該配置主要用來配置所有SCCA REST模組介面的字首，該介面主要用於與SCCA UI模組對接時候使用，兩邊必須對接一致才能順利對接。

SCCA UI服務端的構建與配置

SCCA UI服務端需要引入以下核心依賴：

<dependency>
    <groupId>com.didispace</groupId>
    <artifactId>scca-ui</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

另外，還需要在配置中指定具體要訪問的SCCA REST模組的位置，主要有兩種模式：

  • 指定地址的配置：
scca.ui.rest-server-url=http://localhost:10130
  • 基於服務發現的配置：
scca.ui.rest-server-name=scca-rest-server

除了上面的配置之後，還需要引入eureka或consul的依賴以及做對應的配置

最後，還有一個scca.ui.rest-server-context-path=/xhr配置，用來描述要訪問的SCCA REST模組介面的字首，與SCCA REST服務端的scca.rest.context-path=/xhr配置相對應。

案例：SCCA UI 服務端

管理功能

通過之前介紹的任何一個部署方式搭建了配置中心和管理端之後，我們就可以開啟瀏覽器訪問我們的UI模組實現對配置中心的管理了。

訪問地址為：http://localhost:10032/admin/，ip與埠根據實際部署UI模組的情況進行調整。

系統配置

在管理各個專案的配置之前，我們需要先做一些基礎配置，比如：環境的配置、環境所屬的引數配置，加密相關的配置等。

環境配置

環境配置主要用來維護要使用SCCA統一管理的環境以及對應的Spring Cloud Config服務端資訊。

user-guilder-2.png

如上圖所示，通過“新增環境”按鈕可以新增一個部署環境。當我們使用了Eureka、Consul等註冊中心時，只需要配置註冊中心的訪問地址和配置中心的服務名以及配置中心訪問的字首，後續就可以方便的使用這個環境的配置中心來進行加密解密、拉取配置等一系列的操作了。

如果不採用服務發現的機制取找到配置中心，也可以將註冊中心地址留空，配置中心服務名一欄直接配置訪問註冊中心的URL即可。

環境引數配置

環境引數配置主要用來配置每個環境所屬的一些特有配置資訊，比如：redis的地址，eureka的地址等等。這些配置資訊將使用者後續為各專案在各個環境配置的時候給予參考和快捷的替換操作提供後設資料。

加密管理

加密管理主要用來維護一些通常需要加密的Key，這樣可以在後續編輯配置內容的時候，方便的進行批量加密操作。

配置中心

在完成了上面的系統配置之後，使用者就可以進入配置中心模組，這裡會提供具體的管理配置內容的功能。目前主要有兩部分組成：專案管理和配置管理。

專案管理

專案管理主要用來維護需要在各個環境部署的應用的配置資訊，這裡可以維護這個專案需要部署在什麼環境，有多少配置的版本。

user-guilder-4.png

這裡的三個基本概念與Spring Cloud Config的幾個概念的對應關係如下：

  • 專案名稱：application
  • 部署環境：profile
  • 配置版本：label

這裡配置版本（label），我們會預設採用master。需要同時存在多個配置版本，實現灰度配置的時候，使用者也可以自己新增label。

配置管理

配置管理功能是SCCA的核心，在這裡使用者可以方便對各個應用、各個環境、各個版本的配置進行編輯、加密等操作。同時，也提供了一些快捷的操作，比如：根據環境引數配置一鍵替換、根據加密Key清單實現一鍵加密、通過配置中心可以載入到的配置資訊等（更多便捷功能持續新增中...）

user-guilder-5.png

客戶端接入

本頁主要提供給沒有使用過Spring Cloud Config的使用者閱讀。如果您已經使用過Spring Cloud Config，那麼客戶端如何通過Spring Cloud Config的配置中心載入配置相信已經掌握，在使用本專案的時候，無非就是搭建SCCA-REST模組和SCCA-UI模組來幫助管理您目前的配置內容。

客戶端載入

通過前面幾節內容，如果您已經完成了SCCA中幾個要素的搭建，下面就來看看如何建立一個Spring Boot專案並通過配置中心來載入配置資訊。

絕對地址接入

1. 建立一個基本的Spring Boot專案，並在pom.xml中引入依賴

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>

2. 建立應用主類

@SpringBootApplication
public class Application {

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

}

3. 建立bootstrap.properties配置檔案（也可以使用yaml可以）

spring.application.name=config-client
server.port=12000

spring.cloud.config.uri=http://localhost:10032/scca-config-server
spring.cloud.config.profile=stage
spring.cloud.config.label=master

上述配置引數與scca中維護元素的對應關係如下：

  • spring.application.name：對應scca中的專案名
  • spring.cloud.config.profile：專案配置的環境名
  • spring.cloud.config.label：專案配置的版本名
  • spring.cloud.config.uri：配置中心的訪問絕對地址

服務發現接入

1. 建立一個基本的Spring Boot專案，並在pom.xml中引入依賴

<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>

上面以通過eureka做註冊中心的依賴，如果用consul，只需要將spring-cloud-starter-eureka換成spring-cloud-starter-consul-discovery即可。

2. 建立應用主類

@EnableDiscoveryClient
@SpringBootApplication
public class Application {

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

}

3. 建立bootstrap.properties配置檔案（也可以使用yaml可以）

spring.application.name=config-client
server.port=12000

spring.cloud.config.discovery.enabled=true
spring.cloud.config.discovery.serviceId=config-server
spring.cloud.config.profile=stage
spring.cloud.config.label=master

上述配置引數與scca中維護元素的對應關係如下：

  • spring.application.name：對應scca中的專案名
  • spring.cloud.config.profile：專案配置的環境名
  • spring.cloud.config.label：專案配置的版本名
  • spring.cloud.config.discovery.enabled：開啟服務發現功能
  • spring.cloud.config.discovery.serviceId：配置中心的服務名

讀取配置

通過上面的兩種方式從配置中心拉取配置之後，在Spring Boot專案中就可以輕鬆的使用所有配置內容了，比如：

@RefreshScope
@RestController
public class TestController {

    @Value("${a.b.c}")
    private String abc;

    @RequestMapping("/abc")
    public String abc() {
        return this.abc;
    }

}

兩個主要註解的說明：

  • @Value("${a.b.c}")：讀取配置key為a.b.c的value值
  • @RefreshScope：下面的配置資訊可以通過/refresh端點實現動態重新整理

其他參考

如果您還不瞭解Spring Cloud Config，您也可以閱讀下面的幾篇瞭解一下最原始的Spring Cloud Config配置中心和客戶端接入方式

相關文章