杂乱无章

Spring Cloud Config

2/18/2021 SpringCloud

Spring Cloud Config 分为服务端和客户端两个部分。服务端被称为分布式配置中心，它是个独立的应用，可以从配置仓库获取配置信息并提供给客户端使用。客户端可以通过配置中心来获取配置信息，在启动时加载配置。Spring Cloud Config 的配置中心默认采用Git来存储配置信息，所以天然就支持配置信息的版本管理，并且可以使用Git客户端来方便地管理和访问配置信息

# Spring Cloud Config

# 统一配置中心

如果微服务架构中没有使用统一配置中心时，所存在的问题：

  • 配置文件分散在各个项目里，不方便维护
  • 配置内容安全与权限，实际开发中，开发人员是不知道线上环境的配置的
  • 更新配置后，项目需要重启

# 在Git仓库中准备配置信息 (opens new window)

由于Spring Cloud Config 需要一个存储配置信息的Git仓库，这里我们先在Git仓库中添加好配置文件再演示其功能，

Git仓库地址为：原作者地址 (opens new window)，fork下来修改为自己的地址，便于后面在仓库修改配置调用服务查看配置修改是否生效

主要结构：

  • master dev 分支
  • 分支中的各环境单独的一个配置文件，application-dev.yml、application-test.yml、application-pro.yml等
  • 多个微服务的多个环境配置文件，可以创建子目录区分，这里只创建了**\config**子目录作为测试

# 创建config-server模块 (opens new window)

  • 依赖
<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>
1
2
3
4
5
6
7
8
  • application.yml配置
server:
  port: 8901
spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git: # 配置存储配置信息的Git仓库，改成自己的地址，便于修改后配置文件后测试
          uri: https://gitee.com/myMagicRain/springcloud-config.git
          username: macro
          password: 123456
          clone-on-start: true #开启启动时直接从git获取配置
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8001/eureka/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
  • 启动类添加@EnableConfigServer注解启用配置中心功能

# 创建config-client模块 (opens new window)

  • 依赖
<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>
1
2
3
4
5
6
7
8
9
10
11
12
  • 添加bootstrap.yml配置文件

注意：之所以要用bootstrap.yml，是因为启动SpringBoot项目时，会优先读取bootstrap.yml里的配置，然后才会读取application.yml。如果不通过bootstrap.yml里的配置，先从配置中心拉下相应的配置文件，就会报错

总结：bootstrap.yml（bootstrap.properties）用来在程序引导时执行，应用于更加早期配置信息读取，如可以使用来配置application.yml中使用到参数等；application.yml（application.properties) 应用程序特有配置信息，可以用来配置后续各个模块中需使用的公共参数等；bootstrap.yml 先于 application.yml加载

典型场景：当使用 Spring Cloud Config Server 的时候，你应该在 bootstrap.yml 里面指定 spring.application.name 和 spring.cloud.config.server.git.uri或者一些加密/解密的信息

server:
  port: 9001
spring:
  application:
    name: config-client
  cloud:
    config:                # Config客户端配置
      profile: dev         # 启用配置后缀名称
      label: dev           # 分支名称
      uri: http://localhost:8901  # 配置中心地址
      name: config 				  # 配置文件名称
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8001/eureka/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  • 添加ConfigClientController类用于获取配置
@RestController
public class ConfigClientController {

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

    @GetMapping("/configInfo")
    public String getConfigInfo() {
        return configInfo;
    }
}
1
2
3
4
5
6
7
8
9
10
11

# 获取配置文件信息

  • 配置文件信息的访问格式
# 获取配置文件信息
/{label}/{application}-{profile}
# 获取配置文件内容信息
/{label}/{application}-{profile}.yml
1
2
3
4
  • 占位符配置说明
占位符 说明 对应配置
label 分支名称 对应配置文件中的spring.cloud.config.label
application 应用名称 默认为配置文件中的spring.application.name，如果配置了spring.cloud.config.name，则为该名称
profile 环境名称 对应配置文件中的spring.cloud.config.profile

启动eureka-server、config-server服务，

访问 http://localhost:8901/master/config-dev，来获取master分支上dev环境的配置信息；

访问 http://localhost:9001/configInfo，可以获取到dev分支下dev环境的配置；

# 获取子目录配置

多个微服务的多环境统一用一个git配置中心，默认扫描根目录，会使得配置文件过于臃肿，按服务创建不同的子文件夹目录，方便管理

  • 添加config-server中application-yml配置
spring:
  cloud:
    config:
      server:
        git: 
          search-paths: '{application}'        # 对应服务名相同的文件夹子目录配置文件
#          search-paths: /config               # config目录下的配置文件
#          search-paths: /**                   # 所有目录下的配置文件
1
2
3
4
5
6
7
8

使用'{application}'占位符配置，说明是config服务就使用config子文件夹下面的配置文件，config服务就是前面说的spring.cloud.config.name,

# 刷新配置 (opens new window)

  • config-client添加依赖
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
1
2
3
4
  • 添加bootstrap.yml配置
management:
  endpoints:
    web:
      exposure:
        include: 'refresh'
1
2
3
4
5

  • 添加刷新配置注解

    在需要刷新配置的地方添加，这里也就是 ConfigClientController 添加@RefreshScope注解用于刷新配置；

    重启config-client后，post请求http://localhost:9001/actuator/refresh即可刷新配置，重新调用http://localhost:9001/configInfo验证配置是否更改成功

# 创建config-security-server模块 (opens new window)

给配置中心添加安全认证

  • 依赖
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>
1
2
3
4
5
6
7
8
  • 添加application-yml配置，启动服务
server:
  port: 8905
spring:
  application:
    name: config-security-server
  cloud:
    config:
      server:
        git:
          uri: https://gitee.com/myMagicRain/springcloud-config.git
          username: macro
          password: 123456
          clone-on-start: true #开启启动时直接从git获取配置
  security: #配置用户名和密码
    user:
      name: macro
      password: 123456
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
  • 修改config-client配置，重新启动
server:
  port: 9002
spring:
  application:
    name: config-client
  cloud:
    config:
      profile: dev #启用配置后缀名称
      label: dev #分支名称
      uri: http://localhost:8905 #配置中心地址
      name: config #配置文件名称
      username: macro    # 配置中心的用户名和密码，如果错误，服务启动会报错，无法加载从配置中心加载配置文件
      password: 123456
1
2
3
4
5
6
7
8
9
10
11
12
13

启动使用bootstrap-security.yml配置的config-client服务；

访问http://localhost:9002/configInfo进行测试，发现可以获取到配置信息，配置中心加入安全验证成功

# config-sever集群搭建 (opens new window)

所有微服务从配置中心获取配置文件，一旦配置中心宕机，就会发生严重的后果，所以需要搭建配置中心集群，保证服务正常运行

  • 启动两个端口的config-server 8902，8903

  • 修改config-client配置文件，添加了从注册中心获取配置中心地址的配置并去除了配置中心uri的配置

spring:
  cloud:
    config:
      profile: dev		 # 启用环境名称
      label: dev 		 # 分支名称
      name: config       # 配置文件名称
#     uri: http://localhost:8901 # 去除了配置中心地址，改为下面配置
      discovery:
        enabled: true
        service-id: config-server # 指定从注册中心中根据服务名获取配置中心地址，
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8001/eureka/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
  • 访问http://localhost:9003/configInfo，发现config-client可以获取到配置信息。

Spring Cloud Bus