一、Config的简介
在分布式系统中,由于服务数量巨多,为了方便服务配置文件统一管理,实时更新,所以需要分布式配置中心组件。
市面上开源的配置中心有很多,BAT每家都出过,360的QConf、淘宝的diamond、百度的disconf都是解决这类问题。国外也有很多开源的配置中心Apache的Apache Commons Configuration、owner、cfg4j等等。
在Spring Cloud中,有分布式配置中心组件spring cloud config ,它支持配置服务放在配置服务的内存中(即本地),也支持放在远程Git仓库中。
在spring cloud config 组件中,分两个角色:
一是config server,二是config client。
一个配置中心提供的核心功能:
- 提供服务端和客户端支持
- 集中管理各环境的配置文件
- 配置文件修改之后,可以快速的生效
- 可以进行版本管理
- 支持大的并发查询
- 支持各种语言
Spring Cloud Config可以完美的支持以上所有的需求。
Spring Cloud Config项目是一个解决分布式系统的配置管理方案。它包含了Client和Server两个部分,server提供配置文件的存储、以接口的形式将配置文件的内容提供出去,client通过接口获取数据、并依据此数据初始化自己的应用。Spring cloud使用git或svn存放配置文件,默认情况下使用git,我们先以git为例做一套示例。
二、Config 的使用
1. 新建 Config Server 模块
创建 Config Server 的模块 cloud_10_config_server ,并对程序进行修改和配置。
# 1. 修改子模块
在父模块的pom中引入子模块
cloud_eureka_01
cloud_eureka_client_01
cloud_eureka_client_02
cloud_eureka_feign_01
cloud_eureka_hystrix_02
cloud_Ribbon_01
cloud_zuul_01
cloud_10_config_server
在 子模块 的pom 中添加依赖
com.yaogx
SpringCloudParent
1.0-SNAPSHOT
org.springframework.boot
spring-boot-starter-web
org.springframework.cloud
spring-cloud-config-server
在启动类上添加注解: @EnableConfigServer 开启配置服务器的功能
@SpringBootApplication
@EnableConfigServer
public class CloudConfigApplication {
public static void main(String[] args) {
SpringApplication.run(CloudConfigApplication.class, args);
}
}
在配置文件 application.yml 中配置如下内容
## spring cloud config [server]
server:
port: 9102
# spring config
spring:
application:
name: config-server
cloud:
config:
server:
git:
# 自己在github 上创建一个文件
uri: https://github.com/SoftCancer/SpringcloudConfig.git
# uri: https://github.com/SoftCancer/SpringcloudConfig
search-paths: server
username:
password:
label: master
- spring.cloud.config.server.git.uri:配置git仓库地址
- spring.cloud.config.server.git.search-paths:配置仓库路径
- spring.cloud.config.label:配置仓库的分支
- spring.cloud.config.server.git.username:访问git仓库的用户名
- spring.cloud.config.server.git.password:访问git仓库的用户密码
如果Git仓库为公开仓库,可以不填写用户名和密码,如果是私有仓库需要填写,本例子是公开仓库;
远程仓库:https://github.com/SoftCancer/SpringcloudConfig 中有个 server 文件夹 ,其中有两个配置文件,
分别是:
- 1.config-client-dev.properties 内容如下:
yaosy= yaosy version 001
configclient.message=Hello SpringCloud io
github=https://github.com/SoftCancer/SpringcloudConfig/blob/master/server/config-client-dev.properties
- 2.config-client-prod.properties 内容如下:
spring.application.name= service-config-prod
2. 启动 子模块 继续测试
只需要启动 子模块 cloud_10_config_server 即可,在浏览器中输入地址:http://127.0.0.1:9102/config-client/pro/
在地址栏中输入:http://127.0.0.1:9102/config-client/dev/master
http请求地址和资源文件映射如下:
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
说明:
{application} 就是应用名称,对应到配置文件上来,就是配置文件的名称部分,例如我上面创建的配置文件名的 config-server-clien。
{profile} 就是配置文件的版本,我们的项目有开发版本、测试环境版本、生产环境版本,对应到配置文件上来就是以 application-{profile}.yml 加以区分,例如application-dev.yml、application-sit.yml、application-prod.yml。
{label} 表示 git 分支,默认是 master 分支,如果项目是以分支做区分也是可以的,那就可以通过不同的 label 来控制访问不同的配置文件了。
eg: /{application}/{profile}.properties
http://127.0.0.1:9102/config-client/pro/
/{application}/{profile}[/{label}]
http://127.0.0.1:9102/config-client/dev/master
2 .构建 config client 模块
创建 Config Server 的模块 cloud_11_config_client,并对程序进行修改和配置。
1. 修改父 pom 文件
在父 pom 文件中引入 子模块
cloud_10_config_server
cloud_11_config_client
2. 修改子模块
在子模块的 pom中 引入jar包
org.springframework.boot
spring-boot-starter-web
org.springframework.cloud
spring-cloud-starter-config
3. 新建配置文件 bootstrap.yml
因为spring boot是启动的时候才从配置文件中读取配置属性,配置文件在远程配置中心的话,注册中心的信息需要放在bootstrap.properties中才能启动优先读取,放在application.properties.会报该异常没发现属性
注:配置文件的名称: bootstrap.yml
server:
port: 9103
# spring config
spring:
application:
####注册中心应用名称
name: config-client
cloud:
config:
label: master
profile: dev
uri: http://127.0.0.1:9102/
discovery:
# config配置的服务名
service-id: config-server
配置说明
defaultZone : 注册中心地址。
spring.cloud.config.label : 指明远程仓库的分支
spring.cloud.config.profile
dev: 开发环境配置文件
test: 测试环境
pro: 正式环境
name: config-client # github 上配置文件前缀名称。
service-id : 指明配置服务中心的 应用名称。
4. bootstrap.yml 和 application.yml 区别:
bootstrap.yml(bootstrap.properties)用来在程序引导时执行,应用于更加早期配置信息读取,如可以使用来配置application.yml中使用到参数等
application.yml(application.properties) 应用程序特有配置信息,可以用来配置后续各个模块中需使用的公共参数等。
bootstrap.yml 先于 application.yml 加载
5. 创建 控制类
创建控制类 ConfigClientController.java
@RestController
public class ConfigClientController {
// 果获取不到冒号前的配置,则使用冒号后作为默认值
// @Value("${yaosy:yaosy default}")
@Value("${yaosy}") // github 中配置文件的key值
private String yaosy;
@Value("${github}")
private String github;
@GetMapping("/yaosy")
public String getYaosy(){
return yaosy +"的 github地址:\n" + github;
}
}
6. 启动测试
依次启动: cloud_eureka_01 ,cloud_10_config_server,cloud_11_config_client 子模块。
在浏览器中访问:http://127.0.0.1:9103/yaosy
通过上图可知:config-client从config-server获取了yaosy 的属性,而config-server是从git仓库读取的,如图:
关键点: 配置文件 bootstrap.yml 的配置方式,该文件花费了一天才琢磨对。
感觉对你有帮助就支持一下,谢谢!