springcloud-config配置中心

本篇文章所涉及到的demo练习均采用cloud 2021.0.3+ springboot2.6.8

一、概述简介

官网：https://docs.spring.io/spring-cloud-config/docs/3.1.3/reference/html/

1.1. 分布式系统面临的问题

微服务意味着要将单体应用中的业务拆分成一个个子服务，每个服务的粒度相对较小，因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行，所以一套集中式的、动态的配置管理设施是必不可少的（配置指的是springboot项目当中的application.properties/application.yml）。

SpringCloud提供了Config来解决这个问题。

1.2. config是什么

SpringCloud Config为微服务架构中的微服务提供集中化的外部配置支持，配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。

git大家应该都用过，现在git云端比较火的有gitee码云、gitHub。而config框架就是将我们的配置文件存放到git云端，目的就是集中化管理和支持动态修改配置文件。

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

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

如下图所示：我们每个微服务其实就是一个客户端，客户端需要从Config服务端来获取配置，而Config服务端连接了git云端，他是从云端来拉取数据的。可能有的人该好奇了，我直接让客户端从云端拉取数据就可以了呀，是可以没问题，可Java讲究的是高内聚，低耦合。服务端可以把它当做就是一个中介，他负责和git连接，其他的通过中介来获取信息。

1.3. config能干嘛

1. 集中管理配置文件
2. 不同环境不同配置，分环境部署比如dev/test/prod/beta/release
3. 运行期间动态调整配置，不再需要在每个服务部署的机器上编写配置文件，服务会向配置中心统一拉取配置自己的信息
4. 当配置发生变动时，服务不需要重启即可感知到配置的变化并应用新的配置
5. 将配置信息以REST接口的形式暴露
6. 由于SpringCloud Config默认使用Git来存储配置文件(也有其它方式,比如支持SVN和本地文件)，但最推荐的还是Git，而且使用的是http/https访问的形式。

二、Config服务端配置与测试

2.1. git环境准备

首先我们需要准备一个远端仓库，可以是gitee，也可以是github。

github教程：https://blog.csdn.net/weixin_43888891/article/details/112385076

这里我选择用gitee，不图别的就因为他是国内的，中文并且访问速度快。

这里我在gitee上创建了一个cloud-config仓库，然后放了三个配置文件，application-dev.yml，appcation-test.yml，还有一个配置文件在prod目录下，名字为application-prod.yml。

记住文件名字也是有限制的，必须是 name（这个name可以为任意字母）- profile（环境）

config只支持yml和properties文件，他是为配置文件而生，并不是所有文件都可以的。

配置文件内容随意，能区分即可，主要用来测试用的！

2.2. 搭建服务端

1.新建一个项目
2.添加pom依赖

<properties>
    <maven.compiler.source>8</maven.compiler.source>
    <maven.compiler.target>8</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <springboot.version>2.6.8</springboot.version>
    <springcloud.version>2021.0.3</springcloud.version>
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-dependencies</artifactId>
           <version>${springboot.version}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
        <dependency>
           <groupId>org.springframework.cloud</groupId>
           <artifactId>spring-cloud-dependencies</artifactId>
           <version>${springcloud.version}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
    </dependencies>
</dependencyManagement>

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

3.添加yml配置

server:
  port: 3344
  
spring:
  application:
    name:  cloud-config-center #注册进Eureka服务器的微服务名
  cloud:
    config:
      ####读取分支
      label: master
      server:
        git:
          uri: https://gitee.com/gzl_com/cloud-config.git #GitHub上面的git仓库名字
          # 搜索目录，默认config只会搜索git的根目录的，假如配置文件在git子目录下，需要添加如下配置
          search-paths:
            - prod
            #  - test 子目录可以有多个的

		  # 以下配置都是可有可无的配置，可根据实际场景来进行设置
          timeout: 4 # 超时时间，以秒为单位
          # Config Server会克隆远程 git 存储库，以防本地副本变脏（例如，OS 进程更改文件夹内容），使得 Config Server无法从远程存储库更新本地副本。以下属性true可以强制从远程仓库拉取
          force-pull: true
          # 删除 Git 存储库中未跟踪的分支
          deleteUntrackedBranches: true
          # Git刷新率,默认值为 0，这意味着配置服务器将在每次请求时从 Git 存储库获取更新的配置。（以秒为单位）
          refresh-rate: 0  

4.启动类添加注解@EnableConfigServer

2.3. 测试服务端

一共有如下访问方式：

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

/{label}-{name}-{profiles}.yml

• label：分支(branch)
• name ：服务名
• profiles：环境(dev/test/prod)

下面我只是测试了application-dev，其实application-test和prod也都是可以访问的哟

