统一配置管理Spring Cloud Config

怼烎@ 2022-05-10 13:50 223阅读 0赞

# 统一配置管理Spring Cloud Config #

*  一、统一配置中心概述
    
     *  1.1 使用统一配置原因
     *  1.2 统一配置流动过程
 *  二、Config Server的使用
    
     *  2.1 基本使用例子
     *  2.2 Config文件命名格式
     *  2.3 Config Server的高可用
 *  三、Config Client的使用
 *  四、Spring Cloud Bus实现配置自动更新

## 一、统一配置中心概述 ##

### 1.1 使用统一配置原因 ###

统一配置就是将一个项目的配置文件进行统一管理。比如一个订单服务所在的集群，它们的配置文件是一样的。 如果要对配置文件进行就修改，就需要对每个机器上的配置文件做修改，并且重启。所以需要将配置文件统一管理。 SpringCloudConfig这个组件可以做到这一点。

> 为什么要用到统一配置中心？  
>   
> 1.不方便维护  
>   
> 2.配置内容安全与权限  
>   
> 3.更新配置项目需要重启

### 1.2 统一配置流动过程 ###

Spring Cloud Config组件由“Config Server”和“Config Client”组成。通过git或者其他版本工具进行配置管理。 大致数据流向如下图：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW9ob25nZmVpXzM1OA_size_16_color_FFFFFF_t_70]

> 步骤如下：  
>   
> 1.将配置增添到远端的git上去。  
>   
> 2.Config Server从远端git上拉取配置文件，并更新到本地git。  
>   
> 3.如果远端git不能访问，则从本地git拉去配置文件。  
>   
> 4.Config Client从Config Server中拉取配置文件。  
>   
>   
> Config Client就是各个服务应用。

## 二、Config Server的使用 ##

### 2.1 基本使用例子 ###

1.新建SpringBoot项目，选中“Cloud Config->Config Server”和“Cloud Discovery->Eureka Discovery”， 对应的依赖为。

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

2.在Application启动类上增添注解@EnableConfigServer

@SpringBootApplication
    @EnableDiscoveryClient
    @EnableConfigServer   //增添该注解，从远端服务器拉取配置文件
    public class ConfigApplication {
        public static void main(String[] args) {
            SpringApplication.run(ConfigApplication.class, args);
        }
    }

3.新建git项目，在其上面新建test.yml文件。  
  
4.在配置文件中增添如下配置：

spring:
      cloud:
        # 配置config server
        config:
          server:
            # 使用git作为统一配置中心
            git:
              # 仓库的地址
              uri: https://gitee.com/IndustriousSnail/spring_cloud_config_test
              # git仓库的账号密码
              username: 924634262@qq.com
              password: ××××××××××××

5.启动项目后，在浏览器中输入下面任意一个地址即可查看到git中的test.yml配置

http://localhost:8080/test-a.yml
    http://localhost:8080/test-a.properties
    http://localhost:8080/test-a.json

> git中的配置文件名字为test.yml，需要使用test-加上任意名称才能访问，原因后面会提到。  
>   
> 上述这些地址都可以使用。虽然git中存放的文件是yml文件，但是如果访问时将后缀名变更，springcloud会自动帮我Menu改变格式。

### 2.2 Config文件命名格式 ###

文件的名称组成如下：

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

> 1.  name 服务名。比如订单服务为order，那name=order
> 2.  profiles 环境名。比如测试环境，可以取名test，开发环境dev等。
> 3.  label git的分支名。如果没有分支，那这个可以不写。
> 
> 如果取名的时候没有给出profiles，那么访问的时候需要增添任意一个名称作为环境名。  
> 这也就是上面为什么要用test-a访问的原因

### 2.3 Config Server的高可用 ###

多起几个实例就行了，然后都给注册都Eureka中。

## 三、Config Client的使用 ##

1.增添client需要使用的依赖

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

2.在application.yml中修改为如下配置：

spring:
      application:
        # 项目名称必须给出，这样才能要找order-dev.yml文件，否则会找不到文件
        name: order
      cloud:
        config:
          # 配置Config Client
          discovery:
            # 激活Config Client端的使用
            enabled: true
            # Config Server的服务名称，需要在Eureka中注册
            service-id: CONFIG
          # 配置文件的环境后缀名
          profile: dev

> 此时application.yml中只包含这些内容，此时重启项目会报错（数据库配置找不到）。  
> 是因为spring会首先读取该配置文件，进行必要的初始化，之后再去Config Server拉取配置文件。  
> 为了解决这个问题，我们需要进行第3步

3.将application.yml更名为bootstrap.yml  
  
4.启动项目，项目正常运行。

## 四、Spring Cloud Bus实现配置自动更新 ##

**1.Config Server和Config Client项目中增加bus依赖**

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

2.重新启动项目。

> 登录RabbitMQ，会发现多了两条消息。这条消息是Spring Cloud Bus为我们添加上去的。  
> 一个是Config Server的，一个是Config Client的。它们使用该消息队列进行配置文件的交互。  
>   
> 这里使用的是rabbitMq的默认配置，如果对端口或者账号密码进行了修改，需要进行如下配置：

spring:
         rabbitmq:
           password: guest
           username: guest
           addresses: 127.0.0.1
           port: 5672  # 注意，这里是5672，不是访问界面用的15672，这个是默认值

3.在需要需要实时更新注解的类上增加@RefreshScope

@RestController
    @RefreshScope  //增加该注解保证实时更新
    public class TestContoller {
    
        @Value("${test}")
        private String test;
    }

> 比如我使用了配置中的test注解，如果想让该注解实时更新，需要在该类上增加@RefreshScope

4.config server调用bus refresh接口

增加配置，使用post调用：/bus/refresh

# 如果没有这个注解会报401
    management:
      security:
        enabled: false

高版本中，需要增加配置，使用post调用：/bus-refresh

# 高版本中，一些不安全的接口是被隐藏掉的，需要使用该注解进行全部暴露出来。和低版本同理，高版本更灵活
    management:
      endpoints:
        web:
          expose: "*"

> 这个时候我们发现已经可以在调用bus refresh之后其他的Config Client进行了实时更新。  
> 但是每次都需要调用bus refresh还是不方便。所以需要使用git提供的webhooks

5.使用webhooks进行实时访问bus refresh。

webhooks就是github提供的一个功能，就是当某些文件提交时，可以自动调用某一个地址的接口。  
可以配置vpn或者使用线上地址，来使得github可以访问到。或者除了webhooks也可以使用其他机制，让配置文件更新时自动调用bus refresh也行。  
具体使用方式去网上查查就行。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poYW9ob25nZmVpXzM1OA_size_16_color_FFFFFF_t_70]: /images/20220505/cc68c46d1a764e019ea6a2f21938b23a.png