SpringCloud Config分布式配置中心

概述

场景引入

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

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

关于SpringCloud-Config

• 是什么

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

• 组成

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

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

SpringCloudConfig的作用

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

Config服务端配置与测试

前期准备

• 在GitHub/Gitee上创建一个远程库

• 获取url地址https://gitee.com/kobebryant81/springcloud-config.git
• git clone 拉去到本地git clone git@giteeGit:/kobebryant81/springcloud-config
  • 此处我本地配置了git多账号映射giteeGit-->gitee.com
  • 原始命令 git clone git@gitee.com:kobebryant81/springcloud-config

构建模块

新建Module模块cloud-config-center-3344作为Cloud的配置中心模块CloudConfig Center

搭建环境

• pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <parent>
    <artifactId>cloud2023</artifactId>
    <groupId>top.ljzstudy.springcloud</groupId>
    <version>1.0-SNAPSHOT</version>
  </parent>
  <modelVersion>4.0.0</modelVersion>

  <artifactId>cloud-config-center-3344</artifactId>
  <dependencies>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-config-server</artifactId>
    </dependency>
    <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>
    <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>

</project>

• application.yaml配置文件

server:
  port: 3344

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

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

• 此处配置的远程库url若使用ssh协议连接回连接失败,暂时找不出原因,又知道的大佬,还请评论指教一下(●’◡’●)
• 主启动类添加注解@EnableConfigServer

package top.ljzstudy.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

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

• 修改windows系统hosts文件添加地址映射127.0.0.1 config-3344.com
  • hosts文件地址C:\Windows\System32\drivers

测试

• 测试通过Config微服务是否可以从GitHub上获取配置内容
• 启动注册中心7001和配置中心3344
• 访问http://config-3344.com:3344/master/config-dev.yml

GET http://config-3344.com:3344/master/config-dev.yml

HTTP/1.1 200 
Content-Type: text/plain
Content-Length: 74
Date: Wed, 20 Sep 2023 08:56:06 GMT
Keep-Alive: timeout=60
Connection: keep-alive

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

Response code: 200; Time: 1359ms; Content length: 74 bytes

配置读取规则

• 配置读取规则,SpringCloud官方提供了5种读取的yaml配置文件的规则

• properties文件在开发中基本上已经被yaml/yml文件所替代了,因此此处不再深入探究
• 在启动的actuator中可以看到接口列表

• /{label}/{application}-{profile}.yml(最为常用)
  • master分支
    • http://config-3344.com:3344/master/config-dev.yml
    • http://config-3344.com:3344/master/config-test.yml
    • http://config-3344.com:3344/master/config-prod.yml
  • dev分支
    • http://config-3344.com:3344/dev/config-dev.yml
    • http://config-3344.com:3344/dev/config-test.yml
    • http://config-3344.com:3344/dev/config-prod.yml
• /{application}-{profile}.yml(比较常用)
  • 没有label层,默认访问master分支
  • http://config-3344.com:3344/config-dev.yml
  • http://config-3344.com:3344/config-test.yml
  • http://config-3344.com:3344/config-prod.yml
  • http://config-3344.com:3344/config-xxxx.yml(
    • 返回[]
• /{application}/{profile}[/{label}]
  • http://config-3344.com:3344/config/dev/master
  • http://config-3344.com:3344/config/test/master
  • http://config-3344.com:3344/config/test/dev
• 小结
  • /{name}-{profiles}.yml
  • /{label}-{name}-{profiles}.yml
  • label：分支(branch)
  • name ：服务名
  • profiles：环境(dev/test/prod)
    

成果

成功实现了用SpringCloud Config通过GitHub获取配置信息

Config客户端配置与测试

构建模块

• 新建cloud-config-client-3355
  

搭建环境

• pom文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <parent>
    <artifactId>cloud2023</artifactId>
    <groupId>top.ljzstudy.springcloud</groupId>
    <version>1.0-SNAPSHOT</version>
  </parent>
  <modelVersion>4.0.0</modelVersion>

  <artifactId>cloud-config-client-3355</artifactId>

  <dependencies>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>
    <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>

    <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>
</project>

bootstrap.yaml文件

• 与application.yaml文件的比较

• 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

• 配置文件

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

• 配置说明(一一对应)

• 编写主启动类

package top.ljzstudy.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

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

• 编写业务类(controller)

package top.ljzstudy.springcloud.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

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

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

测试

• 修改config-dev.yml配置并提交到GitHub中，比如加个变量age或者版本号version
• 启动Config配置中心3344微服务并自测http://config-3344.com:3344/master/config-prod.yml

• 启动3355作为Client准备访问
  • http://localhost:3355/configInfo

成果

成功实现了客户端3355访问SpringCloud Config3344通过GitHub获取配置信息

面临的问题

问题随时而来，分布式配置的动态刷新问题

• Linux运维修改GitHub上的配置文件内容做调整
• 刷新3344，发现ConfigServer配置中心立刻响应
• 刷新3355，发现ConfigClient客户端没有任何响应
• 3355没有变化除非自己重启或者重新加载
• 难到每次运维修改配置文件，客户端都需要重启？？噩梦
  • 引入客户端动态刷新Config
    

Config客户端之Config动态刷新

前言

避免每次更新配置都要重启客户端微服务3355

Config动态刷新

对3355模块进行修改

• pom文件引入actuator监控

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

• 修改YML，暴露监控端口

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

• @RefreshScope业务类Controller修改

package top.ljzstudy.springcloud.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

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

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

• 此时,一旦远程库修改配置,传递链路为
  • gitee—> 3344 ---->3355
    

测试

• 启动注册中心7001,配置中心3344和客户端3355

• 访问http://localhost:3355/configInfo

• 在gitee远程库修改yaml文件后再次访问http://localhost:3355/configInfo

• 两次访问version的值均为6
• 需要模拟运维人员发起post请求手动刷新3355

POST http://localhost:3355/actuator/refresh

HTTP/1.1 200 
Content-Type: application/vnd.spring-boot.actuator.v3+json
Transfer-Encoding: chunked
Date: Wed, 20 Sep 2023 09:44:25 GMT
Keep-Alive: timeout=60
Connection: keep-alive

[
  "config.client.version",
  "config.info"
]

Response code: 200; Time: 6922ms; Content length: 39 bytes

• 再次访问http://localhost:3355/configInfo

• 成功刷新,避免客户端重启
  

仍有不足

• 假如有多个微服务客户端3355/3366/3377。。。。。。
• 每个微服务都要执行一次post请求，手动刷新？
• 可否广播，一次通知，处处生效？
• 我们想大范围的自动刷新，求方法
  • 引入SpringCloudBus消息总线,见下一篇博客