前言
欢迎来到菜鸟SpringCloud实战入门系列(SpringCloudForNoob),该系列通过层层递进的实战视角,来一步步学习和理解SpringCloud。
本系列适合有一定Java以及SpringBoot基础的同学阅读。
配置中心Spring Cloud Config初体验
使用Git存放配置文件
每个项目都会有很多的配置文件,如果采用分布式的开发模式,需要的配置文件随着服务增加而不断增多。配置中心便是解决此类问题的灵丹妙药。
Spring Cloud Config核心功能:
- 提供服务端和客户端支持
- 集中管理各环境的配置文件
- 配置文件修改之后,可以快速的生效
- 可以进行版本管理
- 支持大的并发查询
- 支持各种语言
Spring Cloud Config项目是一个解决分布式系统的配置管理方案。它包含了Client和Server两个部分,server提供配置文件的存储、以接口的形式将配置文件的内容提供出去,client通过接口获取数据、并依据此数据初始化自己的应用。Spring cloud使用git或svn存放配置文件,默认情况下使用git,我们先以git为例做一套示例。
创建配置仓库文件夹
在github上面创建了一个文件夹config-repo用来存放配置文件,为了模拟生产环境,我们创建以下三个配置文件:
// 开发环境 spring-cloud-config-dev.properties // 测试环境 spring-cloud-config-test.properties // 生产环境 spring-cloud-config-prod.properties 复制代码
目录为:
每个配置文件中都写一个属性config.hello,属性值分别是 hello Im dev/test/pro 。
配置server端
下面我们开始配置server端,我们新建一个模块名为config-server,创建模块请参考教程第一章。
pom中添加依赖:
<dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency> </dependencies> 复制代码
然后修改配置文件:
这里需要配置你自己的github或者别的git仓库,并且需要填写自己的账户密码,你可以fork我的springcloud_for_noob项目,在项目基础上进行修改。
server: port: 8769 spring: application: name: spring-cloud-config-server cloud: config: server: git: uri: https://github.com/xxxxx(你自己的账户名)/springcloud_for_noob.git # 配置git仓库的地址 search-paths: config-repo # git仓库地址下的相对地址,可以配置多个,用,分割。 username: xxxxxxxxx # git仓库的账号 password: xxxxxxx 复制代码
Spring Cloud Config也提供本地存储配置的方式。我们只需要设置属性spring.profiles.active=native,Config Server会默认从应用的src/main/resource目录下检索配置文件。也可以通过spring.cloud.config.server.native.searchLocations=file:E:/properties/属性来指定配置文件的位置。虽然Spring Cloud Config提供了这样的功能,但是为了支持更好的管理内容和版本控制的功能,还是推荐使用git的方式。
启动类添加@EnableConfigServer:
@EnableConfigServer @SpringBootApplication public class ConfigServerApplication { public static void main(String[] args) { SpringApplication.run(ConfigServerApplication.class, args); } } 复制代码
直接查看配置文件中的配置信息可访问:
http://localhost:8769/spring-cloud-config-dev.properties
这样服务端就建立好了,并且连接上了远程配置文件仓库。
配置client端
server搞起来之后,最终还是要在业务项目中去获取server端的配置信息
我们新建一个模块名为config-client,创建模块请参考教程第一章。
pom中添加依赖:
<dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <!--无法引入:spring-cloud-config-server--> <artifactId>spring-cloud-config-client</artifactId> </dependency> </dependencies> 复制代码
配置文件:
为了方便起见,我们回归使用properties文件
需要配置两个配置文件:
- application.properties
- bootstrap.properties
application.properties如下:
server.port = 8771 spring.application.name = spring-cloud-config-client 复制代码
bootstrap.properties如下:
spring.cloud.config.name = spring-cloud-config spring.cloud.config.profile = dev spring.cloud.config.uri = http://localhost:8769/ spring.cloud.config.label = master 复制代码
- spring.application.name:对应{application}部分
- spring.cloud.config.profile:对应{profile}部分
- spring.cloud.config.label:对应git的分支。如果配置中心使用的是本地存储,则该参数无用
- spring.cloud.config.uri:配置中心的具体地址
- spring.cloud.config.discovery.service-id:指定配置中心的service-id,便于扩展为高可用配置集群。
特别注意:
上面这些与spring-cloud相关的属性必须配置在bootstrap.properties中,config部分内容才能被正确加载。
因为config的相关配置会先于application.properties,而bootstrap.properties的加载也是先于application.properties。
启动类:
启动类不用附加注解,直接可以开始了。
测试类HelloController:
为了测试客户端能否正确获取参数,我们创建一个测试类HelloController
最终测试:
启动项目后访问:http://localhost:8769/hello ,返回:
如图所示,拿到了配置参数,我们完成了客户端的测试。
但实际中,如更改了配置并将其push到了git服务器上,我们通过客户端访问,仍然会获取旧的参数。这是因为springboot项目只有在启动的时候才会获取配置文件的值,修改git信息后,client端并没有再次去获取。
本章代码:
参考
springcloud(六):配置中心git示例