SpringCloud分布式配置中心——Config

Config

本专栏学习内容来自尚硅谷周阳老师的视频

有兴趣的小伙伴可以点击视频地址观看

由于微服务越来越多，项目越来越庞大，每一个项目都至少有两三个不同环境的application.properties文件，不易管理，假设我们数据库迁移，那么所有配置文件中有关数据库的地址都需要更改，不仅工作量大，有时还可能会漏掉一些服务。SpringCloud Config分布式配置中心应运而生。

概念

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

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

服务端也称为分布式配置中心，它是一个独立的微服务应用，用来连接配置服务器并为客户端提供获取配置信息，加密/解密信息等访问接口

客户端则是通过指定的配置中心来管理应用资源，以及与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。

作用

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

前期准备

SpringCloud Config默认使用Git来存储配置文件(也有其它方式,比如支持SVN和本地文件)，但最推荐的还是Git，而且使用的是http/https访问的形式

• 在git上创建名为springcloud-config的仓库

• 创建master分支以及dev分支

• 每个分支创建两个配置文件，模拟真实环境

Config服务端配置

使用

添加相关依赖

<dependencies>
    
    <dependency>
        <groupId>org.springframework.cloudgroupId>
        <artifactId>spring-cloud-config-serverartifactId>
    dependency>
    <dependency>
        <groupId>org.springframework.cloudgroupId>
        <artifactId>spring-cloud-starter-netflix-eureka-clientartifactId>
    dependency>
    
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webartifactId>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-actuatorartifactId>
    dependency>
    <dependency>
        <groupId>com.yellowstar.springcloudgroupId>
        <artifactId>cloud-api-commonsartifactId>
        <version>1.0-SNAPSHOTversion>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-devtoolsartifactId>
        <scope>runtimescope>
        <optional>trueoptional>
    dependency>
    <dependency>
        <groupId>org.projectlombokgroupId>
        <artifactId>lombokartifactId>
        <optional>trueoptional>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-testartifactId>
        <scope>testscope>
    dependency>
dependencies>

修改配置文件

server:
  port: 3344

spring:
  application:
    name:  cloud-config-center #注册进Eureka服务器的微服务名
  cloud:
    config:
      server:
        git:
          uri: https://gitee.com/yellowstar_459/springcloud-config.git #GitHub上面的git仓库名字
          ####搜索目录
          search-paths:
            - springcloud-config
      ####读取分支
      label: master

#服务注册到eureka地址
eureka:
  client:
    service-url:
      defaultZone: http://localhost:7001/eureka

创建启动类

@SpringBootApplication
@EnableEurekaClient
@EnableConfigServer //开启config服务
public class ConfigCenterMain3344 {
    public static void main(String[] args) {
        SpringApplication.run(ConfigCenterMain3344.class, args);
    }
}

测试

通过http接口访问，我们可以读取到git上我们相应的配置文件

配置读取规则

SpringCloud Config为我们定制了很多种读取配置文件的规则，不用所有的都记下来，只需了解一种即可。

• {application}：等同于config
• {profile}：等同于config-dev中的dev
• {label}：这个是分支信息，例如master

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

另外，我们在配置文件中配置了label: master，地址不包括label时，默认访问的时master分支

Config客户端配置

使用

<dependencies>
    
    <dependency>
        <groupId>org.springframework.cloudgroupId>
        <artifactId>spring-cloud-starter-configartifactId>
    dependency>
    <dependency>
        <groupId>org.springframework.cloudgroupId>
        <artifactId>spring-cloud-starter-netflix-eureka-clientartifactId>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webartifactId>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-actuatorartifactId>
    dependency>
    <dependency>
        <groupId>com.yellowstar.springcloudgroupId>
        <artifactId>cloud-api-commonsartifactId>
        <version>1.0-SNAPSHOTversion>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-devtoolsartifactId>
        <scope>runtimescope>
        <optional>trueoptional>
    dependency>
    <dependency>
        <groupId>org.projectlombokgroupId>
        <artifactId>lombokartifactId>
        <optional>trueoptional>
    dependency>
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-testartifactId>
        <scope>testscope>
    dependency>
dependencies>

配置文件

这里引入一种新的配置文件bootstrap.tml

applicaiton.yml是用户级的资源配置项

bootstrap.yml是系统级的，优先级更加高

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

server:
  port: 3355

spring:
  application:
    name: config-client
  cloud:
    #Config客户端配置
    config:
      label: master #分支名称
      name: config #配置文件名称
      profile: dev #读取后缀名称   上述3个综合：master分支上config-dev.yml的配置文件被读取http://config-3344.com:3344/master/config-dev.yml
      uri: http://localhost:3344 #配置中心地址k

#服务注册到eureka地址
eureka:
  client:
    service-url:
      defaultZone: http://localhost:7001/eureka

主启动类

@EnableEurekaClient
@SpringBootApplication
public class ConfigClientMain3355
{
public static void main(String[] args)
    {
        SpringApplication.run(ConfigClientMain3355.class,args);
    }
}

业务类

主要是读取3344的配置文件

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

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

测试

通过测试可以发现，3355服务正确的读取到了git上的配置文件信息

问题

现在修改git上的配置文件信息，从3344读取发现能正常的读取到更新后的信息

而在3355服务上，如果不重新启动，是无法读取到更新后的信息的

这样就会导致，每次修改配置文件都需要重启所有的客户端服务

Config客户端之动态刷新

使用

为了避免每次修改配置文件都需要重启客户端服务，我们需要用到动态刷新

添加pom依赖

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-actuatorartifactId>
dependency>

修改配置文件

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

修改业务类

在controller上加上@RefreshScope注解

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

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

直至此步完成后，我们修改git上的配置文件，发现3355服务还是不能刷新

还需要运维人员手动的给3355发送一条post请求

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

再次测试发现已经刷新

问题

至此我们已经解决了需要重启才能刷新的问题，目前来看服务是完全可以用的。

但是当微服务客户端越来越多时，每个服务都需要执行一次POST请求，也是比较麻烦甚至有可能遗漏的，能不能通过发送一次通知，让所有（或者指定）微服务客户端生效？

这个问题会在下一章SpringCloud消息总线——Bus中得到解决