Spring Cloud構建統一配置中心

小兵2147775633發表於2019-02-15

Spring Boot有一個非常重要的改變就是簡化了配置,使用application.properties檔案定義了很多預設配置。願意瞭解原始碼的朋友直接求求交流分享技術 一零三八七七四六二六

但是配置檔案分開管理來還是比較麻煩的,而且環境越多配置約容易出問題。Spring Cloud提供了一種統一配置的方案:Spring Cloud Config Server。

Spring Cloud Config專案是一個解決分散式系統的配置管理方案。它包含了Client和Server兩個部分。

Server端配置

Spring Cloud Config Server本質上也是一個Spring Boot的web專案,只需要新增對應的parent,然後加入相關的依賴就可以啟動這個工程了。

Maven的pom.xml中需要新增以下內容:

<parent>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-parent</artifactId>
    <version>Brixton.BUILD-SNAPSHOT</version>
    <relativePath /> <!-- lookup parent from repository -->
</parent>

<dependencies>

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

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

<!-- repositories also needed for snapshots and milestones -->

<repositories>
    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>http://repo.spring.io/libs-snapshot-local</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>http://repo.spring.io/libs-milestone-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-releases</id>
        <name>Spring Releases</name>
        <url>http://repo.spring.io/libs-release-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>
<pluginRepositories>
    <pluginRepository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>http://repo.spring.io/libs-snapshot-local</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </pluginRepository>
    <pluginRepository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>http://repo.spring.io/libs-milestone-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </pluginRepository>
</pluginRepositories>

config server的resource目錄下的application.properties:
server.port=8888
spring.cloud.config.server.git.uri=file://Users/whthomas/config-repo

spring.application.name=configserver
spring.cloud.config.uri=http://localhost:8888
複製程式碼

啟動專案的程式碼:

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

其實和一般的SpringBoot專案啟動沒有什麼區別,只是多了一個@EnableConfigServer註解。 配置環境倉庫( Environment Repository ) 上面的application.properties中有一個

spring.cloud.config.server.git.uri=file://Users/whthomas/config-repo
複製程式碼

這個配置指的專案配置倉庫的位置,這個位置可以是:git資料夾、svn資料夾或者github專案位置,任何能訪問到檔案的地方。

環境倉庫(例子中的資料夾中)中提供環境配置物件配資源給Config Server釋出給各個consumer使用。

環境資源的命名規則由以下的三個引數確定:

{application}對映到Config客戶端的spring.application.name屬性

{profile}對映到Config客戶端的spring.profiles.active屬性,可以用來區分環境,比如dev,test,produce等等

{label}對映到Git伺服器的commit id,分支名稱或者tag,預設值為master

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

/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
複製程式碼

舉個例子: 我在配置中心的目錄下放置檔案:

cloud-config-rd.properties
cloud-config-dev.properties
cloud-config-test.properties
cloud-config-test.properties
複製程式碼

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

那麼接下去來看client端的處理。

Client端配置

建立一個普通的SpringBoot專案,pom.xml中加入Spring Cloud的配置。

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-dependencies</artifactId>
      <version>Brixton.RC2</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
複製程式碼

pom.xml中的dependencies節點下新增

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

resource目錄下的application.properties新增這樣幾個配置: 配置中心服務的地址 spring.cloud.config.uri=localhost:8888 要讀取的配置檔案application屬性 spring.cloud.config.name=cloud-config 要讀取的配置檔案profile屬性,預設是dev spring.cloud.config.profile=${config.profile:dev}

以上的幾個配置也可以在命令列啟動jar時填寫。 以上配置完成之後,在遠端配置中心的對應的配置就會載入到專案中,和本地使用application.properties配置中新增配置是幾乎一樣的效果,使用@Value註解的配置也可以順利讀取到對應的配置。 完整專案原始碼

相關文章