5--SpringCloud搭建分散式配置中心
Spring Cloud Config為服務端和客戶端提供了分散式系統的外部化配置支援。配置伺服器為各應用的所有環境提供了一箇中心化的外部配置。作為一個應用可以通過部署管道來進行測試或者投入生產,我們可以分別為這些環境建立配置,並且在需要遷移環境的時候獲取對應環境的配置來執行。
配置伺服器預設採用git來儲存配置資訊,這樣就有助於對環境配置進行版本管理,並且可以通過git客戶端工具來方便的管理和訪問配置內容。當然他也提供本地化檔案系統的儲存方式,下面從這兩方面介紹如何使用分散式配置來儲存微服務應用多環境的配置內容。
構建Config Server
建立一個簡單的springBoot專案 pom加上依賴
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.3.5.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency> </dependencies> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Brixton.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
建立Spring Boot的程式主類,並新增@EnableConfigServer
註解,開啟Config Server
@EnableConfigServer @SpringBootApplication public class Application { public static void main(String[] args) { new SpringApplicationBuilder(Application.class).web(true).run(args); }
建立application.properties配置檔案
spring.application.name=config-server server.port=7001 # git配置 #所在專案根目錄 配置git倉庫位置 spring.cloud.config.server.git.uri=https://gitee.com/cengjiang/springcloud_learning/ #所在地址目錄 配置倉庫路徑下的相對搜尋位置,可以配置多個 spring.cloud.config.server.git.searchPaths=5--SpringCloud--Config #如果是公開專案則不用寫使用者名稱密碼 spring.cloud.config.server.git.username=username spring.cloud.config.server.git.password=password
到這裡,使用一個通過Spring Cloud Config實現,並使用git管理內容的配置中心已經完成了,啟動該應用,成功後開始下面的內容。
Spring Cloud Config也提供本地儲存配置的方式。我們只需要設定屬性spring.profiles.active=native
,Config Server會預設從應用的src/main/resource
目錄下檢索配置檔案。也可以通過spring.cloud.config.server.native.searchLocations=file:F:/properties/
屬性來指定配置檔案的位置。雖然Spring Cloud Config提供了這樣的功能,但是為了支援更好的管理內容和版本控制的功能,還是推薦使用git的方式。
伺服器端驗證
我的git倉庫是在碼雲上建立的,裡面存放在springCloud系列的示例程式碼。大家不想建立git倉庫的也可以使用我這個地址。
在倉庫地址https://gitee.com/cengjiang/springcloud_learning/下面建立了一個目錄5--SpringCloud--Confi存放配置檔案作為配置倉庫,並根據不同環境新建了下面四個配置檔案:
其中設定了一個from屬性,為每個配置檔案分別設定了不同的值,如:
from=git-default-1.0
from=git-dev-1.0
from=git-test-1.0
from=git-prod-1.0
為了測試版本控制,在master中,我們都加入1.0的字尾,同時建立一個config-label-test分支,並將各配置檔案中的值用2.0作為字尾。
URL與配置檔案的對映關係如下: application(應用)、profile(環境)、label(分支)
/{application}/{profile}[/{label}]
yml檔案:
/{application}-{profile}.yml
/{application}-{profile}/{label}.yml
properties
/{application}-{profile}.properties
/{application}-{profile}/{label}.properties
訪問:
{label}
對應git上不同的分支,預設為master。
微服務端對映配置
在完成並驗證了配置服務中心之後,下面看看我們如何在微服務應用中獲取配置資訊。
建立一個簡單的springBoot專案config-client pom加上依賴
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.3.5.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency> </dependencies> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Brixton.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
建立啟動主類
@SpringBootApplication public class Application { public static void main(String[] args) { new SpringApplicationBuilder(Application.class).web(true).run(args); } }
建立bootstrap.properties
#對應前配置檔案中的{application}部分 spring.application.name=ghghspace #對應前配置檔案中的{profile}部分 spring.cloud.config.profile=dev #對應前配置檔案的git分支 spring.cloud.config.label=master #配置中心的訪問地址 spring.cloud.config.uri=http://localhost:7001/ server.port=7002
這裡需要格外注意:上面這些屬性必須配置在bootstrap.properties
中,config部分內容才能被正確載入。因為config的相關配置會先於application.properties
,而bootstrap.properties
的載入也是先於application.properties
。
建立一個Rest Api來返回配置中心的from屬性,具體如下:
@RefreshScope @RestController public class TestController { @Value("${from}") private String from; @RequestMapping("/from") public String from() { return this.from; } }
通過@Value("${from}")
繫結配置服務中配置的from屬性。