springCloud - 第7篇 - 配置文件管理中心 ( SpringCloud Config )

左手的ㄟ右手 2021-11-17 11:32 558阅读 0赞

[前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到教程。][Link 1]

**一、简介**

分布式的系统往往有多个服务，会有不同的配置文件。

不同环境配置文件内容也各不相同： 开发环境、测试环境、生产环境。

为了方便管理数目众多的配置文件，springcloud 有对应的配置文件管理：spring cloud config 。

在此组件中主要有 2 种 角色：config server  配置文件管理中心 、

config client  从 config server 中读取真正需要的配置信息 。

配置文件支持放在本地，也支持放在远程 Git 仓库中 。

**二、重用此系列工程的父 pom 工程 springcloud-base。**

在其 pom 中加上依赖：

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-autoconfigure</artifactId>
            </dependency>

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70][]

新建文件夹 config , 并设置相应配置内容：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 1][]

config-client-pro.properties ：

version = pro -1.1.1.11- FZW -1.1.1

config-client-test.properties ：

version =  test-2.2.2.22

config-client-dev.properties ：

version = dev-0.0.0.DEV-0.0.0

**三、 新建 config-server 工程**

1. file - new - module

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 2][]

2. spring Initializr - module SDK 选择自己的 JDK ，其余的可以不用填写，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 3][]

3. 填写工程相关信息：包名、工程名等，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 4][]

4. spring cloud config- 勾选 config server，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 5][]

5. 工程名，代码存放位置等，finish 。

![20190730203109208.png][]

6. 工程结构如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 6][]

7. 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.config</groupId>
        <artifactId>config-server</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>config-server</name>
        <description>配置文件管理 server</description>
    
        <parent>
            <groupId>com.base</groupId>
            <artifactId>base-config</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</artifactId>
            </dependency>
        </dependencies>
    
    </project>

8. 在工程启动类上加注解：@EnableConfigServer  ，开启配置文件管理服务功能 。

package com.config.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);
    	}
    
    }

9. 配置文件中设置：

读取的是 springcloud-base工程中新增的 config 文件夹下的配置文件信息。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 7][]

# 工程名
    spring.application.name=config-server
    
    # 端口
    server.port=3333
    
    # git仓库地址
    spring.cloud.config.server.git.uri=https://gitee.com/FJ_WoMenDeShiJie/springcloud-base.git
    
    # 仓库路径
    spring.cloud.config.server.git.searchPaths=config
    
    # 仓库分支
    spring.cloud.config.label=master
    
    # git仓库用户名 ( 公开库-可不填 )
    spring.cloud.config.server.git.username=
    
    # git仓库密码 ( 公开库-可不填 )
    spring.cloud.config.server.git.password=

10. 启动工程访问：[http://localhost:3333/这里随便写/dev][http_localhost_3333_dev]

![20190730204246812.png][]

表示访问远程仓库中的配置文件成功 。访问路径最后的  dev  在此测试时也可任意写。

![20190730210238502.png][]

**四、 新建 config-client 工程**

1. file - new - module

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 2][]

2. spring Initializr - module SDK 选择自己的 JDK ，其余的可以不用填写，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 3][]

3. 填写工程相关信息：包名、工程名等，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 8][]

4. spring cloud config- 勾选 config client，next。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 9][]

5. 工程名，代码存放位置等，finish 。

![20190730204707739.png][]

6. 工程结构如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 10][]

7. 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.config</groupId>
        <artifactId>config-client</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>config-client</name>
        <description>配置文件管理 client</description>
    
        <parent>
            <groupId>com.base</groupId>
            <artifactId>base-config</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
    
        <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>
        </dependencies>
    
    </project>

8. 在工程启动类上加注解：@RestController , 书写 getVersion 方法，提供对外访问。

package com.config.configclient;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    
    @RestController
    @SpringBootApplication
    public class ConfigClientApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigClientApplication.class, args);
        }
    
        @Value("${version}")
        String version;
    
        @RequestMapping(value = "/getVersion")
        public String getVersion() {
            return version;
        }
    
        /**
         * 增加此方法用以解决报错：Could not resolve placeholder 'version' in value "${version}"
         * @return
         */
        @Bean
        public static PropertySourcesPlaceholderConfigurer placeholderConfigurer() {
            PropertySourcesPlaceholderConfigurer c = new PropertySourcesPlaceholderConfigurer();
            c.setIgnoreUnresolvablePlaceholders(true);
            return c;
        }
    
    }

9. 配置文件设置：  注意此配置文件的名字是： bootstrap.properties 。

叫这个名字的原因：官方指定优先读取此文件，bootstrap 在 application 之前加载 。

# 项目名
    spring.application.name=config-client
    
    # 端口
    server.port=4444
    
    # 仓库分支
    spring.cloud.config.label=master
    
    # 读取文件：dev开发环境、test测试、pro生产
    spring.cloud.config.profile=test
    
    # 配置文件管理服务 config-server 地址
    spring.cloud.config.uri=http://localhost:3333/

