最近一致在更新Spring Cloud Config的相關(guān)內(nèi)容,主要也是為這篇埋個(gè)伏筆恰力,相信不少調(diào)研過Spring Cloud Config的用戶都會(huì)吐槽它的管理能力太弱狰右。因此貌嫡,就有了下面為講推薦的這個(gè)開源項(xiàng)目,希望對(duì)已經(jīng)入坑Spring Cloud Config的童鞋們有所幫助试和!
簡介
在Spring Cloud的微服務(wù)架構(gòu)方案中雖然提供了Spring Cloud Config來擔(dān)任配置中心的角色讯泣,但是該項(xiàng)目的功能在配置的管理層面還是非常欠缺的。初期我們可以依賴選取的配置存儲(chǔ)系統(tǒng)(比如:Gitlab阅悍、Github)給我們提供的配置管理界面來操作所有的配置信息好渠,但是這樣的管理還是非常粗粒度的昨稼,因此這個(gè)項(xiàng)目的目的就是解決這個(gè)問題,通過此項(xiàng)目拳锚,我們將提供一套基于Spring Cloud Config配置中心的可視化管理系統(tǒng)假栓。
在該項(xiàng)目中,我們對(duì)于服務(wù)治理霍掺、配置存儲(chǔ)匾荆、可視化操作都做了抽象,只要目的就是為了盡可能的兼容所有Spring Cloud Config的用戶杆烁。任何Spring Cloud Config僅需要通過一些簡單的配置牙丽,或者遷移工具就能將原來正在使用的配置中心統(tǒng)一的管理起來。
項(xiàng)目地址
Github: https://github.com/dyc87112/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
如果您覺得該項(xiàng)目對(duì)您有用兔魂,歡迎Star烤芦、Follow支持我們!
架構(gòu)概覽
本項(xiàng)目采用了前后端分離的架構(gòu)析校,通過core模塊抽象了前端需要的操作构罗,再通過persistence和discovery模塊隔離不同的配置倉庫和不同的服務(wù)注冊中心,從而達(dá)到前端程序不需要關(guān)心到底使用了什么存儲(chǔ)配置以及使用了什么注冊中心智玻,這樣用戶可以根據(jù)自己的需要自由的組合不同的配置存儲(chǔ)和服務(wù)治理機(jī)制遂唧,盡可能的匹配大部分Spring Cloud用戶的需求。
部署方式
由于SCCA的架構(gòu)對(duì)各個(gè)功能模塊做了比較細(xì)致的拆分吊奢,所以它存在多種不同模式的部署方式盖彭,所以它既可以為已經(jīng)在使用Spring Cloud Config提供服務(wù),也可以為從零開始使用Spring Cloud Config的用戶事甜。
在SCCA中我們的可部署內(nèi)容自底向上分為三個(gè)部分:
-
Spring Cloud 配置中心
:基于Spring Cloud Config構(gòu)建的配置中心服務(wù)端谬泌。 -
SCCA REST 服務(wù)端
:SCCA的核心模塊,實(shí)現(xiàn)了SCCA配置管理的持久化內(nèi)容以及所有的管理操作API逻谦。 -
SCCA UI 服務(wù)端
:SCCA的前端模塊,實(shí)現(xiàn)了可視化的配置管理操作界面陪蜻。
下面我們來看看SCCA支持哪些多樣的部署方式邦马。
全分離模式
全分離模式就是將上述三個(gè)部分都以獨(dú)立的進(jìn)程進(jìn)行部署,每一個(gè)部分都可以做高可用宴卖,具體部署結(jié)構(gòu)可以如下圖所示:
這種模式既可以適用于已經(jīng)在使用Spring Cloud Config的用戶滋将,也適用于正準(zhǔn)備開始適用的用戶。其中症昏,位于最底層的Spring Cloud配置中心
就是一個(gè)最原始的Spring Cloud Config Server随闽。所以,對(duì)于已經(jīng)在使用Spring Cloud Config的用戶只需要再部署一套SCCA REST 服務(wù)端
和SCCA UI 服務(wù)端
肝谭,并做一些配置就可以使用SCCA來管理所有的配置信息了掘宪。
案例
- SCCA UI 服務(wù)端
- SCCA REST 服務(wù)端(對(duì)接DB存儲(chǔ)的配置中心)
- SCCA REST 服務(wù)端(對(duì)接Git存儲(chǔ)的配置中心)
- Spring Cloud 配置中心(DB存儲(chǔ))
- Spring Cloud 配置中心(Git存儲(chǔ))
半分離模式
所謂的半分離模式就是將上述的三個(gè)模塊中的兩個(gè)進(jìn)行組合部署蛾扇,以降低復(fù)雜度的部署方式搏明。
SCCA UI模塊與SCCA REST模塊合并
如下圖所示创千,我們可以將SCCA UI服務(wù)端
與SCCA REST服務(wù)端
組合在一個(gè)程序中來部署晒喷,這樣可以有效的降低全分離模式的部署復(fù)雜度呀邢,同時(shí)對(duì)于已經(jīng)在使用Spring Cloud Config的用戶來說非常友好铺遂,已經(jīng)部署的配置中心可以繼續(xù)沿用蝙昙。
案例
注意:對(duì)接不同存儲(chǔ)配置中心的配置參考分離部署中兩個(gè)SCCA REST服務(wù)端的不同配置內(nèi)容進(jìn)行調(diào)整疚鲤。
All-In-One模式
最后介紹一種比較暴力的使用模式啸如,SCCA支持將所有三個(gè)模塊整合在一起使用和部署腥寇,在一個(gè)Spring Boot應(yīng)用中同時(shí)包含:Spring Cloud 配置中心
成翩、SCCA REST 服務(wù)端
以及SCCA UI 服務(wù)端
,具體如下所示:
案例
配置詳解
本章節(jié)分別對(duì)三個(gè)核心模塊的構(gòu)建方式以及核心的配置內(nèi)容赦役。下面所有的構(gòu)建都是基于Spring Boot構(gòu)建的捕传,所以您需要對(duì)Spring Boot項(xiàng)目的構(gòu)建有基本的認(rèn)識(shí),這里不做介紹扩劝。
Spring Cloud配置中心的構(gòu)建與配置
在SCCA的架構(gòu)中庸论,配置中心的核心完全采用Spring Cloud Config,所以如何構(gòu)建一個(gè)配置中心完全遵循Spring Cloud Config的使用方法棒呛。由于目前SCCA的REST模塊主要實(shí)現(xiàn)了對(duì)Git存儲(chǔ)和DB存儲(chǔ)的綜合管理聂示,所以對(duì)于Spring Cloud Config的使用也只能支持這兩種模式。下面分別介紹兩種配置中心的搭建與配置簇秒。
Git存儲(chǔ)模式
這里主要介紹幾種主要的并且SCCA能夠比較好支持的配置模式:
第一種:多個(gè)項(xiàng)目使用多個(gè)不同Git倉庫存儲(chǔ)的模式
spring.cloud.config.server.git.uri=https://github.com/dyc87112/{application}.git
spring.cloud.config.server.git.username=
spring.cloud.config.server.git.password=
這種模式下不同的項(xiàng)目會(huì)對(duì)應(yīng)的不同的Git倉庫鱼喉,如果項(xiàng)目中spring.application.name=user-service
,那么它的配置倉庫會(huì)定位到https://github.com/dyc87112/user-service.git
倉庫下的配置趋观。配置文件按application-{profile}.properties
的格式存儲(chǔ)扛禽,{profile}
代表環(huán)境名。
第二種:多個(gè)項(xiàng)目公用一個(gè)Git倉庫不同目錄的存儲(chǔ)模式
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=
這種模式下不同的項(xiàng)目會(huì)對(duì)應(yīng)到https://github.com/dyc87112/config-repo.git
倉庫下的不同目錄皱坛,如果項(xiàng)目中spring.application.name=user-service
编曼,那么它的配置倉庫會(huì)定位到https://github.com/dyc87112/config-repo.git
倉庫下的/user-service
目錄。配置文件按application-{profile}.properties
的格式存儲(chǔ)剩辟,{profile}
代表環(huán)境名掐场。
Db存儲(chǔ)模式
在使用Db存儲(chǔ)模式的時(shí)候,必須使用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
主要分為兩個(gè)部分:
- 激活采用DB存儲(chǔ)的模式:將
spring.profiles.active
設(shè)置為jdbc,同時(shí)指定獲取配置的SQL吭服,用戶直接復(fù)制采用一樣的配置即可嚷堡。 - 指定存儲(chǔ)配置的DB連接信息,除了mysql之外也可以使用其他主流關(guān)系型數(shù)據(jù)庫艇棕。
這里需要注意的蝌戒,使用的DB要與后續(xù)介紹的SCCA REST模塊采用同一個(gè)DB
SCCA REST服務(wù)端的構(gòu)建與配置
在構(gòu)建SCCA REST服務(wù)端的時(shí)候針對(duì)對(duì)接不同的配置存儲(chǔ)有一些不同的配置要求串塑,所以下面按目前支持的存儲(chǔ)模式做不同的介紹。
Git存儲(chǔ)模式
當(dāng)對(duì)接的配置中心采用Git存儲(chǔ)的時(shí)候瓶颠,需要引入以下核心依賴:
<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
主要兩部分:
- 對(duì)接的git存儲(chǔ)的配置:
-
scca.git.username
:訪問git的用戶名 -
scca.git.password
:訪問git的密碼 -
scca.git.repo-uri
:配置git倉庫的地址拟赊,與配置中心的spring.cloud.config.server.git.uri
配置一致 -
scca.git.base-path
:配置文件存儲(chǔ)的相對(duì)路徑,與配置中心的spring.cloud.config.server.git.search-paths
配置一致 -
scca.git.file-pattern
:配置文件的命名規(guī)則
-
- SCCA內(nèi)部邏輯的存儲(chǔ)庫數(shù)據(jù)源信息
Db存儲(chǔ)模式
當(dāng)對(duì)接的配置中心采用Git存儲(chǔ)的時(shí)候粹淋,需要引入以下核心依賴:
<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
需要注意吸祟,當(dāng)配置中心采用DB存儲(chǔ)的時(shí)候,這里的數(shù)據(jù)源需要一致
服務(wù)發(fā)現(xiàn)支持
如果SCCA REST模塊在訪問配置中心的時(shí)候基于服務(wù)發(fā)現(xiàn)的話還需要引入對(duì)應(yīng)的支持依賴和配置
與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/
更多相關(guān)配置請參與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的相關(guān)配置过吻,比如:
spring.cloud.consul.host=localhost
spring.cloud.consul.port=8500
更多相關(guān)配置請參與Spring Cloud Consul的配置文檔。
公共配置
SCCA REST模塊還有一個(gè)特別的配置scca.rest.context-path=/xhr
蔗衡,該配置主要用來配置所有SCCA REST模塊接口的前綴纤虽,該接口主要用于與SCCA UI模塊對(duì)接時(shí)候使用,兩邊必須對(duì)接一致才能順利對(duì)接绞惦。
SCCA UI服務(wù)端的構(gòu)建與配置
SCCA UI服務(wù)端需要引入以下核心依賴:
<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
- 基于服務(wù)發(fā)現(xiàn)的配置:
scca.ui.rest-server-name=scca-rest-server
除了上面的配置之后济蝉,還需要引入eureka或consul的依賴以及做對(duì)應(yīng)的配置
最后杰刽,還有一個(gè)scca.ui.rest-server-context-path=/xhr
配置,用來描述要訪問的SCCA REST模塊接口的前綴王滤,與SCCA REST服務(wù)端的scca.rest.context-path=/xhr
配置相對(duì)應(yīng)贺嫂。
管理功能
通過之前介紹的任何一個(gè)部署方式搭建了配置中心和管理端之后,我們就可以打開瀏覽器訪問我們的UI模塊實(shí)現(xiàn)對(duì)配置中心的管理了雁乡。
訪問地址為:http://localhost:10032/admin/
第喳,ip與端口根據(jù)實(shí)際部署UI模塊的情況進(jìn)行調(diào)整。
系統(tǒng)配置
在管理各個(gè)項(xiàng)目的配置之前蔗怠,我們需要先做一些基礎(chǔ)配置墩弯,比如:環(huán)境的配置、環(huán)境所屬的參數(shù)配置寞射,加密相關(guān)的配置等。
環(huán)境配置
環(huán)境配置主要用來維護(hù)要使用SCCA統(tǒng)一管理的環(huán)境以及對(duì)應(yīng)的Spring Cloud Config服務(wù)端信息锌钮。
如上圖所示桥温,通過“新增環(huán)境”按鈕可以添加一個(gè)部署環(huán)境。當(dāng)我們使用了Eureka梁丘、Consul等注冊中心時(shí)侵浸,只需要配置注冊中心的訪問地址和配置中心的服務(wù)名以及配置中心訪問的前綴旺韭,后續(xù)就可以方便的使用這個(gè)環(huán)境的配置中心來進(jìn)行加密解密、拉取配置等一系列的操作了掏觉。
如果不采用服務(wù)發(fā)現(xiàn)的機(jī)制取找到配置中心区端,也可以將注冊中心地址留空,配置中心服務(wù)名一欄直接配置訪問注冊中心的URL即可澳腹。
環(huán)境參數(shù)配置
環(huán)境參數(shù)配置主要用來配置每個(gè)環(huán)境所屬的一些特有配置信息织盼,比如:redis的地址,eureka的地址等等酱塔。這些配置信息將用戶后續(xù)為各項(xiàng)目在各個(gè)環(huán)境配置的時(shí)候給予參考和快捷的替換操作提供元數(shù)據(jù)沥邻。
加密管理
加密管理主要用來維護(hù)一些通常需要加密的Key,這樣可以在后續(xù)編輯配置內(nèi)容的時(shí)候羊娃,方便的進(jìn)行批量加密操作唐全。
配置中心
在完成了上面的系統(tǒng)配置之后,用戶就可以進(jìn)入配置中心模塊蕊玷,這里會(huì)提供具體的管理配置內(nèi)容的功能邮利。目前主要有兩部分組成:項(xiàng)目管理和配置管理。
項(xiàng)目管理
項(xiàng)目管理主要用來維護(hù)需要在各個(gè)環(huán)境部署的應(yīng)用的配置信息垃帅,這里可以維護(hù)這個(gè)項(xiàng)目需要部署在什么環(huán)境延届,有多少配置的版本。
這里的三個(gè)基本概念與Spring Cloud Config的幾個(gè)概念的對(duì)應(yīng)關(guān)系如下:
- 項(xiàng)目名稱:application
- 部署環(huán)境:profile
- 配置版本:label
這里配置版本(label)挺智,我們會(huì)默認(rèn)采用
master
祷愉。需要同時(shí)存在多個(gè)配置版本,實(shí)現(xiàn)灰度配置的時(shí)候赦颇,用戶也可以自己添加label二鳄。
配置管理
配置管理功能是SCCA的核心,在這里用戶可以方便對(duì)各個(gè)應(yīng)用媒怯、各個(gè)環(huán)境订讼、各個(gè)版本的配置進(jìn)行編輯、加密等操作扇苞。同時(shí)欺殿,也提供了一些快捷的操作,比如:根據(jù)環(huán)境參數(shù)配置一鍵替換鳖敷、根據(jù)加密Key清單實(shí)現(xiàn)一鍵加密脖苏、通過配置中心可以加載到的配置信息等(更多便捷功能持續(xù)添加中...)
客戶端接入
本頁主要提供給沒有使用過Spring Cloud Config的用戶閱讀。如果您已經(jīng)使用過Spring Cloud Config定踱,那么客戶端如何通過Spring Cloud Config的配置中心加載配置相信已經(jīng)掌握棍潘,在使用本項(xiàng)目的時(shí)候,無非就是搭建SCCA-REST模塊和SCCA-UI模塊來幫助管理您目前的配置內(nèi)容。
客戶端加載
通過前面幾節(jié)內(nèi)容亦歉,如果您已經(jīng)完成了SCCA中幾個(gè)要素的搭建恤浪,下面就來看看如何創(chuàng)建一個(gè)Spring Boot項(xiàng)目并通過配置中心來加載配置信息。
絕對(duì)地址接入
1. 創(chuàng)建一個(gè)基本的Spring Boot項(xiàng)目肴楷,并在pom.xml中引入依賴
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
2. 創(chuàng)建應(yīng)用主類
@SpringBootApplication
public class Application {
public static void main(String[] args) {
new SpringApplicationBuilder(Application.class).web(true).run(args);
}
}
3. 創(chuàng)建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
上述配置參數(shù)與scca中維護(hù)元素的對(duì)應(yīng)關(guān)系如下:
- spring.application.name:對(duì)應(yīng)scca中的項(xiàng)目名
- spring.cloud.config.profile:項(xiàng)目配置的環(huán)境名
- spring.cloud.config.label:項(xiàng)目配置的版本名
- spring.cloud.config.uri:配置中心的訪問絕對(duì)地址
服務(wù)發(fā)現(xiàn)接入
1. 創(chuàng)建一個(gè)基本的Spring Boot項(xiàng)目水由,并在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. 創(chuàng)建應(yīng)用主類
@EnableDiscoveryClient
@SpringBootApplication
public class Application {
public static void main(String[] args) {
new SpringApplicationBuilder(Application.class).web(true).run(args);
}
}
3. 創(chuàng)建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
上述配置參數(shù)與scca中維護(hù)元素的對(duì)應(yīng)關(guān)系如下:
- spring.application.name:對(duì)應(yīng)scca中的項(xiàng)目名
- spring.cloud.config.profile:項(xiàng)目配置的環(huán)境名
- spring.cloud.config.label:項(xiàng)目配置的版本名
- spring.cloud.config.discovery.enabled:開啟服務(wù)發(fā)現(xiàn)功能
- spring.cloud.config.discovery.serviceId:配置中心的服務(wù)名
讀取配置
通過上面的兩種方式從配置中心拉取配置之后,在Spring Boot項(xiàng)目中就可以輕松的使用所有配置內(nèi)容了濒募,比如:
@RefreshScope
@RestController
public class TestController {
@Value("${a.b.c}")
private String abc;
@RequestMapping("/abc")
public String abc() {
return this.abc;
}
}
兩個(gè)主要注解的說明:
-
@Value("${a.b.c}")
:讀取配置key為a.b.c
的value值 -
@RefreshScope
:下面的配置信息可以通過/refresh
端點(diǎn)實(shí)現(xiàn)動(dòng)態(tài)刷新
其他參考
如果您還不了解Spring Cloud Config鞭盟,您也可以閱讀下面的幾篇了解一下最原始的Spring Cloud Config配置中心和客戶端接入方式