SpringCloud微服务之分布式配置中心

柔光的暖阳◎ 2022-12-19 01:19 155阅读 0赞

**引言：**

分布式系统面临的配置问题：  
微服务意味着要将单体应用中的业务拆分成一个个子服务 ，每个服务的粒度相对较小，因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行,所以一套集中式的、动态的配置管理设施是必不可少的。如果我们每个微服务自己带着一个application.yml配置文件，上百个配置文件的管理，我们肯定会特别抓狂的，所以SpringCloud提供了ConfigServer（分布式配置中心）来解决这个问题。

## 一。概念 ##

### 1.分布式配置中心是什么？ ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center]

SpringCloud Config分为`服务端`和`客户端`两部分。

*  服务端也称为分布式配置中心，它是一个独立的微服务应用，用来连接配置服务器并为客户端提供获取配置信息，加密/解密信息等访问接口。
 *  客户端则是通过指定的配置中心来管理应用资源，以及与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息配置服务器，默认采用git来存储配置信息,这样就有助于对环境配置进行版本管理,并且可以通过git客户端工具方便的管理和访问配置内容。

### 2.能干什么？ ###

*  集中管理配置文件。
 *  不同环境不同配置，动态化的配置更新，分环境部署比如dev/test/prod/beta/release。
 *  运行期间动态调整配置，不再需要在每个服务部署的机器上编写配置文件，服务会向配置中心统一拉取配置自己的信息。
 *  当配置发生变动时，服务不需要重启即可感知到配置的变化并应用新的配置。
 *  将配置信息以REST接口的形式暴露。

**注意：**  
本篇博客所讲的配置是利用Git以及GitHub来进行一个配置整合，把GitHub当做分布式配置中心的云仓库。

## 二。GitHub建立配置中心仓库 ##

1.新建一个仓库，仓库名称为springcloud-config：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 1]  
2.将我们配置好的三个配置文件上传到GitHub上：

其中三个配置文件内容分别如下所示：

*  **application-dev.yml:**

config:
      info: master branch,springcloud-config/application-dev.yml version=1.0

*  **application-pro.yml:**

config:
      info: master branch,springcloud-config/application-pro.yml version=1.0

*  **application-test.yml:**

config:
      info: master branch,springcloud-config/application-test.yml version=1.0

具体操作方法可以参照我的另外一篇博客：[使用Git提交本地项目到GitLab的几种方式][Git_GitLab]，这篇博客写的是如何提交文件到GitLab上，提交文件到GitHub也是一样的操作。

3.操作全部成功完成之后，仓库内容如下所示：

## 三。Config Server（分布式配置服务端）的搭建 ##

1.新建一个子模块configserver-3344，在pom.xml文件中导入分布式配置服务端依赖：

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</artifactId>
            </dependency>

2.application.yml配置文件如下：

server:
      port: 3344 #运行端口号
    spring:
      application:
        name: cloud-config-center # 注册进Eureka服务器的微服务名
      cloud:
        config:
          server:
            git:
              uri: https://github.com/Hub-Zhong/springcloud-config.git # 填写你自己的github路径
              username: GitHub #GitHub账户名
              password: 123456 #GitHub账户密码
              # 搜索目录
              search-paths:
                - springcloud-config # 仓库名称 
          label: master  # 分支名称
    # 服务注册到eureka地址
    eureka:
      client:
        service-url:
          defaultZone:  http://localhost:8088/eureka

3.在启动类中加上@**EnableConfigServer**注解，开启分布式配置中心功能：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 3]

4.先启动eureka注册中心，再启动configserver-3344。

5.三种读取配置规则：（其中label为分支，name为名称，profile为环境）

