spring cloud config 可以将微服务的配置文件进行统一管理,使得我们可以动态调整配置文件以及为不同的环境配置不同的配置。spring cloud config的实现分为两部分,对配置进行统一管理的config-server以及读取配置的config-client。
1 Config Server的实现
首次我们需要在项目依赖中导入config-server
org.springframework.cloud
spring-cloud-config-server
然后在application.yml中进行配置(这里使用git作为配置文件的存放仓库):
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: //存放配置文件的仓库地址
username: //git仓库的账号
password: //git仓库的密码
最后,我们需要在启动类上添加注解@EnableConfigServer
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
这样,我们就能成功配置一个config server。
2 Config Server的端点
config server向外暴露的端点用以让其他微服务获取配置。端点和配置文件的命名对应规则如下:
/{application}/{profile}/[{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
application对应应用程序的名称,profile用来区分相同应用程序的不同环境,label表示git的分支,默认是master。例如,对于应用config-client来说,要获取起dev环境的配置,则端点如下:
/config-client/dev/master
或者
/config-client-dev.yml
而对应的配置文件则要命名为config-client-dev.yml
3 Config Client的实现
首先,同样先要添加config-client的依赖
org.springframework.cloud
spring-cloud-config-client
然后,添加一个bootstrap.yml作为配置文件:
spring:
application:
name: config-client
cloud:
config:
uri: //config-server的地址
profile: default
lable: master
这里的application.name, profile, lable 分别对应上面端点中{application}, {profile}, {lable}。这里要注意的一点是这些配置必须在bootstrap.yml文件中配置,由于bootstrap.yml优先级高于本地的application.yml,而且,在bootstrap.yml中应默认配置了以上信息,所以这些配置如果是在application.yml中的话将不能被读取,而应用将会使用默认的配置,比如说spring.cloud.config.uri默认值为 http://localhost:8888/,如果我们没有在bootstrap.yml中配置的话那么应用就会访问http://localhost:8888/获取配置。另外,bootstrap的配置会被config-server的配置(包括服务器上的application.yml)所覆盖。
通过以上配置,就可以实现统一管理微服务的配置了。
4 设置通用配置
- 可以通过在仓库设置
application*
(比如application.yml
、application.properties
、application-*.yml
等)文件设置通用的配置,每个应用都会读取application*
的配置。 - 对于同一个项目,通过
{application}-{profile}.yml
来区分不同的profile,但是也可以用{application}.yml
的default profile设置通用属性,不管profile是什么,该应用都会读取default profile。 - 通用的配置文件中的配置会被指定application name 和 profile 的配置覆盖。
- 可以通过
/env
端点查看配置的优先级(优先级由高到低):
"configService:https://github.com/Jacob1943/demo-config-repo.git/config-client-dev.yml": {
"info.profile": "dev"
},
"configService:https://github.com/Jacob1943/demo-config-repo.git/application-dev.yml": {
"info.profile": "dev application"
},
"configService:https://github.com/Jacob1943/demo-config-repo.git/config-client.yml": {
"info.profile": "default"
},
"configService:https://github.com/Jacob1943/demo-config-repo.git/application.yml": {
"info.profile": "default application"
},
5 整合Eureka
- 将Config Server 和 Config Client 都注册到Eureka Server 上。
- Config Client 的 bootstrap配置如下:
spring:
application:
name: config-client
cloud:
config:
profile: dev
label: master
discovery:
enabled: true
service-id: config-server
eureka:
client:
service-url:
defaultZone: http://localhost:8001/eureka/
instance:
prefer-ip-address: true
可以看到,主要是将原本指定的Config Server 的url 换成了使用服务发现组件访问Config Server
6 配置内容的加密
6.1 Config Server 的加解密端点
Config Server的加解密功能依赖于JCE(Java Cryptography Extension),使用前需要先安装JCE,安装方法是将JDK/jre/lib/security目录下的两个jar包进行替换。
Config Server 提供了加密和解密的端点,分别是/encrypt
和 decrypt
,可以使用一下命令进行加解密:
curl $CONFIG_SERVER_URL/encrypt -d
curl $CONFIG_SERVER_URL/decrypt -d
6.2 对称加密
- 先配置密钥,设置
encrypt.key
属性,在Config Server 的 配置文件中添加如下配置:
encrypt:
key: hello
注意,目前只能在bootstrap.*
的配置文件进行encrypt.*
的配置,这可能是一个bug。
- 通过加密端点进行加密即可得到加密后的结果。
6.3 非对称加密
相对于对称加密,非对称加密更安全,但比较复杂。
- 首先要生成一个Key Store文件,使用java提供的keytool工具。
keytool -genkeypair -alias mytestkey -keyalg RSA -dname "CN=Web Server,OU=Unit,O=Organization,L=City,S=State,C=US" -keypass changeme -keystore server.jks -storepass letmein
- 将生成的server.jks放到项目的classpath下
- 在配置文件中进行配置:
encrypt:
key-store:
location: server.jks
password: letmein
alias: mytestkey
secret: changeme
- 再执行加密命令就可以获得密文。
6.4 密文的存储
密文的存储使用{cipher} 密文
的形式,比如,在*.yml
中要配置如下:
password: '{cipher}f567da8fb220fcc574ec27dae342e35e36e195039860c8379e3d11a754628998'
但是在*.properties
中,就不需要加单引号:
password={cipher}f567da8fb220fcc574ec27dae342e35e36e195039860c8379e3d11a754628998
这样,Config Server就能自动解密配置内容,如果需要Config Server返回密文,可以设置spring.cloud.config.server.encrypt.enable=false
,这样就可以返回密文给Config Client,再有Config Client自行解密。
7 刷新配置
7.1 手动刷新
可以使用Actuator提供的/refresh
的端点进行配置的刷新。
- 引入actuator的依赖。
- 在配置需要刷新的类添加
@RefreshScope
注解 - 需要刷新配置的时候,向
/refresh
的端点发出POST请求
7.2 自动刷新
集成Spring Cloud Bus进行自动刷新,Spring Cloud Bus使用消息中间件连接分布式系统的几点,这样就可以广播管理指令, Spring Cloud Bus 其实相当于一个分布式的Spring Boot Actuator。当微服务都加入到消息总线的时候,向其中一个微服务的/bus/refresh
端点进行请求的时候,Spring Cloud Bus 会将该消息广播到其他的微服务。由于微服务只需要关注自身的业务,所以讲Config Server 加入到消息总线中,使用 Config Server的/bus/refresh
端点实行配置刷新。
7.2.1 实现自动刷新
- 为各个微服务集成Spring Cloud Config,引入下面的依赖,并配置rabbitmq:
org.springframework.cloud
spring-cloud-starter-bus-amqp
spring:
rabbitmq:
host: localhost
port: 5672
username: guest
password: guest
- 请求Config Server 的
/bus/refresh
端点即可完成配置的刷新。 - 可以使用
/trace
端点跟踪总线事件 - 使用Git的WebHooks,在配置被更改时发送
/bus/refresh
的POST请求到Config Server,即可以实现自动刷新配置。
7.2.2 局部刷新
使用/bus/refresh
端点的destination参数可以指定刷新特定的微服务的配置,比如/bus/refresh?destination=user:8080
。destination的值是指各个微服务的ApplicationContext ID,默认情况下,ApplicationContext ID是spring.application.name:server.port