在分布式系统中,配置文件散落在每个项目中,难于集中管理,抑或修改了配置需要重启才能生效。下面我们使用 spring cloud config 来解决这个痛点。
config server
我们把 config-server 作为 config server,只需要加入依赖:
1
2
3
4
|
<dependency>
<groupid>org.springframework.cloud</groupid>
<artifactid>spring-cloud-config-server</artifactid>
</dependency>
|
在 application.yml 中,进行配置:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
spring:
application:
name: config-server # 名称
cloud:
config:
server:
git:
uri: file: //users/yangdd/documents/code/github/config-repo # 使用本地仓库(用于测试),格式为:file://${user.home}/config-repo 如果是 windows 则是 file:///${user.home}/config-repo
#uri: https: //github.com/yangdd1205/spring-cloud-master/
#username: 用户名
#password: 密码
# default -label: config # 可以是 commit id,branch name, tag name,默认值为 master
#search-paths: # 表示除了在根目录搜索配置文件,还可以在以下目录搜索
#- user
server:
port: 4001 # 端口
|
spring 的项目,一般有个“约定大于配置”的原则。所以我们 git 中的配置文件,一般以 {application}-{profile}.yml 或者 {application}-{profile}.properties 命名。
- {appliction} 映射到客户端 spring.application.name 属性值
- {profile} 映射到客户端 spring.profiles.active 属性值
我们在 config-repo 的 master 分支中,有两个文件 client-dev.yml :
1
|
info: master-dev
|
client-prod.yml :
1
|
info: master-prod
|
在 config 分支中,有两个文文件 client-dev.yml :
1
|
info: config-dev
|
client-prod.yml :
1
|
info: config-prod
|
启动 config-server 我们可以通过下面的映射关系来访问 git 中的配置文件:
1
2
3
4
5
|
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
|
http://localhost:4001/client-dev.yml
config client
我们把 config-client 作为 config client,加入依赖:
1
2
3
4
5
6
7
|
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-web</artifactid>
<dependency>
<groupid>org.springframework.cloud</groupid>
<artifactid>spring-cloud-starter-config</artifactid>
</dependency>
|
在 bootstrap.yml 中配置( bootstrap.yml 会先于 application.yml 加载):
1
2
3
4
5
6
7
8
9
10
11
|
spring:
application:
name: client
cloud:
config:
uri: http: //localhost:4001/ ##表示配置中心的地址
profile: dev # 等同于 spring.profiles.active 属性,但是优先级高于 spring.profiles.active
#label: config # 如果不指定使用 server 中的 label,如果指定了则以 client 的为准
server:
port: 4002 # 端口
|
在 config-client 创建 testcontroller :
1
2
3
4
5
6
7
8
9
10
|
@restcontroller
public class testcontroller {
@value ( "${info}" )
private string info;
@requestmapping (value = "/getinfo" )
public string getinfo() {
return this .info;
}
}
|
访问 http://localhost:4002/getinfo
修改 config-client 配置文件的中 profile 为 prod 再访问,查看结果。
现在我们已经实现了,配置文件统一管理,但是修改配置文件后,如何不重启生效呢?
我们在 config-client 中引入依赖:
1
2
3
4
|
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactid>spring-boot-starter-actuator</artifactid>
</dependency>
|
在需要动态刷新的类上加上注解 @refreshscope ,这里我们在 testcontroller 加上。并在配置文件中把 actuator 的权限认证禁用:
1
2
3
|
management:
security:
enabled: false
|
重启项目, http://localhost:4002/getinfo 结果为: config-dev ,现在修改 config-dev.yml 文件:
1
|
info: config-dev- 1.0
|
调用 actuator 的方法,手动刷新, http://localhost:4002/refresh 注意:必须是 post 方式。 可以看到发生改变了的值有哪些:
1
2
3
|
[
"info"
]
|
再访问 http://localhost:4002/getinfo 结果为: config-dev-1.0 。
我们发现现在虽然可以动态刷新配置了,但是每次都要手动调用刷新方法,假如我有 1000 个服务,那就要调用 1000 次,有没有更好的办法呢?那就是结合 spring cloud bus 使用。
高可用
现在我们的 config server 是一个单点的服务,一旦挂掉后面的 config client 将无法使用。所以在生成中,config server 必须是高可用的,那怎么做呢?很简单,跟我们前面讲的 eureka 的高可用一样,只需要将同一个 config server 多部署几个即可。
我们将项目 eureka 作为注册中心,端口为:7001。
复制 config-server 改为 config-server-1 ,端口为:4003,将两个 config server 都注册到注册中心。
将 config-client 也注册到注册中心,并指定从 eureka 中获取 config server:
1
2
3
4
5
6
7
8
9
|
spring:
cloud:
config:
#uri: http: //localhost:4001/ ##表示配置中心的地址,直接指定 config server 地址
profile: dev
#label: config
discovery:
enabled: true # 启用从服务中获取 config server
service-id: config-server # config server 的服务名
|
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。
原文链接:https://yangdongdong.org/2018/01/13/spring-cloud-config/