Spring Cloud Config 配置中心

知识储配

Spring Boot对数据文件的加载机制如下,标号越小优先级越高:

  1. 在命令行中出传入的参数
  2. SPRING_APPLICATION_JSON中的属性。SPRING_APPLICATION_JSON是以Json个格式配置在系统环境变量中的内容
  3. java:comp/env中的JNDI属性
  4. Java的系统属性,可以通过System.getProperties()获得的内容
  5. 操作系统的环境变量
  6. 通过random.*配置的随机属性
  7. 位于当前应用jar包之外,针对不同{profile}环境的配置文件内容,例如application-{profile}.properties或是YAML定义的配置文件
  8. 位于当前应用jar包之内,针对不同{profile}环境的配置文件内容,例如application-{profile}.properties或是YAML定义的配置文件
  9. 位于当前应用jar包之外的application.properties和YAML配置内容
  10. 位于当前应用jar包之内的application.properties和YAML配置内容
  11. 在@Configuration注解修改的类中,通过@PropertySource注解定义的属性
  12. 应用默认属性,使用SpringApplication.setDefaultProperties定义的内容

由7和9都是从jar包之外读取配置文件,实现外部配置化的原理即此。我们在工程中的配置就变的非常干净,只需在本地防止开发需要的配置即可。

概述

Spring Cloud Config分为服务端和客户端。

服务端是一个独立的微服务应用,其连接配置仓库并为其他微服务提供获取配置信息的接口。

客户端则是微服务架构中的各个微服务应用或基础设施。

配置仓库默认采用Git,天然支持对配置信息的版本管理。

参考手册

服务端

1. 依赖:

<dependencies>
    <dependency>
        <groupId>org.springframeword.cloud</groud>
        <artifactId>spring-cloud-config-server</artifactId>
    </dependency>
</dependencied>

2. 注解:
@EnableConfigServer

3. application.properties:

# 在Config Server的依赖jar包下有一个configserver.yml的文件,提供了默认的配置(包含仓库)
# 自报家名
spring.application.name=config-server
# 访问端口号
server.port=7001

spring.cloud.config.server.git.uri=xxx.git # 配置Git仓库的位置
spring.cloud.config.server.git.searchPaths=xxx #配置仓库路径下的相对搜索位置,可以配置多个
spring.cloud.config.server.git.username=xxx # 访问Git仓库的用户名
spring.cloud.config.server.git.password=xxx # 访问Git仓库的用户密码

【注】:第5步中的{applicaiton}、{profile}、{label}可以在配置git仓库的路径中使用。其中,若Git的分支和标签名包含/,则{label}参数在HTTP的URL中应使用"(_)"代替,详见《Spring Cloud微服务实战》的P276。

4. 仓库下文件

  • xxx.properties
  • xxx-dev.properties
  • xxx-test.properties
  • xxx-pro.properties

5. 通过http访问,访问规则如下

  • /{application}-{profile}.yml:默认分支下的文件
  • /{application}-{profile}.properties:默认分支下的文件
  • /{label}/{application}-{profile}.yml:指定分支下的文件
  • /{label}/{application}-{profile}.properties:指定分支下的文件
  • /{application}/{profile}[/{label}]:文件于分支

其中,各含义如下:

  • {application}:仓库里配置文件名(文件名可以包含-)
  • {profile}:仓库里配置文件名的环境(如dev、test、pro)
  • {label}:分支,缺省为master

以上规则会映射{application}-{profile}.properties的配置文件,如访问http://xxx:7001/{application}/{profile}[/{label}]

客户端

1. 依赖:

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

2. 新建bootstrap.properties

# 自报家门
spring.application.name=xxx
server.port=7002

# 我要dev环境的配置文件
spring.cloud.config.profile=dev
# 我要xxx分支上的配置文件
spring.cloud.config.label=master
# 服务端的访问路径
spring.cloud.config.uri=http ://xxx:7001/

如果将以上内容写在application.properties文件中,从spring cloud config 配置中心读取数据报:Fetching config from server at: http://localhost:8888错误

bootstrap.properties文件的更多介绍参见官网介绍,配合着这里看

3. 在代码中使用配置参数

@Value("${key}")
或
environment.getProperty("kye","defaultValue")

补充

客户端应用从配置管理中获取配置信息遵从下面的执行流程:

  1. 应用启动时,根据bootstrap.properties中配置的应用名{application}、环境名{profile}、分支名{label},向Config Server请求获取配置信息
  2. Config Server根据自己维护的Git仓库信息和客户端传递过来的配置定位信息去查找配置信息
  3. 通过git clone命令将找到的配置信息下载到Config Server的文件系统中
  4. Confit Server创建Spring的ApplicationContext实例,并从Git本地仓库中加载配置文件,最后将这些配置内容读取出来返回给客户端应用
  5. 客户端应用在获得外部配置文件后加载到客户端的ApplicationContext实例,该配置内容的优先级高于客户端Jar包内部的配置内容,所以在Jar包中重复的内容将不再被加载

Config Server巧妙地通过 git clone将配置信息存于本地,起到了缓存作用,即使当Git服务端无法访问的时候, 依然可以取Config Server中的缓存内容进行使用。

Config Server支持多仓库的配置,以及仓库子目录的配置,详见《Spring Cloud微服务实战》的P277-278。

Config Server支持自定义本地git仓库的路径,通过spring.cloud.config.server.git.basedir来指定。

Config Server的健康监测详见《Spring Cloud微服务实战》的P280。

Config Server支持为所有客户端提供相同配置的能力,通过spring.cloud.config.server.overrides.xxx=xxx来指定。

Config Server可以使用Spring Security组件增加其安全性。方式如下:

  1. Config Server增加依赖
    <dependency>
        <groupId>org.springframeword.boot</groud>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
  1. Config Server 在application.properties中增加配置
spring.security.user.name=user
spring.security.user.password=123
  1. Config Client在bootstrap.properties中增加配置
spring.cloud.config.username=user
spring.cloud.config.password=123

Config Server可以对敏感配置进行加密解密操作,详见《Spring Cloud微服务实战》的P282-285。

Config Server和Config Client都可以服务化(通过Eureka),详见《Spring Cloud微服务实战》的P287-290。

Config Client向Config Server请求配置信息的时候,支持失败快速响应与重试策略,详见《Spring Cloud微服务实战》的P290-292。

当配置改变的时候,Config Client具备动态刷新(无需重启)的能力,方法如下:

  1. 引入依赖,该依赖包含了/refresh端点的实现,用于实现客户端应用配置信息的重新获取与刷新
    <dependency>
        <groupId>org.springframeword.boot</groud>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
  1. 修改Git仓库的配置新建
  2. (POST)调用Client的/refresh接口
  3. 可以使用Spring Cloud Bus来实现以消息总线的方式进行配置变更的通知...

遇到的一些问题

  1. Spring Boot项目启动遇到Process finished with exit code 0
  2. Eureka和Config Server的启动顺序问题
  3. Config Server 如何实现高可用
  4. Config Server 如何实现高可用

他山之石

为什么需要分布式配置中心?
一篇好TM长的关于配置中心的文章
阿里云ACM:云原生配置管理利器
“野生”Java程序员学习的道路
Spring Cloud Config 规范

推荐阅读更多精彩内容