天天看點

SpringCloud - (六)分布式配置中心(Spring Cloud Config)

Spring Cloud Config簡介

在分布式系統中,由于服務數量巨多,為了友善服務配置檔案統一管理,實時更新,是以需要分布式配置中心元件。

在Spring Cloud中,有分布式配置中心元件spring cloud config ,它支援配置服務放在配置服務的記憶體中(即本地),也支援放在遠端Git倉庫中。

在spring cloud config 元件中,分兩個角色,

  • 一是config server
  • 二是config client

建立Ahut-Config-Server項目

新建立一個工程Ahut-Config-Server,建立過程和Ahut-Eureka-Client-One一樣

SpringCloud - (六)分布式配置中心(Spring Cloud Config)

完整的pom.xml檔案如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.ahut</groupId>
    <artifactId>config-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>config-server</name>
    <description>config server</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.12.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Edgware.SR3</spring-cloud.version>
    </properties>

    <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>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

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


</project>      

在程式的入口Application類加上@EnableConfigServer注解開啟配置伺服器的功能,代碼如下:

package com.ahut;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

/**
 * @author cheng
 * @className: ConfigServerApplication
 * @description: config server
 * @dateTime
@SpringBootApplication
@EnableEurekaClient
@EnableConfigServer
public class ConfigServerApplication

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

}      

application.properties配置檔案:

# 配置伺服器端口
server.port=8960
# 配置spring項目名
spring.application.name=AHUT-CONFIG-SERVER
# 注冊中心url
eureka.client.service-url.defaultZone=http://localhost:8900/eureka/

# 配置git倉庫位址
spring.cloud.config.server.git.uri=https://github.com/obitu/AhutConfig/
# 配置倉庫路徑
spring.cloud.config.server.git.search-paths=config
# 配置倉庫的分支
spring.cloud.config.label=master
# 通路git倉庫的使用者名
spring.cloud.config.server.git.username=11111
# 通路git倉庫的使用者密碼
spring.cloud.config.server.git.password=11111      

配置說明:

  • spring.cloud.config.server.git.uri:配置git倉庫位址
  • spring.cloud.config.server.git.searchPaths:配置倉庫路徑
  • spring.cloud.config.label:配置倉庫的分支
  • spring.cloud.config.server.git.username:通路git倉庫的使用者名
  • spring.cloud.config.server.git.password:通路git倉庫的使用者密碼

如果Git倉庫為公開倉庫,可以不填寫使用者名和密碼,如果是私有倉庫需要填寫,本例子是公開倉庫,放心使用。

遠端倉庫​​https://github.com/obitu/AhutConfig/​​​中有個檔案AHUT-CONFIG-CLIENT-dev.properties

檔案中有一個屬性:

token=ahut token      

啟動程式:通路​​http://localhost:8960/foo/dev​​

{"name":"foo","profiles":["dev"],"label":null,"version":"42bce1d39966a9b0166fb308fee2c342a87294aa","state":null,"propertySources":[]}      
SpringCloud - (六)分布式配置中心(Spring Cloud Config)

證明配置服務中心可以從遠端程式擷取配置資訊。

建立Ahut-Config-Client項目

新建立一個工程Ahut-Config-Client,建立過程和Ahut-Eureka-Client-One一樣

SpringCloud - (六)分布式配置中心(Spring Cloud Config)

完整的pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.ahut</groupId>
    <artifactId>config-client</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>config-client</name>
    <description>config client</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.12.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Edgware.SR3</spring-cloud.version>
    </properties>

    <dependencies>
        <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>

        <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>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

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

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>


</project>      

程式啟動類:

package com.ahut;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

/**
 * @author cheng
 * @className: ConfigClientApplication
 * @description: config client
 * @dateTime
@SpringBootApplication
@EnableDiscoveryClient
public class ConfigClientApplication

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

注意:

  • 原來的application.properties配置檔案不要動,不要删除
  • 重新建立一個bootstrap.properties配置檔案

application.properties配置檔案内容為空

這裡可以給大家解釋下配置檔案的問題:

1. 用application.properties,可以用這個預設的配置檔案,但必須将服務端口配置為8888,這是預設端口

2. 如果用了bootstrap.properties,則可以自定義端口,因為bootstrap.* 命名的檔案會被優先讀取和配置

3. 至于讀取foo錯誤的問題,遠端倉庫的配置檔案名字首要和配置用戶端名字相同

4. 建議了解好整個加載的過程,就知道在哪個環節出錯了問題

bootstrap.properties配置檔案

# 配置伺服器端口
server.port=8970
# 配置spring項目名稱
spring.application.name=AHUT-CONFIG-CLIENT
# 注冊中心url
eureka.client.service-url.defaultZone=http://localhost:8900/eureka/

#開啟配置服務發現
spring.cloud.config.discovery.enabled=true
#配置服務執行個體名稱
spring.cloud.config.discovery.service-id=AHUT-CONFIG-SERVER
# 指明遠端倉庫的分支
spring.cloud.config.label=master
# 環境
spring.cloud.config.profile=dev      

http請求位址和資源檔案映射如下:

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

eg:AHUT-CONFIG-CLIENT-dev.properties

說明:

  • spring.cloud.config.discovery.enabled 開啟配置服務發現
  • spring.cloud.config.discovery.service-id 配置服務執行個體名稱
  • spring.cloud.config.label 指明遠端倉庫的分支
  • spring.cloud.config.profile

    dev開發環境配置檔案

    test測試環境

    pro正式環境

# 指明配置服務中心的網址,不建議這樣配置,配置ip位址不利于以後擴充
# spring.cloud.config.uri=http://localhost:8960/

#開啟配置服務發現
spring.cloud.config.discovery.enabled=true
#配置服務執行個體名稱
spring.cloud.config.discovery.service-id=AHUT-CONFIG-SERVER      

讀取配置檔案不寫ip位址,而是服務名,這時如果配置服務部署多份,通過負載均衡,可以達到高可用

建立控制層:

package com.ahut.action;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author cheng
 * @className: HelloAction
 * @description: 示範擷取配置檔案
 * @dateTime
@RestController
@RequestMapping(value = "/v1")
public class HelloAction

    @Value(value = "${token}")
    private String token;

    /**
     * @description: 擷取token
     * @author cheng
     * @dateTime
    @RequestMapping(value = "/token")
    public String getToken() {
        return      

啟動項目:

  • Ahut-Eureka-Server(注冊中心)
  • Ahut-Config-Server(配置服務)
  • Ahut-Config-Client(讀取配置)

啟動Ahut-Config-Client項目出現如下日志:

SpringCloud - (六)分布式配置中心(Spring Cloud Config)

通路eureka

SpringCloud - (六)分布式配置中心(Spring Cloud Config)

浏覽器通路Ahut-Config-Client : ​​http://localhost:8970/v1/token​​

SpringCloud - (六)分布式配置中心(Spring Cloud Config)

這就說明,config-client從config-server擷取了foo的屬性,而config-server是從git倉庫讀取的

此時的項目架構

SpringCloud - (六)分布式配置中心(Spring Cloud Config)

高可用分布式配置中心

上面講解一個服務如何從配置中心讀取檔案,配置中心如何從遠端git讀取配置檔案。