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

完整的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 2018/4/27 16:32
 */
@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
文件中有一个属性：

扫描二维码关注公众号，回复： 1469869 查看本文章

token=ahut token

启动程序：访问http://localhost:8960/foo/dev

{"name":"foo","profiles":["dev"],"label":null,"version":"42bce1d39966a9b0166fb308fee2c342a87294aa","state":null,"propertySources":[]}

证明配置服务中心可以从远程程序获取配置信息。

创建Ahut-Config-Client项目

新创建一个工程Ahut-Config-Client，创建过程和Ahut-Eureka-Client-One一样

完整的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 2018/4/27 17:32
 */
@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 2018/4/27 17:01
 */
@RestController
@RequestMapping(value = "/v1")
public class HelloAction {

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

    /**
     * @description: 获取token
     * @author cheng
     * @dateTime 2018/4/27 17:03
     */
    @RequestMapping(value = "/token")
    public String getToken() {
        return token;
    }

}

启动项目：

• Ahut-Eureka-Server（注册中心）
• Ahut-Config-Server（配置服务）
• Ahut-Config-Client（读取配置）

启动Ahut-Config-Client项目出现如下日志：

访问eureka

浏览器访问Ahut-Config-Client ： http://localhost:8970/v1/token

这就说明，config-client从config-server获取了foo的属性，而config-server是从git仓库读取的

此时的项目架构

高可用分布式配置中心

上面讲解一个服务如何从配置中心读取文件，配置中心如何从远程git读取配置文件。

当服务实例很多时，都从配置中心读取文件，这时可以考虑将配置中心做成一个微服务，将其集群化，从而达到高可用，架构图如下：