springcloud 之配置中心(Config)使用詳解

前言

本篇主要介紹的是SpringCloud中的分佈式配置中心(SpringCloud Config)的相關使用教程。

SpringCloud Config

Config 介紹

Spring Cloud Config項目是一個解決分佈式系統的配置管理方案。它包含了Client和Server兩個部分，server提供配置文件的存儲、以接口的形式將配置文件的內容提供出去，client通過接口獲取數據、並依據此數據初始化自己的應用。

開發準備

開發環境

JDK:1.8
SpringBoot:2.1.1.RELEASE
SpringCloud：Finchley

注:不一定非要用上述的版本，可以根據情況進行相應的調整。需要注意的是SpringBoot2.x以後，jdk的版本必須是1.8以上！

確認了開發環境之後，我們再來添加相關的pom依賴。

<dependencies>
       <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    </dependency>
  </dependencies>

SpringCloud Config 示例

目前SpringCloud Config的使用主要是通過Git/SVN方式做一個配置中心，然後每個服務從其中獲取自身配置所需的參數。SpringCloud Config也支持本地參數配置的獲取。如果使用本地存儲的方式，在 application.properties 或 application.yml 文件添加 spring.profiles.active=native 配置即可，它會從項目的 resources路徑下讀取配置文件。如果是讀取指定的配置文件，那麼可以使用 spring.cloud.config.server.native.searchLocations = file:D:/properties/ 來讀取。

服務端

首先是服務端這塊，首先創建一個註冊中心，爲了進行區分，創建一個springcloud-config-eureka的項目。代碼和配置和之前的基本一樣。
application.properties配置信息:

配置信息:

spring.application.name=springcloud-hystrix-eureka-server
server.port=8005
eureka.client.register-with-eureka=false
eureka.client.fetch-registry=false
eureka.client.serviceUrl.defaultZone=http://localhost:8005/eureka/

配置說明:

spring.application.name：這個是指定服務名稱。
server.port:服務指定的端口。
eureka.client.register-with-eureka：表示是否將自己註冊到Eureka Server，默認是true。
eureka.client.fetch-registry：表示是否從Eureka Server獲取註冊信息，默認爲true。
eureka.client.serviceUrl.defaultZone：這個是設置與Eureka Server交互的地址，客戶端的查詢服務和註冊服務都需要依賴這個地址。

服務端這邊只需要在SpringBoot啓動類添加@EnableEurekaServer註解就可以了，該註解表示此服務是一個服務註冊中心服務。

代碼示例:

@SpringBootApplication

@EnableEurekaServer

public class ConfigEurekaApplication {

public static void main(String[] args) {

SpringApplication.run(ConfigEurekaApplication.class, args);

System.out.println("config 註冊中心服務啓動...");

}

}

創建好了註冊中心之後，我們再來創建一個配置中心，用於管理配置。
創建一個springcloud-config-server的項目。然後在application.properties配置文件添加如下配置:

配置信息:

spring.application.name=springcloud-config-server
server.port=9005
eureka.client.serviceUrl.defaultZone=http://localhost:8005/eureka/
spring.cloud.config.server.git.uri = https://github.com/xuwujing/springcloud-study/
spring.cloud.config.server.git.search-paths = /springcloud-config/config-repo
spring.cloud.config.server.git.username = 
spring.cloud.config.server.git.password =

配置說明:

spring.application.name：這個是指定服務名稱。
server.port:服務指定的端口。
eureka.client.serviceUrl.defaultZone：這個是設置與Eureka Server交互的地址，客戶端的查詢服務和註冊服務都需要依賴這個地址。
spring.cloud.config.server.git.uri: 配置的Git長褲的地址。
spring.cloud.config.server.git.search-paths: git倉庫地址下的相對地址多個用逗號”,”分割。
spring.cloud.config.server.git.username:git倉庫的賬號。
spring.cloud.config.server.git.password:git倉庫的密碼。

注:如果想使用本地方式讀取配置信息，那麼只需將spring.cloud.config.server.git的配置改成spring.profiles.active=native，然後在resources路徑下新增一個文件即可。

這裏爲了進行本地配置文件測試，新建一個configtest.properties配置文件，添加如下內容:

word=hello world

代碼這塊也很簡單，在程序主類中，額外添加@EnableConfigServer註解，該註解表示啓用config配置中心功能。代碼如下:

、、、

@EnableDiscoveryClient
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConfigServerApplication.class, args);
        System.out.println("配置中心服務端啓動成功!");
    }
}

、、、

完成上述代碼之後，我們的配置中心服務端已經構建完成了。

客戶端

我們新建一個springcloud-config-client的項目，用於做讀取配置中心的配置。pom依賴還是和配置中心一樣，不過需要新增一個配置，用於指定配置的讀取。
創建一個bootstrap.properties文件，並添加如下信息:

配置信息:

spring.cloud.config.name=configtest
spring.cloud.config.profile=pro
spring.cloud.config.label=master
spring.cloud.config.discovery.enabled=true
spring.cloud.config.discovery.serviceId=springcloud-config-server
eureka.client.serviceUrl.defaultZone=http://localhost:8005/eureka/

配置說明:

