九、分布式配置中心Config

秒速五厘米 2023-05-22 14:25 14阅读 0赞

### 文章目录 ###

*  一、Config介绍
 *  二、Config的使用
 *   *  2.1 与 Github 整合配置
     *  2.2 Config Server的搭建
     *  2.3 配置读取规则
     *  2.4 Config Client的使用
     *  2.5 动态刷新客户端

# 一、Config介绍 #

**Config 简介**

微服务意味着要将单体应用中的业务拆分成一个个子服务，每个服务的粒度相对较小，因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行，所以一套集中式的、动态的配置管理设施是必不可少的，`SpringCloud`提供了`ConfigServer`来解决这个问题。`ConfigServer`结构如下：  
![Config Server][]  
`SpringCloud Config`为微服务架构中的微服务提供集中化的外部配置支持，配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。`SpringCloud Config`分为服务端和客户端两部分。

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

**Config 作用**

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

# 二、Config的使用 #

## 2.1 与 Github 整合配置 ##

由于`SpringcloudConfig`默认使用`Git`来存储配置文件（也有其他方式，比如支持`SVN`和本地文件），但最推荐的是`Git`，而且使用`http/https`访问的形式。

创建一个`GitHub`项目`cloud-config`，并添加一个`config-dev.yml`文件，内容为：

config:
      info: "master branch,config-repo config-dev.yml version=9"

![在这里插入图片描述][20201016103901545.png]

## 2.2 Config Server的搭建 ##

**① 创建配置中心模块`config-center-3344`项目**

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

**② 配置文件：**

server:
      port: 3344
    
    spring:
      application:
        name: cloud-config-center
      cloud:
        config:
          server:
            git:
              uri: git@github.com:eiletxie/config-repo.git #Github上的git仓库名字
              ##搜索目录.这个目录指的是github上的目录
              search-paths:
                - config-repo    
          ##读取分支
          label: master
    
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:7001/eureka/

**③ 主启动类上添加注解`@EnableConfigServer`**

④ 访问`http://localhost:3344/master/config-dev.yml`，即可返回`config-dev.yml`的内容  
![在这里插入图片描述][20200418190054754.png]

## 2.3 配置读取规则 ##

**① /\{label\}/\{application-\{profile\}.yml\}**

例：`http://localhost:3344/master/config-dev.yml`  
![在这里插入图片描述][20200418220902469.png]  
**② /\{application-\{profile\}.yml\}**

例：`http://localhost:3344/config-dev.yml`，默认返回`master`分支信息  
![在这里插入图片描述][20200418221001577.png]  
**③ /\{application/\{profile\}/\{label\}**

例：`http://localhost:3344/config/dev/master`  
![在这里插入图片描述][20200418221201904.png]

## 2.4 Config Client的使用 ##

**① 创建配置中心模块`config-center-3355`项目**

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

**② 创建配置文件`bootstrap.yml`**

**bootstrap.yml 介绍：**

`application.yml`是用户级的资源配置项，`bootstrap.yml`是系统级，优先级更高。`Spring Cloud`会创建一个`Bootstrap Context`，作为`Spring`引用的核心`Application Context`父上下文(环境)。初始化的时候，`Bootstrap Context`负责从外部加载配置属性并解析配置，这两个上下文共享一个外部获取的`Environment`。

`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
          uri: http://localhost:3344
    eureka:
      client:
        service-url:
          defaultZone: http://eureka7001.com:7001/eureka/

**③ 测试代码：**

@RestController
    public class ConfigClientController { 
    
        //config仓库以rest形式暴露，所以所有客户端都可以通过config服务端访问到github上对应的文件信息
        @Value("${config.info}")
        private String configInfo;
    
        @GetMapping("/configInfo")
        public String configInfo(){ 
            return configInfo;
        }
    }

**④ 访问`http://localhost:3355/configInfo`，即可返回`config-dev.yml`的内容**  
![在这里插入图片描述][20200418223441583.png]

## 2.5 动态刷新客户端 ##

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

**① POM引入 actuator 监控**

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

**②添加 YML ，暴露 actuator 监控端口**

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

**③业务类 Controller 修改：添加`@RefreshScope`**

**④发送 post 请求刷新客户端**

`curl -X POST “http://localhost:3355/actuator/refresh”`

此时客户端已经动态刷新配置了。

[Config Server]: /images/20230521/8f6322457343487a874b1a8a6cc457ae.png
[20201016103901545.png]: /images/20230521/5cc373621c884e36a33d301e7c20abc8.png
[20200418190054754.png]: /images/20230521/4a78dd4cfa3b469cb1581adcdfd96f78.png
[20200418220902469.png]: /images/20230521/ac40137b90934d6a8d36cac0babbd233.png
[20200418221001577.png]: /images/20230521/10a86558c75549c89e99af01086b33f1.png
[20200418221201904.png]: /images/20230521/ac99f567716c454b89390d2141977d78.png
[20200418223441583.png]: /images/20230521/44cde4a81aee483c9ecd6c4428dd73b4.png