此时设置为读取 springcloud-base中的 配置文件 ：config-client-test.properties

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 11][]

10. 启动工程访问：[http://localhost:4444/getVersion][http_localhost_4444_getVersion]

![2019073021041999.png][]

修改配置文件中访问的文件：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 12][]

此时设置为读取 springcloud-base中的 配置文件 ：config-client-dev.properties

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 13][]

重启工程访问：[http://localhost:4444/getVersion][http_localhost_4444_getVersion]

![20190730210852217.png][]

至此，config-server 从远程仓库读取配置文件成功。 config-client 通过 config-server 读取配置文件中的具体信息值也成功了。

在 config-client 配置文件中可通过修改 spring.cloud.config.profile 选项来设定读取不同的配置文件 。

\-------------------------------------------------------------

下一篇：[springCloud - 第8篇 - 配置文件管理中心 - 集群模式（负载匀衡）使用][springCloud - _8_ - _ -]

源码见：[https://gitee.com/FJ\_WoMenDeShiJie/springcloud-base][https_gitee.com_FJ_WoMenDeShiJie_springcloud-base]

[https://gitee.com/FJ\_WoMenDeShiJie/springcloud-config-server][https_gitee.com_FJ_WoMenDeShiJie_springcloud-config-server]

[https://gitee.com/FJ\_WoMenDeShiJie/springcloud-config-client][https_gitee.com_FJ_WoMenDeShiJie_springcloud-config-client]

\-------------------------------------------------------------

PS：这个系列不定时更新，只是个人的学习分享，

内容全程参考书目：

《Spring Cloud 与 Docker 微服务架构空实战 》、

《Spring Cloud 微服务实战》及此书作者博客：http://blog.didispace.com/spring-cloud-learning/

《深入理解 Spring Cloud 与微服务构建》及此书作者博客：https://blog.csdn.net/forezp/article/details/70148833  
\--------------------------------------------------------------

以下出自：[https://blog.csdn.net/forezp/article/details/81041028][https_blog.csdn.net_forezp_article_details_81041028]

config-server 启动成功后，访问路径映射方式有以下几种：

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

[Link 1]: https://www.captainai.net/jiangyu1013/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70]: /images/20211116/4de4370f302c4d0facdc321a328e730b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 1]: /images/20211116/56ece7297e7f44daade33f1179c6fa3d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 2]: /images/20211116/f059288c4eeb41baba9b401b4b6d4c93.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 3]: /images/20211116/74921ed7ddb24b1d8c5aa41d54c137d2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 4]: /images/20211116/b5f47557e3354a95bdfcb26cf0328a42.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 5]: /images/20211116/d51a753ab6094fcd9a70419656049ef1.png
[20190730203109208.png]: /images/20211116/ab0a86a7500b41c49237c0a3521f5df3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 6]: /images/20211116/6220efeb5ba6410c8cd1f2123eb001fe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 7]: /images/20211116/e5b96f16108a49b29c506dd7b7bf515f.png
[http_localhost_3333_dev]: http://localhost:3333/%E8%BF%99%E9%87%8C%E9%9A%8F%E4%BE%BF%E5%86%99/dev
[20190730204246812.png]: /images/20211116/f51ddd7d14e9497eb553cd157fb23edf.png
[20190730210238502.png]: /images/20211116/b4497f1d96b242ca99cac2877f38e290.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 8]: /images/20211116/a4571f7d224a4571b2c56177f11124fa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 9]: /images/20211116/743b528c6e0e43ecbb40a3e0532b6dca.png
[20190730204707739.png]: /images/20211116/4d7291039f3f42d994f94d352cc13b57.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 10]: /images/20211116/b7dc059527694a8d99c251c3a564fbc2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 11]: /images/20211116/d768e575a8694229bcb8a35d53eca60d.png
[http_localhost_4444_getVersion]: http://localhost:4444/getVersion
[2019073021041999.png]: /images/20211116/4e753e30c0b640abae6124c52763ae0b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 12]: /images/20211116/60ab5bddf9424aeeb4ada9e3102e8aed.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTEzMTQ0NDI_size_16_color_FFFFFF_t_70 13]: /images/20211116/06422d3c99cf48e3af071d477aed37e4.png
[20190730210852217.png]: /images/20211116/a86aee6ae27b444f94e1e8591ebcd5d8.png
[springCloud - _8_ - _ -]: https://blog.csdn.net/jiangyu1013/article/details/97930653
[https_gitee.com_FJ_WoMenDeShiJie_springcloud-base]: https://gitee.com/FJ_WoMenDeShiJie/springcloud-base
[https_gitee.com_FJ_WoMenDeShiJie_springcloud-config-server]: https://gitee.com/FJ_WoMenDeShiJie/springcloud-config-server
[https_gitee.com_FJ_WoMenDeShiJie_springcloud-config-client]: https://gitee.com/FJ_WoMenDeShiJie/springcloud-config-client
[https_blog.csdn.net_forezp_article_details_81041028]: https://blog.csdn.net/forezp/article/details/81041028