spring.cloud.config.name：獲取配置文件的名稱。
spring.cloud.config.profile: 獲取配置的策略。
spring.cloud.config.label：獲取配置文件的分支，默認是master。如果是是本地獲取的話，則無用。
spring.cloud.config.discovery.enabled: 開啓配置信息發現。
spring.cloud.config.discovery.serviceId: 指定配置中心的service-id，便於擴展爲高可用配置集羣。
eureka.client.serviceUrl.defaultZone：這個是設置與Eureka Server交互的地址，客戶端的查詢服務和註冊服務都需要依賴這個地址。

注:上面這些與spring-cloud相關的屬性必須配置在bootstrap.properties中，config部分內容才能被正確加載。因爲bootstrap.properties的相關配置會先於application.properties，而bootstrap.properties的加載也是先於application.properties。需要注意的是eureka.client.serviceUrl.defaultZone要配置在bootstrap.properties，不然客戶端是無法獲取配置中心參數的，會啓動失敗！

application.properties配置

spring.application.name=springcloud-config-client
server.port=9006

配置說明:

spring.application.name：這個是指定服務名稱。
server.port:服務指定的端口。

程序主類代碼，和之前的基本一致。代碼如下:

代碼示例:

@EnableDiscoveryClient

@SpringBootApplication

public class ConfigClientApplication {

public static void main(String[] args) {

SpringApplication.run(ConfigClientApplication.class, args);

System.out.println("配置中心客戶端啓動成功!");

}

}

爲了方便查詢，在控制中進行參數的獲取，並返回。@Value註解是默認是從application.properties配置文件獲取參數，但是這裏我們在客戶端並沒有進行配置，該配置在配置中心服務端，我們只需指定好了配置文件之後即可進行使用。

代碼示例:


@RestController

public class ClientController {

@Value("${word}")

private String word;

@RequestMapping("/hello")

public String index(@RequestParam String name) {

return name+","+this.word;

}

}

到此，客戶端項目也就構建完成了。

功能測試

完成如上的工程開發之後，我們來進行測試。

本地測試

首先我們把springcloud-config-server項目的application.properties配置文件添加spring.profiles.active=native配置，註釋掉spring.cloud.config.server.git相關的配置，然後在src/main/resources目錄下新建一個configtest.properties文件，然後在裏面添加一個配置word=hello world。
添加完成之後，我們依次啓動springcloud-config-eureka、springcloud-config-server、springcloud-config-client這三個項目。啓動成功之前，先看來看看配置中心服務端的配置文件獲取，在瀏覽器輸入:

http://localhost:9005/configtest-1.properties

查看該文件的配置信息。

注:配置文件的名稱是configtest.properties，但是如果直接該名稱的話是獲取不到的，因爲在配置文件名需要通過-來進行獲取，如果配置文件名稱沒有-，那麼添加了-之後，會自動進行匹配搜索。

springcloud config 的URL與配置文件的映射關係如下:

/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties

上面的url會映射{application}-{profile}.properties對應的配置文件，{label}對應git上不同的分支，默認爲master。

界面返回:

word: hello world

然後調用客戶端的接口，查看是否能夠獲取配置信息。在瀏覽器上輸入:

http://localhost:9006//hello?name=pancm

界面返回:

pancm,hello world

示例圖:

Git測試

在完成本地測試之後，我們把這個spring.profiles.active=native配置註釋掉，解除spring.cloud.config.server.git相關的註釋(賬號和密碼要填寫真實的)，然後在git倉庫上建立一個config-repo 文件夾，新建configtest-pro.properties、configtest-dev.properties兩個配置，這兩個的配置分別是word=hello world！！和word=hello world！，然後和configtest.properties配置文件一起上傳到config-repo 文件夾中。

首先在瀏覽器輸入：

http://localhost:9005/configtest-dev.properties

瀏覽器返回:

word: hello world!

然後再瀏覽器輸入:

http://localhost:9005/configtest-pro.properties

瀏覽器返回:

word: hello world!!

上傳了configtest.properties文件，但是這個文件名稱沒有-,我們想獲取其中參數的信息的話，可以在然後-隨意添加一個參數，它會自動進行匹配，在瀏覽器輸入:

http://localhost:9005/configtest-1.properties

瀏覽器返回:

word: hello world

然後進行客戶端接口調用測試，在瀏覽器輸入:

http://localhost:9006/hello?name=pancm

瀏覽器返回:

pancm,Hello World!!

由於這裏我配置的前綴是 pro ，所以讀取的是 configtest-pro.properties 文件的數據，想要獲取其他的配置，修改spring.cloud.config.profile配置即可。

示例圖:

springcloud 之配置中心(Config)使用詳解

前言

SpringCloud Config

Config 介紹

開發準備

SpringCloud Config 示例

功能測試

985 碩士程序員，空窗 4 個月沒有 Offer！

一文搞懂 Spring 循環依賴

賽博鬥地主——使用大語言模型扮演Agent智能體玩牌類遊戲。

VScode右鍵打開(添加到右鍵)

JVM Class詳解之二 Method字節碼指令

單體架構，垂直架構，SOA架構和微服務架構的變化歷程

idea 中添加類註釋和方法註釋模板

mybatis如何在控制檯打印sql語句

spring boot過濾器FilterRegistrationBean

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結