*  第一种，/\{label\}/\{name\}-\{profile\}.yml，访问[http://localhost:3344/master/application-test.yml][http_localhost_3344_master_application-test.yml]：

![在这里插入图片描述][20201105194214159.png_pic_center]

*  第二种， /\{name\}-\{profile\}.yml，访问[http://localhost:3344/application-test.yml][http_localhost_3344_application-test.yml]，默认访问分支为master主分支：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 4]

\-第三种， /\{name\}-\{profile\}/\{label\}.yml，访问[http://localhost:3344/application-test.yml/master][http_localhost_3344_application-test.yml_master]，返回的是一个json串：

![在这里插入图片描述][20201105194500102.png_pic_center]  
**一般常用的是第一种方式**

至此，分布式配置服务端搭建完成。

## 四。Config Client（分布式配置客户端）的搭建 ##

1.新建一个子模块configclient-3355，在pom.xml文件中导入分布式配置客户端依赖：

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-config</artifactId>
            </dependency>

2.**将application.yml配置文件改名为bootstrap.yml**

原因是：要将Client模块下的application.yml文件改为bootstrap.yml，这是很关键的。  
因为bootstrap.yml是比application.yml先加载的。bootstrap.yml优先级高于application.yml。

在该文件中加入以下配置：

server:
      port: 3355
    
    spring:
      application:
        name: config-client
      cloud:
        #Config客户端配置
        config:
          label: master #分支名称
          name: application #配置文件名称
          profile: dev #读取后缀名称 上述3个综合：master分支上application-dev.yml的配置文件被读取http://localhost:3344/master/application-dev.yml
          uri: http://localhost:3344 #配置中心地址
    
    #服务注册到eureka地址
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8088/eureka

**需要注意的是：**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 5]  
3.然后新建一个控制器，写一个读取云端配置的方法：

@RestController
    public class ConfigClientController { 
     
        @Value("${config.info}")
        private String configInfo;
     
        @GetMapping("/configInfo")
        public String getConfigInfo(){ 
            return configInfo;
        }
    }

如果分布式配置中心配置成功，configclient-3355就能从configserver-3344上拿到它从github仓库中读取的配置文件信息。

4.依次启动eureka，configserver-3344，configclient-3355：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 6]

5.访问[http://localhost:3355/configInfo][http_localhost_3355_configInfo]，成功得到配置信息：

![在这里插入图片描述][20201105195143701.png_pic_center]

至此，分布式配置客户端搭建完成。

## 五。Config客户端之动态刷新 ##

### 1.动态刷新是什么？ ###

简单来说就是当Github上的配置文件内容发生变化时，分布式配置的服务端和客户端能够得到及时、实时的更新。

### 2.为什么需要使用动态刷新？ ###

平时开发我们经常会涉及一些配置文件的更改操作，比如Linux运维修改Github上的配置文件内容。那我们服务端和客户端能否得到及时的更新呢？

毫无疑问，ConfigServer配置中心是可以得到实时更新效果的，因为它是直连GitHub仓库，但是ConfigClient是通过ConfigServer间接访问GitHUb上的配置文件的，那么它能否得到实时的更新呢？

**我们可以做一个实验：**

首先，我们将GitHub上面的application-dev.yml配置文件的版本修改为2.0：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 7]  
再不重启任何服务的情况下，访问ConfigServer：[http://localhost:3344/master/application-dev.yml/][http_localhost_3344_master_application-dev.yml]：

![在这里插入图片描述][20201105195729480.png_pic_center]  
**发现ConfigServer能够进行实时的更新**

再访问ConfigClient：[http://localhost:3355/configInfo][http_localhost_3355_configInfo]

![在这里插入图片描述][20201105195843673.png_pic_center]  
**发现版本却还是显示为1.0，无论刷新多少次都没有效果！除非重启客户端服务！**

那难道每次我们每次修改云端的配置文件，客户端都需要进行重启吗？如果真的需要这么操作的话那将会是灾难级的，当我们微服务模块越来越多的情况下，分布式配置的客户端就会越来越多，那每次都需要重启操作，这将是一件特别影响性能的事情！所以我们引入了Config客户端动态刷新的概念。

### 3.实现过程 ###

在configclient-3355的pom.xml文件中引入actuator监控依赖：

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

修改bootstrap.yml配置文件，添加以下内容，暴露监控端口：

#暴露监控端点
    management:
      endpoints:
        web:
          exposure:
            include: "*"

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 8]

在控制器中加入@RefreshScope注解，开启客户端配置热更新：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 9]

4.重启服务后，将GitHub上面的application-dev.yml配置文件的版本修改为3.0：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 10]  
在不重启任何服务的情况下，访问ConfigServer：[http://localhost:3344/master/application-dev.yml/][http_localhost_3344_master_application-dev.yml]：

![在这里插入图片描述][20201105200543133.png_pic_center]  
**特别注意**：

在访问ConfigClient之前需要先发送post请求：[http://localhost:3355/actuator/refresh][http_localhost_3355_actuator_refresh]，刷新config-client，在这里我用的是postman发送post请求：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 11]

之后在不重启任何服务的情况下，再访问ConfigClient：[http://localhost:3355/configInfo][http_localhost_3355_configInfo]

![在这里插入图片描述][20201105200829356.png_pic_center]  
**发现版本号已经变成了3.0，成功实现了客户端3355刷新到最新配置内容，避免了服务的重启，实现了分布式配置中心客户端的动态刷新功能！！！**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/35083f8146ae4533837a55fb6c459baf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/d16e115efd964e3495ea6c69d15dafad.png
[Git_GitLab]: https://blog.csdn.net/weixin_44009447/article/details/106426052
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221120/8ca939c121914248b68fe55fb28c1038.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221120/cbccdac3fe4a4356b6c0a4d142a499e8.png
[http_localhost_3344_master_application-test.yml]: http://localhost:3344/master/application-test.yml
[20201105194214159.png_pic_center]: /images/20221120/b31f89087ba34ad7a9a7ab9174a2c93b.png
[http_localhost_3344_application-test.yml]: http://localhost:3344/application-test.yml
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221120/f61142bed716490f9325f7c2d65b1fa6.png
[http_localhost_3344_application-test.yml_master]: http://localhost:3344/application-test.yml/master
[20201105194500102.png_pic_center]: /images/20221120/b391fe00743344a1a4547f6bb2844cee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221120/36296ab5973b4dedba07fc80d16f5c9f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221120/a6b3b2308bd44c2fa6d5e1f98981c328.png
[http_localhost_3355_configInfo]: http://localhost:3355/configInfo
[20201105195143701.png_pic_center]: /images/20221120/d9bdba7010d84c80a9ba6530216ae1ca.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221120/cc9a047e59284c96997312854de63928.png
[http_localhost_3344_master_application-dev.yml]: http://localhost:3344/master/application-dev.yml
[20201105195729480.png_pic_center]: /images/20221120/dc58c5cc76404ab0959657d1700d57fc.png
[20201105195843673.png_pic_center]: /images/20221120/b77d013a3694445884049ce241ec8857.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20221120/c6336c999a5545b5b24f4b77d39d472f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20221120/6cac8c4464d84279bb4a8b48b32f0e8a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 10]: /images/20221120/51cc639583b045f3999780a66e59ef62.png
[20201105200543133.png_pic_center]: /images/20221120/4b36f3a858ba48a7b4613b6b639da845.png
[http_localhost_3355_actuator_refresh]: http://localhost:3355/actuator/refresh
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDAwOTQ0Nw_size_16_color_FFFFFF_t_70_pic_center 11]: /images/20221120/06f57eff93674c17bc46abc4517a073b.png
[20201105200829356.png_pic_center]: /images/20221120/8a6b7ba41ce64c35b137fcbbca83e11e.png