分布式配置中心：Spring Cloud Config

朱雀 2020-10-11 13:27 908阅读 0赞

github：[https://github.com/Maple521/springcloud/tree/master/config-server][https_github.com_Maple521_springcloud_tree_master_config-server]

Spring Cloud Config是Spring Cloud 团队创建的一个全新项目，用来为分布式系统中的基础设施和微服务应用提供集中化的外部配置支持，它分为服务端与客户端两个部分。其中服务端叶恒伟分布式配置中心，它是一个独立的微服务应用，用来连接配置仓库并为客户端提供获取配置信息、加密/解密信息的访问接口；而客户端则是微服务架构中的各个微服务应用或基础设施，他们通过指定的配置中心来管理应用资源与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息。Spring Cloud Config 实现了对服务端和客户端中环境变量和属性配置的抽象映射，所以它除了适用于Spring构建的应用程序之外，也可以在任何其他语言运行的应用程序中使用。由于Spring Cloud Config实现的配置中心默认采用Git来存储配置信息，所以使用Spring Cloud Config构建的配置服务器，天然就支持对微服务应用配置信息的版本管理，并且可以通过Git客户端工具来方便的管理和访问配置内容。当然它也提供了对其他存储方式的支持。比如SVN仓库、本地化文件系统。

## 快读入门 ##

在本节中，我们将演示如何构建一个基于Git存储的分布式配置中心，同时对配置的详细规则进行讲解，并在客户端中演示如何通过配置指定微服务应用的所属配置中心，并让其能够从配置中心获取配置信息并绑定到代码中的整个过程。

### 构建配置中心 ###

通过Spring Cloud Config构建一个分布式配置中心非常简单，，只需要以下三步。

*  创建一个基础的Spring Boot 工程，命名为config-server，并在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>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.3.7.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.configserver</groupId>
        <artifactId>config-server</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>config-server</name>
        <description>Demo project for Config Server</description>
    
        <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Brixton.SR5</spring-cloud.version>
        </properties>
    
        <dependencies>
            <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>${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>

*  创建Spring Boot的程序主类，并添加@EnableConfigServer注解，开启Spring Cloud Config的服务端功能。

package com.configserver;
    
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.builder.SpringApplicationBuilder;
    import org.springframework.cloud.config.server.EnableConfigServer;
    
    @EnableConfigServer
    @SpringBootApplication
    public class ConfigServerApplication {
    
        public static void main(String[] args) {
            new SpringApplicationBuilder(ConfigServerApplication.class).web(true).run(args);
        }
    
    }

*  在application.properties中添加配置服务的基本信息以及Git仓库的相关信息，如下所示：

spring.application.name=config-server
    server.port=7001
    
    spring.cloud.config.server.git.uri=https://github.com/Maple521/springcloud
    spring.cloud.config.server.git.searchPaths=spring_cloud_in_action/config-repo
    spring.cloud.config.server.git.username=whb1517@foxmail.com
    spring.cloud.config.server.git.password=wanghongboxxxxxx

其中Git的配置信息分别表示如下内容：

*  spring.cloud.config.server.git.uri：配置Git仓库位置
 *  spring.cloud.config.server.git.searchPaths：配置仓库路径下的相对搜索位置，可以配置多个。
 *  spring.cloud.config.server.git.username：访问Git仓库的用户名。
 *  spring.cloud.config.server.git.password：访问Git仓库的用户密码。

到这里，使用一个通过Spring Cloud Config 实现，并使用Git管理配置内容的分布式配置中心就完成了。我们可以将该应用西安启动起来，确保没有错误产生，然后进入下面的学习内容。

### 配置规则详解 ###

为了验证上面完成的分布式配置中心 config-server，根据Git配置信息中指定的仓库位置，在 [https://github.com/Maple521/springcloud/spring\_cloud\_in\_action/][https_github.com_Maple521_springcloud_spring_cloud_in_action] 下创建一个[config-repo][https_github.com_Maple521_springcloud_spring_cloud_in_action]目录作为配置仓库，并根据不同环境新建下面4个配置文件：

*  application.properties
 *  application-dev.properties
 *  application-test.properties
 *  application-prod.properties

在这4个配置文件中均设置了一个from属性，并为每个配置文件分别设置了不同的值，如下所示：

*  from=git-default-1.0
 *  from=git-dev-1.0
 *  from=git-test-1.0
 *  from=git-prod-1.0

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTAxNjc1_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTAxNjc1_size_16_color_FFFFFF_t_70 1][]

完成这些准备工作之后，我们就可以通过浏览器、POSTMAN或CURL等工具直接来访问我们的配置内容了。访问配置信息的URL与配置文件的映射关系如下图所示：

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

上面的url会映射到\{application\}-\{profile\}.properties对应的配置文件，其中\{label\}对应Git上不同的分支，默认为master。我们可以尝试构造不同的url来访问不同的环境内容，比如：要访问config-label-test分支，Maple521应用的prod环境，就可以访问这个url：[http://localhost:7001/Maple521/prod/master][http_localhost_7001_Maple521_prod_master]，并获得如下返回信息：

{
        "name": "Maple521",
        "profiles": [
            "test"
        ],
        "label": "master",
        "version": "90b2ac163b362d6c03716bfdca459415d15c0e07",
        "propertySources": [
            {
                "name": "https://github.com/Maple521/springcloud/spring_cloud_in_action/config-repo/application-test.properties",
                "source": {
                    "from": "git-test-1.0"
                }
            },
            {
                "name": "https://github.com/Maple521/springcloud/spring_cloud_in_action/config-repo/application.properties",
                "source": {
                    "from": "git-default-1.0"
                }
            }
        ]
    }

我们可以看到该JSON中返回了应用名Maple521，环境名prod，分支名 master，以及default 环境和prod环境的配置内容。另外，之前没有提到过的version，从上图我们可以观察到，它对应的是在Git上的commit号。

同时，我们可以看到config-server的控制台中还输出了下面的内容，配置服务器在从Git中获取配置信息后，会存储一份在config-server文件系统中，实质上config-server是通过git clone 命令将配置内容复制了一份在本地存储，然后读取这些内容并返回给微服务应用进行加载。

s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@6c8771ff: startup date [Tue Apr 09 08:42:53 CST 2019]; root of context hierarchy
    
    o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/var/folders/gf/6dpk76_j5zg_qwr67b768p5h0000gn/T/config-repo-1734100899654022120/spring_cloud_in_action/config-repo/application-prod.properties
    
    o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/var/folders/gf/6dpk76_j5zg_qwr67b768p5h0000gn/T/config-repo-1734100899654022120/spring_cloud_in_action/config-repo/application.properties
    
    s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@6c8771ff: startup date [Tue Apr 09 08:42:53 CST 2019]; root of context hierarchy

config-server通过Git在本地仓库暂存，可以有效防止当Git仓库出现故障而引起无法加载配置信息的情况。我们可以通过断开网络，再次发起[http://localhost:7001/Maple521/prod/master][http_localhost_7001_Maple521_prod_master]请求，在控制台中可输出如下内容。

.c.s.e.MultipleJGitEnvironmentRepository : Could not pull remote for master (current ref=Ref[refs/heads/master=90b2ac163b362d6c03716bfdca459415d15c0e07]), remote: https://github.com/Maple521/springcloud
    
    [nio-7001-exec-4] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@4bbd9176: startup date [Tue Apr 09 08:50:23 CST 2019]; root of context hierarchy
    
    o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/var/folders/gf/6dpk76_j5zg_qwr67b768p5h0000gn/T/config-repo-1734100899654022120/spring_cloud_in_action/config-repo/application-prod.properties
    
    o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/var/folders/gf/6dpk76_j5zg_qwr67b768p5h0000gn/T/config-repo-1734100899654022120/spring_cloud_in_action/config-repo/application.properties
    
    s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@4bbd9176: startup date [Tue Apr 09 08:50:23 CST 2019]; root of context hierarchy

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTAxNjc1_size_16_color_FFFFFF_t_70 2][]

可以看到，config-server提示无法从远程获取该分支内容的报错信息：Could not pull remote for master，但是它依然会为该请求返回配置内容，这些内容源于之前访问时存于 config-server 本地文件系统的配置内容。

[https_github.com_Maple521_springcloud_tree_master_config-server]: https://github.com/Maple521/springcloud/tree/master/config-server
[https_github.com_Maple521_springcloud_spring_cloud_in_action]: https://github.com/Maple521/springcloud/spring_cloud_in_action/config-repo
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTAxNjc1_size_16_color_FFFFFF_t_70]: /images/1602422852821.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTAxNjc1_size_16_color_FFFFFF_t_70 1]: /images/1602422836800.png
[http_localhost_7001_Maple521_prod_master]: http://localhost:7001/Maple521/prod/master
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMTAxNjc1_size_16_color_FFFFFF_t_70 2]: /images/1602422812716.png