Spring Cloud Config 概述及入门案例

青旅半醒 2023-05-29 13:17 10阅读 0赞

### 文章目录 ###

*  1. 什么是Spring Cloud
 *  2. Spring Cloud Config概述
 *  3. Spring Cloud Config入门案例
 *   *  3.1 Config Server配置
     *  3.2 Config Client配置
 *  延伸

Spring Cloud Config是Spring Cloud微服务体系中的中配置中心，是微服务中不可获取的一部分，其都能够很好的将程序中配置日益增多的各种功能的开关、参数的配置、服务器的地址，配置修改后实时生效，灰度发布，分环境、分集群管理配置等进行全面的集中化管理，有利于系统的配置管理和维护。

--------------------

本文内容出自《重新定义Spring Cloud实战》  
如直接上手配置可直接看三章

--------------------

# 1. 什么是Spring Cloud #

在集中式开发时代，配置文件已经基本足够了，因为那时配置的管理通常不会成为一个很大的问题。但是在互联网时代，应用都是分布式系统，部署在N台服务器上，想要去线上一台台的重启机器肯定不靠谱，而且维护成本也很高，所以配置中心应运而生。配置中心被用作集中管理不同环境（Dev、Test、Stage、Prod）和不同集群配置，以及在修改配置后将实时动态推送到应用上进行刷新。

那么配置中心的定位是什么呢？它应该具备如下功能：

*  Open API
 *  业务无关性
 *  配置生效监控
 *  一致性K-V存储
 *  统一配置实时推送
 *  配合灰度与更新
 *  配置全局恢复、备份与历史
 *  高可用集群

# 2. Spring Cloud Config概述 #

Spring Cloud Config是一个集中化外部配置的分布式系统，由服务端和客户端组成。它不依赖于注册中心，是一个独立的配置中心。Spring Cloud Config支持多种存储配置信息的形式，目前主要有jdbc、Vault、Native、svn、git，其中默认为git。

当配置了config的客户端启动时会向服务端发起请求，服务端接收到客户端请求后，根据配置的仓库地址，将git上的文件克隆到本地的一个临时目录中，这个目录是一个git的本地仓库目录，然后服务端再读取本地文件返回给客户端。这样做的好处是，当git服务器故障或者网络请求异常时，保证服务端仍然可以正常工作。

# 3. Spring Cloud Config入门案例 #

## 3.1 Config Server配置 ##

首先创建工程模块，这里我是将多个微服务以多个module的方式建立在了一个project下，目录结构如图，config服务就是我们的Config Server服务。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70]  
pom中需要的依赖如下：

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
    </dependencies>

主程序代码：

package com.herobin.scd;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.config.server.EnableConfigServer;
    
    /** * @author binzhang * @date 2019-11-06 */
    @SpringBootApplication
    @EnableConfigServer
    public class ConfigApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(ConfigApplication.class, args);
        }
    }

这里要添加@EnableConfigServer注解开启Spring Cloud Config的服务功能。

applilcation.yml配置：

spring:
      cloud:
        config:
          server:
            git:
              uri: https://github.com/zhangbin1995/SpringCloudDemo.git
              username: xxxxx
              password: xxxxx
              search-paths: config/src/main/resources/configfile/
      application:
        name: config
    server:
      port: 9090

这里解释一下相关配置，配置中的uir指的是git服务器的地址；username和password指的是git访问的用户名和密码，如果设置访问需要用户名和密码，添加上对应的值即可；search-paths设置配置文件所在路径，这里可以添加多个目录，目录之间用逗号隔开即可。

随后创建三个配置文件config-info-dev.yml, config-info-test.yml, config-info-prod.yml，里面简单的写一下各自的内容如图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 1]  
另外两个环境相应改为prod和test即可。

