SpringCloud-第六篇Spring-Cloud-Config-Github配置中心

随着分布式项目越来越大，勤劳的程序猿们会开始面临一个挑战，配置文件会越来越繁杂，虽然 spring 提供了一个鸡肋版的解决方案，spring.profiles.active，在大型的分布式项目体系中，聊胜于无吧，手动维护配置文件的痛苦，生产，UAT，测试，开发环境的隔离，额外的配置文件，如：logback.xml 日志的配置文件，bootstrap.properties 配置文件，当系统中有几十个服务，相应的会有上百个配置文件，简直就是史诗级的灾难大片，每次发布上线，都要手动去检查配置文件，相应的服务都需要重启，那么，有没有一种方案，可以自动更新配置，并且对版本做出相应的控制，恰好，springcloud 为我们提供了这样一种工具，虽然很多方面都还不完善，配置能力比较弱，但是也给我们提供了一种思路。
（了解源码可 + 求求: 1791743380）

市面上有很多配置中心，BAT 每家都出过，360 的 QConf、淘宝的 diamond、百度的 disconf 都是解决这类问题。国外也有很多开源的配置中心 Apache Commons Configuration、owner、cfg4j 等等。这些开源的软件以及解决方案都很优秀，也存在这样或者那样的缺陷。今天我们要了解的 Spring Cloud Config，可以无缝的和 spring 体系相结合，够方便够简单颜值高。

在介绍 Spring Cloud Config 之前，我们可以先凭空想一下一个配置中心需要提供的核心功能有哪些：

提供客户端和服务端的支持
提供各个环境的配置
配置文件修改后可以快速生效
可以提供不同版本的管理
可以支持不同的语言（java、.Net、Delphi、node 等）
支持一定数量的并发
高可用（防止意外宕机导致配置不可用）

Spring Cloud Config 项目是一个解决分布式系统的配置管理方案。它包含了 Client 和 Server 两个部分，server 提供配置文件的存储、以接口的形式将配置文件的内容提供出去，client 通过接口获取数据、并依据此数据初始化自己的应用。Spring cloud 使用 git 或 svn 存放配置文件，默认情况下使用 git，我们先以 git 为例做一套示例。

首先在 github 上面创建了一个文件夹 springcloud-config 用来存放配置文件，为了模拟生产环境，我们创建以下三个配置文件：

// 开发环境
springcloud-config-dev.properties
// 测试环境
springcloud-config-test.properties
// 生产环境
springcloud-config-pro.properties

每个配置文件中都写一个属性 springcloud.hello, 属性值分别是 hello dev/test/pro。下面我们开始配置 server 端

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.springcloud</groupId>
    <artifactId>config-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>config-server</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</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>

server:
  port: 8080
spring:
  application:
    name: spring-cloud-config-server
  cloud:
    config:
      server:
        git:
          uri: https://github.com/meteor1993/SpringCloudLearning # git 仓库的地址
          search-paths: chapter6/springcloud-config  # git 仓库地址下的相对地址，可以配置多个，用, 分割。username: #Git 仓库用户名
          password: #Git 仓库密码

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

package com.springcloud.configserver;

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

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

}

增加 @EnableConfigServer 注解，激活对配置中心的支持

首先测试我们的 server 端能否从 github 上获取到我们需要的信息，直接访问：http://localhost:8080/springcloud-config/pro，注意： springcloud-config 是文件夹的前缀命名，可以看到如下结果：

{
    "name":"springcloud-config",
    "profiles":["pro"],
    "label":null,
    "version":"4e3d1a93e869fb336254c480ed1e5b36d58124aa",
    "state":null,
    "propertySources":[
        {
            "name":"https://github.com/meteor1993/SpringCloudLearning/chapter6/springcloud-config/springcloud-config-pro.properties",
            "source":{"springcloud.hello":"hello pro"}
        }
    ]
}

上述的返回的信息包含了配置文件的位置、版本、配置文件的名称以及配置文件中的具体内容，说明 server 端已经成功获取了 git 仓库的配置信息。

如果直接查看配置文件中的配置信息可访问：http://localhost:8080/springcloud-config-dev.properties，返回：springcloud.hello: hello dev

修改配置文件 springcloud-config-dev.properties 中配置信息为：springcloud.hello=hello dev update，再次在浏览器访问 http://localhost:8080/springcloud-config-dev.properties，返回：springcloud.hello: hello dev update。说明 server 端会自动读取自动提交功能。

仓库中的配置文件会被转换成 web 接口，访问可以参照以下的规则：

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

以 springcloud-config-dev.properties 为例，它的 application 是 springcloud-config，profile 是 dev，label 是分支的意思，如果只有一个主分支，可以不写，默认会访问 master 分支，client 会根据填写的参数来选择读取对应的配置。

主要展示如何在业务项目中去获取 server 端的配置信息。

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.springcloud</groupId>
    <artifactId>config-client</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>config-client</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR1</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.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.yml 和 bootstrap.properties

application.yml 如下：

server:
  port: 8081
spring:
  application:
    name: spring-cloud-config-client

bootstrap.properties 如下：

spring.cloud.config.name=springcloud-config
spring.cloud.config.profile=dev
spring.cloud.config.uri=http://localhost:8080/
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.yml。

package com.springcloud.configclient;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

}

启动类只需要 @SpringBootApplication 注解就可以，常规操作。

package com.springcloud.configclient.controller;

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

/**
 * @Author: shiyao.wei
 * @Date: 2019/7/4 16:19
 * @Version: 1.0
 * @Desc:
 */
@RestController
public class HelloController {@Value("${springcloud.hello}")
    private String hello;

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

使用 @Value 注解来获取 server 端参数的值

启动 client 端，访问链接：http://localhost:8081/hello，返回：hello dev update，说明已经正确的从 server 端获取到了参数。到此一个完整的服务端提供配置服务，客户端获取配置参数的例子就完成了。

可以再进行一个小实验，我们再次修改 springcloud-config-dev.properties 中的内容为：hello dev update1，提交至 github 后，再次访问 http://localhost:8081/hello，可以发现，返回的内容还是 hello dev update，这是为什么呢？因为 springboot 项目只有在启动的时候才会获取配置文件的值，修改 github 信息后，client 端并没有在次去获取，所以导致这个问题。如何去解决这个问题呢？留到下一篇我们在介绍。

SpringCloud-第六篇Spring-Cloud-Config-Github配置中心

1. Spring Cloud Config

2. Server 端

1. pom.xml

2. 配置文件

3. 启动类 ConfigServerApplication

4. 测试

3. client 端

1. pom.xml

2. 配置文件

3. 启动类

4. 访问类

5. 测试

Just My Socks（注册教程内含优惠码）

SpringCloud-第六篇Spring-Cloud-Config-Github配置中心

1. Spring Cloud Config

2. Server 端

1. pom.xml

2. 配置文件

3. 启动类 ConfigServerApplication

4. 测试

3. client 端

1. pom.xml

2. 配置文件

3. 启动类

4. 访问类

5. 测试

Just My Socks（注册教程 内含优惠码）

Just My Socks（注册教程内含优惠码）