阅读 11

9. SpringCloud Config 分布式配置中心

1. 概述

1.1分布式系统面临的---配置问题

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

1.2 是什么

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

1.3 怎么玩

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

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

1.4 能干什么?

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

1.5 与GitHub整合配置

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

1.6 官网


Spring Cloud Config 就是对微服务的配置文件进行统一管理的。其工作原理是,我们首 先需要将各个微服务公共的配置信息推送到 GitHub 远程版本库。然后我们再定义一个 Spring Cloud Config Server,其会连接上这个 GitHub 远程库。这样我们就可以定义 Config 版的 Eureka Server、提供者与消费者了,它们都将作为 Spring Cloud Config Client 出现,它们都会通过连 接 Spring Cloud Config Server 连接上 GitHub 上的远程库,以读取到指定配置文件中的内容。

原理

Config Server 可以组装的最终配置文件格式有三种:yml、properties、json。

2. Config服务端配置与测试

2.1 用自己的gitee账号在gitee上新建一个名为microservicecloud-config的新Repository

2.2 由上一步获得SSH协议的git地址 git@gitee.com:coderTomato/microservicecloud-config.git

2.3 clone到本地目录上

2.3.1 本地地址:/Users/lijun/Desktop/myspringcloud
2.3.2 执行命令 git clone git@gitee.com:coderTomato/microservicecloud-config.git

2.4 在本地/Users/lijun/Desktop/myspringcloud/microservicecloud-config里面新建一个config-dev.yml, 推到远程仓库

2.5 新建Module模块cloud-config-center-3344它即为Cloud的配置中心模块

2.6 pom文件

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
    </dependency>
    <!-- eureka-client-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <!-- devtools-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>
复制代码

2.7 yml文件

server:
  port: 3344


spring:
  application:
    name: cloud-config-center #注册进Eureka服务器的微服务名
  cloud:
    config:
      server:
        git:
          # 指定git远程库地址
          uri: git@gitee.com:coderTomato/microservicecloud-config.git
      search-paths: 
             - microservicecloud-config
      # 读取分支     
    label: master

#服务注册到eureka地址   
eureka:
  client: #客户端注册进eureka服务列表内
    register-with-eureka: true #表示是否将自己注册进eurekaServer默认为true
    fetch-registry: true #是否从EurekaServer抓取已有的注册信息,默认为true 单节点无所谓,集群必须为true才能配合ribbon使用负载均衡
    service-url:
      defaultZone: http://localhost:7001/eureka
复制代码

2.8 主启动类 添加@EnableConfigServer

@SpringBootApplication
@EnableConfigServer
public class ConfigCenterMain3344 {
    public static void main(String[] args) {
        SpringApplication.run(ConfigCenterMain3344.class, args);
    }
}
复制代码

2.9 修改hosts文件,增加映射 127.0.0.1 config3344.com

2.10 测试通过Config微服务是否可以从GitHub上获取配置内容

2.10.1 启动微服务3344
2.10.2 http://config3344.com:3344/master/config-dev.yml

2.11 配置读取规则

/{label}/{application}-{profile}.yml
http://config3344.com:3344/master/config-dev.yml
http://config3344.com:3344/master/config-test.yml
http://config3344.com:3344/master/config-prod.yml

 /{application}-{profile}.yml
http://config3344.com:3344/config-dev.yml
http://config3344.com:3344/config-test.yml
http://config3344.com:3344/config-prod.yml

/{application}/{profile}[/{label}]
http://config3344.com:3344/config/dev/master
http://config3344.com:3344/config/test/master
复制代码

3. Config客户端配置与测试

3.1 新建cloud-config-client-3355

3.2 cloud-config-client-3355的pom文件

<dependencies>
    <!-- 添加消息总线RabbitMQ支持-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-bus-amqp</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
    <!-- eureka-client-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <!-- devtools-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>
复制代码

3.3 添加bootstrap.yml文件

server:
port: 3355

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

eureka:
  client:
    service-url:
      defaultZone: http://localhost:7001/eureka
复制代码
什么是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`配置的分离。
复制代码

3.4 主启动类

@SpringBootApplication
@EnableEurekaClient
public class ConfigClientMain3355 {

    public static void main(String[] args) {
        SpringApplication.run(ConfigClientMain3355.class, args);
    }
}
复制代码

3.5 业务类

@RestController
@RefreshScope
public class ConfigClientController {

    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo(){
        return configInfo;
    }
}
复制代码

3.6 测试

  • 启动config配置中心3344微服务并自测
  • 启动3355作为Client准备访问
    http://localhost:3355/configInfo

3.7 问题随之而来,分布式配置的动态刷新问题

  • Linux运维修改GitHub上配置文件内容
    刷新3344,发现ConfigServer配置中心立刻响应
    刷新3355,发现ConfigClient客户端没有任何响应

  • 3355没有变化除非自己重启或重新加载

难道每次运维修改配置文件,客户端都需要重启?

4. Config客户端之动态刷新

避免每次更新配置都重启客户端微服务3355
动态刷新步骤

(1) 3355模块pom引入actuator依赖

(2) 修改YML, 暴露监控端口

server:
port: 3355

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

#rabbitmq相关配置
rabbitmq:
  host: localhost
  port: 5672
  username: guest
  password: guest

eureka:
  client:
    service-url:
      defaultZone: http://localhost:7001/eureka


#暴露监控端口
management:
  endpoints:
    web:
      exposure:
        include"*"
复制代码

(3) 业务类Controller添加@RefreshScope注解

@RestController
@RefreshScope
public class ConfigClientController {

    @Value("${config.info}")
    private String configInfo;

    @GetMapping("/configInfo")
    public String getConfigInfo(){
        return configInfo;
    }
}
复制代码

(4) 需要运维人员发送Post请求刷新3355
curl -X POST "http://localhost:3355/actuator/refresh"

(5) 此时修改git远程仓库

   访问3355 http://localhost:3355/configInfo 成功实现了客户端刷新到最新配置内容
复制代码