启动项目，访问[http://localhost:9090/config-info/dev/master][http_localhost_9090_config-info_dev_master]，能出现配置信息即配置成功，如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 2]  
此时观察config服务的控制台打印信息会发现config会在本地的临时目录下面克隆远程仓库中的配置信息

2019-11-06 19:27:10.480  INFO 2524 --- [nio-9090-exec-6] 
    o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: 
    file:/var/folders/68/29sf4wbn7q5b_g9l6c187p7m0000gn/T/config-repo-
    7800015887605073792/config/src/main/resources/configfile/config-info-dev.yml

## 3.2 Config Client配置 ##

首先在要使用config配置的微服务的pom中引入依赖：

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-client</artifactId>
        <version>2.0.0.RELEASE</version>
    </dependency>

spring-cloud-config-client主要是客户端用来向服务端拉取配置所需依赖。

config不需要在启动类上加额外的注解。

创建实体类ConfigInfoProperties，并且添加一个@Component作为一个组件，同时使用@ConfigurationProperties加载配置属性和指定配置前缀如下图：

package com.herobin.scd.configtest;
    
    import lombok.Data;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    /** * @author binzhang * @date 2019-11-06 */
    @Data
    @Component
    @ConfigurationProperties(prefix = "cn.springcloud.book")
    public class ConfigInfoProperties { 
    
        private String config;
    
    }

创建ConfigClientController类并且将ConfigInfoProperties对象注入使用属性值，具体如下：

package com.herobin.scd.configtest;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * @author binzhang * @date 2019-11-06 */
    @RestController
    public class ConfigClientController { 
    
        @Autowired
        private ConfigInfoProperties configInfoValues;
    
        @RequestMapping("/getConfigInfo")
        public String getConfigInfo() { 
            return configInfoValues.getConfig();
        }
    }

创建配置文件applicaiton.yml：

server:
      port: 8081
    spring:
      application:
        name: user

再创建一个bootstrap.yml文件内容如下：

spring:
      cloud:
        config:
          label: master
          uri: http://localhost:9090
          name: config-info
          profile: dev

下面解释一下上述bootstrap.yml中的配置项：

*  label：代表要请求哪个git分支。
 *  uri：代表请求的config server的地址。
 *  name：代表要请求哪个名称的远程文件，可以写多个，通过逗号隔开。
 *  profile：代表哪个分支的文件，例如dev、test、prod等。

这些配置为什么要放在bootstrap.yml里，而不放在application.yml中呢？这与spring boot的加载顺序有关，bootstrap.yml文件会优先于application.yml加载，因此会去加载远程的配置文件信息，到此客户端配置完成。

启动客户端，可以看到控制台信息中打印出配置中git的相关信息。

2019-11-06 19:53:57.498  INFO 2839 --- [           main] c.c.c.ConfigServicePropertySourceLocator : Fetching config from server at : http://localhost:9090
    2019-11-06 19:54:00.940  INFO 2839 --- [           main] c.c.c.ConfigServicePropertySourceLocator : Located environment: name=config-info, profiles=[dev], label=master, version=221ae30c1fa661179ff01a152025711b0c2cc2f3, state=null
    2019-11-06 19:54:00.941  INFO 2839 --- [           main] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource { name='configService', propertySources=[MapPropertySource { name='configClient'}, MapPropertySource { name='https://github.com/zhangbin1995/SpringCloudDemo.git/config/src/main/resources/configfile/config-info-dev.yml'}]}

访问接口：[http://localhost:8081/getConfigInfo][http_localhost_8081_getConfigInfo]  
![在这里插入图片描述][20191106210151632.png]  
至此，Config配置完成。

# 延伸 #

后面要考虑如何实现配置的热刷新。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191106191105871.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191106191730683.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1,size_16,color_FFFFFF,t_70
[http_localhost_9090_config-info_dev_master]: http://localhost:9090/config-info/dev/master
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191106191954831.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1,size_16,color_FFFFFF,t_70
[http_localhost_8081_getConfigInfo]: http://localhost:8081/getConfigInfo
[20191106210151632.png]: https://img-blog.csdnimg.cn/20191106210151632.png