springcloud-config-client的那些坑

王小胖醬發表於2019-01-24
SpringGCCloudclient

坑一：client啟動類不要新增@EnableConfigServer，不要新增 

<dependencies>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-config-server</artifactId>
	</dependency>
</dependencies>複製程式碼

 否則會獲取不到配置檔案引數並報錯


坑二：

#bootstrap.properties 載入優先於 application.properties 所以註冊中心要寫在bootstrap.properties中，否則無法載入git伺服器配置檔案
eureka.client.serviceUrl.defaultZone=http://localhost:8080/eureka/複製程式碼

Spring Cloud Config

在我們瞭解spring cloud config之前，我可以想想一個配置中心提供的核心功能應該有什麼

  • 提供服務端和客戶端支援
  • 集中管理各環境的配置檔案
  • 配置檔案修改之後，可以快速的生效
  • 可以進行版本管理
  • 支援大的併發查詢
  • 支援各種語言

Spring Cloud Config可以完美的支援以上所有的需求。

Spring Cloud Config專案是一個解決分散式系統的配置管理方案。它包含了Client和Server兩個部分，server提供配置檔案的儲存、以介面的形式將配置檔案的內容提供出去，client通過介面獲取資料、並依據此資料初始化自己的應用。Spring cloud使用git或svn存放配置檔案，預設情況下使用git，我們先以git為例做一套示例。

首先在github上面建立了一個資料夾config-repo用來存放配置檔案，為了模擬生產環境，我們建立以下兩個配置檔案：

springcloud-config-client的那些坑

server 端

1、新增依賴

<dependencies>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-config-server</artifactId>
	</dependency>
</dependencies>複製程式碼

只需要加入spring-cloud-config-server包引用既可。

2、配置檔案

server.port=8088
spring.application.name=leisure-config

# 配置git倉庫地址
spring.cloud.config.server.git.uri=https://gitee.com/leisure-w/config-repo/
# 配置倉庫下相對地址，可以配置多個，用，分割
#spring.cloud.config.server.git.search-paths=myconfigpath
# 配置倉庫的分支
spring.cloud.config.label=master
# 訪問git倉庫的使用者名稱
#spring.cloud.config.server.git.username=xxxooo
# 訪問git倉庫的使用者密碼 如果Git倉庫為公開倉庫，可以不填寫使用者名稱和密碼，如果是私有倉庫需要填寫
#spring.cloud.config.server.git.password=xxxooo
# 註冊地址
eureka.client.serviceUrl.defaultZone=http://localhost:8080/eureka/複製程式碼

Spring Cloud Config也提供本地儲存配置的方式。我們只需要設定屬性spring.profiles.active=native，Config Server會預設從應用的src/main/resource目錄下檢索配置檔案。也可以通過spring.cloud.config.server.native.searchLocations=file:E:/properties/屬性來指定配置檔案的位置。雖然Spring Cloud Config提供了這樣的功能，但是為了支援更好的管理內容和版本控制的功能，還是推薦使用git的方式。

3、啟動類

啟動類新增@EnableConfigServer，啟用對配置中心的支援

@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

	public static void main(String[] args) {
		SpringApplication.run(ConfigServerApplication.class, args);
	}
}複製程式碼

到此server端相關配置已經完成

server段很簡單不會有太多坑

4、測試

首先我們先要測試server端是否可以讀取到github上面的配置資訊，直接訪問：http://localhost:8088/leisure-config/company

返回資訊如下：

<Environment><name>leisure-config</name><profiles><profiles>company</profiles></profiles><label/><version>bb1b25ea69a966f22905783a3a509f15f4b70685</version><state/><propertySources><propertySources><name>https://gitee.com/leisure-w/config-repo/leisure-config-company.properties</name><source><leisure>hello update company!</leisure></source></propertySources></propertySources></Environment>複製程式碼

上述的返回的資訊包含了配置檔案的位置、版本、配置檔案的名稱以及配置檔案中的具體內容，說明server端已經成功獲取了git倉庫的配置資訊。

如果直接檢視配置檔案中的配置資訊可訪問：http://localhost:8088/leisure-config-company.properties，返回："hello update company!"

修改配置檔案leisure-config-company.properties中配置資訊為：leisure.hello=hello company!,再次在瀏覽器訪問http://localhost:8088/leisure-config-company.properties，返回：hello company!。說明server端會自動讀取最新提交的內容

倉庫中的配置檔案會被轉換成web介面，訪問可以參照以下的規則：

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

以leisure-config-company.properties為例子，它的application是leisure-config，profile是company。client會根據填寫的引數來選擇讀取對應的配置。

client 端

主要展示如何在業務專案中去獲取server端的配置資訊

1、新增依賴

<dependencies>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-config</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-web</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-test</artifactId>
		<scope>test</scope>
	</dependency>
</dependencies>複製程式碼


2、配置檔案

需要配置兩個配置檔案，application.properties和bootstrap.properties

application.properties如下：

spring.application.name=spring-cloud-config-client
server.port=8002複製程式碼

bootstrap.properties如下：

spring.cloud.config.name=neo-config
spring.cloud.config.profile=dev
spring.cloud.config.uri=http://localhost:8001/
spring.cloud.config.label=master複製程式碼

  • spring.application.name：對應{application}部分
  • spring.cloud.config.profile：對應{profile}部分
  • spring.cloud.config.label：對應git的分支。如果配置中心使用的是本地儲存，則該引數無用
  • spring.cloud.config.uri：配置中心的具體地址
  • spring.cloud.config.discovery.service-id：指定配置中心的service-id，便於擴充套件為高可用配置叢集。

特別注意：上面這些與spring-cloud相關的屬性必須配置在bootstrap.properties中，config部分內容才能被正確載入。因為config的相關配置會先於application.properties，而bootstrap.properties的載入也是先於application.properties。

3、啟動類

啟動類不要新增@EnableConfigServer，啟用對配置中心的支援

@SpringBootApplication
public class ConfigClientApplication {

	public static void main(String[] args) {
		SpringApplication.run(ConfigClientApplication.class, args);
	}
}複製程式碼

啟動類只需要@SpringBootApplication註解就可以

4、web測試

使用@Value註解來獲取server端引數的值

@RestController
class HelloController {
    @Value("${neo.hello}")
    private String hello;

    @RequestMapping("/hello")
    public String from() {
        return this.hello;
    }
}複製程式碼


相關文章