springcloud-config-client的那些坑

坑一：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用來存放配置文件，爲了模擬生產環境，咱們建立如下兩個配置文件：

server 端

一、添加依賴

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

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

二、配置文件

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的方式。

三、啓動類

啓動類添加@EnableConfigServer，激活對配置中心的支持

@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

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

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

server段很簡單不會有太多坑

四、測試

首先咱們先要測試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端的配置信息

一、添加依賴

<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>複製代碼

二、配置文件

須要配置兩個配置文件，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。

三、啓動類

啓動類不要添加@EnableConfigServer，激活對配置中心的支持

@SpringBootApplication
public class ConfigClientApplication {

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

啓動類只須要@SpringBootApplication註解就能夠

四、web測試

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

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

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