（1）注意：配置文件不能携带spring.profiles.active，否则直接会异常。

（2）注意： 访问的时候也拿到配置了，但是看控制台竟然有报错信息

然不影响程序的运行，但是对我一个追求完美的程序员来说，有点这样的小bug也实在看不下去。

解决办法：添加如下配置

（3）注意： 当我们修改gitee上的配置文件并提交后，config在不重启的情况下可以拿到最新的配置，基于这一点我也专门做了测试，没有任何问题。

通过以上示例成功实现了用SpringCloud Config通过Gitee获取配置信息

三、Config客户端配置与测试

3.1. 搭建客户端

1.新建一个项目
2.添加pom依赖

<properties>
    <maven.compiler.source>8</maven.compiler.source>
    <maven.compiler.target>8</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <springboot.version>2.6.8</springboot.version>
    <springcloud.version>2021.0.3</springcloud.version>
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-dependencies</artifactId>
           <version>${springboot.version}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
        <dependency>
           <groupId>org.springframework.cloud</groupId>
           <artifactId>spring-cloud-dependencies</artifactId>
           <version>${springcloud.version}</version>
           <type>pom</type>
           <scope>import</scope>
       </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <!-- 这块依赖和服务端是不一样的，服务端的是spring-cloud-config-server-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!--cloud新版本默认将bootstrap移除了，所以需要添加如下依赖-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-bootstrap</artifactId>
    </dependency>
</dependencies>

3.添加bootstrap.yml配置

server:
  port: 3355

spring:
  application:
    name: config-client
  cloud:
    #Config客户端配置
    config:
      label: master #分支名称
      name: application #配置文件名称
      profile: dev #读取后缀名称   上述3个综合：master分支上config-dev.yml的配置文件被读取http://config-3344.com:3344/master/config-dev.yml
      uri: http://localhost:3344 #配置中心地址
	  request-connect-timeout: 10000 #使用属性配置连接超时
      request-read-timeout: 185000 #使用属性配置读取超时

name: wdaw	  

4.添加业务类

@RestController
public class ConfigClientController {
    @Value("${name}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo() {
        return configInfo;
    }
}

3.2. 测试客户端

启动项目测试访问：http://localhost:3355/configInfo

这里会发现一个问题bootstrap配置文件当中配置了name: wdaw但是被git远端的配置文件给覆盖了。

注意：当config的客户端和服务端都启动的情况下，修改git上面的配置，服务端可以实时拿到新的配置，但是客户端却没拿到，如下所示：

然后重启3355客户端后，拿到的配置就是最新的了，问题来了，难道每次运维修改配置文件客户端都需要重启吗？那肯定不行，config有客户端动态刷新功能，需要配置，在后面会说。

3.3. bootstrap.yml

注意客户端将不会再像往常springboot项目一样使用application.yml，而是用bootstrap.yml。

那么bootstrap.yml到底是什么？

• applicaiton.yml是用户级的资源配置项
• bootstrap.yml是系统级的，优先级更加高

Spring Cloud会创建一个“Bootstrap Context”，作为Spring应用的Application Context的父上下文。初始化的时候，Bootstrap Context负责从外部源加载配置属性并解析配置。这两个上下文共享一个从外部获取的Environment。

Bootstrap属性有高优先级，默认情况下，它们不会被本地配置覆盖。 Bootstrap context和Application Context有着不同的约定，所以新增了一个bootstrap.yml文件，保证Bootstrap Context和Application Context配置的分离。

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

一句话一旦使用配置中心，不管是config也好，nacos也罢，都需要使用boostrap来存放配置中心的配置。而针对于除配置中心相关配置之外，其他可以选择放到application.yml当中，也可以放在boostrap当中，不管放在哪个上面，git远端的配置都会覆盖他们（只会覆盖相同的）。

假如不使用配置中心，而项目当中application和boostrap都存在的时候，application会覆盖boostrap当中的配置，原因是boostrap优先加载，然后application属于是后加载 直接会覆盖。

3.4. config客户端之动态刷新

对3355客户端进行调整如下：

1.引入pom

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

2.添加配置文件

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

3.添加注解@RefreshScope

@RestController
@RefreshScope
public class ConfigClientController {
    @Value("${name}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo() {
        return configInfo;
    }
}

4.当git配置有文件有变化的时候，可以通过访问以下接口，就可以在不重启config客户端的情况下，完成配置刷新。

curl -X POST "http://localhost:3355/actuator/refresh"

假如有多个微服务客户端3355/3366/3377。每个微服务都要执行一次post请求,手动刷新？可否广播,一次通知,处处生效？我们可以通过cloud当中的bus来解决这个问题。

下一篇文章进行cloud bus学习！