带你入门SpringCloud统一配置 | SpringCloud Config
前言
在微服务中众多服务的配置必然会出现相同的配置,如果配置发生变化需要修改,一个个去修改然后重启项目的方案是绝对不可取的。而 springcloud config 就是一个可以帮助你实现统一配置选择之一。
如果你不懂 springcloud config 环境搭建,那么该篇博客将会帮助到你,文中通过具体操作带你了解 springcloud config 环境搭建的入门操作。
阅读本文需要你熟悉 springboot 项目的基本使用即可,还有一点需要注意的是在操作过程中尽量和我本地环境一致,因为环境不一致可能会带来一些问题。我本地环境如下:
- springboot version: 2.1.0.release
- springcloud version: greenwich.release
- apache maven version: 3.6.0
- java version: 1.8.0_144
- idea:spring tools suite (sts)
接下来就开始 springcloud config 环境搭建操作介绍!
搭建 springcloud config 环境
springcloud config 环境搭建最小环境需要 3个 springcloud 项目:一台 eureka server 端、一台 config server 端(也是eureka client 端)、一台普通服务端(即是 config client 也是 eureka client)。
关于eureka环境的搭建请参考我的另一篇博客 带你入门springcloud服务发现 | eurka搭建和使用
config server 端搭建
在 springboot 项目中引入 spring-cloud-config-server 和 spring-cloud-starter-netflix-eureka-client 依赖,具体代码如下:
<dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-config-server</artifactid> </dependency> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-web</artifactid> </dependency> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-netflix-eureka-client</artifactid> </dependency>
在 springboot application 上声明 @enablediscoveryclient 和 @enableconfigserver,具体代码如下:
@springbootapplication @enablediscoveryclient @enableconfigserver public class springcloudconfigserverapplication { public static void main(string[] args) { springapplication.run(springcloudconfigserverapplication.class, args); } }
在 github上创建私有仓库
然后添加配置信息到 github 上。
product.properties 配置可以添加一些公共的配置他会覆盖到 product-dev.properties上
在 application.properties 添加配置信息
spring.application.name=configserver eureka.client.service-url.defaultzone=http://localhost:8761/eureka/ spring.cloud.config.server.git.uri=https://github.com/zhuoqianmingyue/config-repo spring.cloud.config.server.git.username=github帐号 spring.cloud.config.server.git.password=github帐号密码 spring.cloud.config.server.git.basedir=config-repo/config-repo
- spring.application.name:服务的名称
- eureka.client.service-url.defaultzone:eureka server 地址
- spring.cloud.config.server.git.uri:配置github 私有仓库 http 克隆地址
- spring.cloud.config.server.git.username:配置你的 github帐号
- spring.cloud.config.server.git.password:配置你的github帐号密码
- spring.cloud.config.server.git.basedir:克隆配置文件存储地址
config server 端高可用只需要配置多台config server注册到eureka 服务端即可。
测试
第一步启动 eurka server 端(具体代码请从我的github项目获取,github地址下面有介绍)
将 spring-cloud-config-eureka-service 进行打包,通过 mvn clean package -dmaven.test.skip=true
。
进入 target 目录 通过 java -jar 方式启动。
第二步启动 config server 端
第三步最后访问 eurka server 端,如下图所示:
configserver 已经注册到 eurka server 服务端。
访问 config server 端获取配置信息,具体访问地址:http://localhost:8080/product-dev.properties。访问结果如下图所示:
到这里 config server 端搭建介绍完毕!接下来开始 config client 端搭建介绍。
config client 端搭建(商品服务)
在商品服务 springboot 项目中引入 spring-cloud-config-client 和 spring-cloud-starter-netflix-eureka-client 依赖。具体代码如下:
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-web</artifactid> </dependency> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-netflix-eureka-client</artifactid> </dependency> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-config-client</artifactid> </dependency>
在 springboot application上声明 @enablediscoveryclient
@springbootapplication @enablediscoveryclient public class springcloudconfigproductserviceapplication { public static void main(string[] args) { springapplication.run(springcloudconfigproductserviceapplication.class, args); } }
在 src\main\resources 目录下创建 bootstrap.properties, 具体代码如下:
spring.cloud.config.discovery.service-id=configserver spring.cloud.config.discovery.enabled=true spring.cloud.config.profile=dev spring.application.name=product eureka.client.service-url.defaultzone=http://localhost:8761/eureka/
- spring.cloud.config.discovery.service-id:config server 服务名
- spring.cloud.config.discovery.enabled:是否开启配置发现
- spring.cloud.config.profile:启用那个后缀的配置文件
- eureka.client.service-url.defaultzone:eureka server 地址
- spring.application.name:服务的名称
连接接config server配置 spring.cloud.config.xx 和 eureka server 端配置eureka.client.service-url.defaultzone=http://localhost:8761/eureka/ 一定要配置到bootstrap.properties中,否则根不获取不到 config server 的配置信息。
测试
第一步启动 eurka server端 和 config server 端。
第二步启动 config client (商品服务) 端
第三步访问 eurka server 端,如下图所示:
product 已经注册到 eurka server 服务端。
第四步:编写获取 config server 上配置信息的 controller,具体代码如下:
获取的就是红色框的 env 配置项的值。
@restcontroller public class evncontroller { @value("${env}") private string env; @requestmapping("/env") public string evn() { return this.env; } }
游览器访问 localhost:8763/product/env 进行测试,具体结果如下:
小结
springcloud config 执行流程是通用的配置添加配置仓库中(默认使用git),在由 config server 读取配置仓库配置并对外提供接口。其他服务(config client)可以通过调用config server 提供接口来获取配置信息。
搭建过程也并不复杂还是springcloud 添加starter 依赖、添加enablexx 注解、最后在添加相关配置即可。没有操作的最好操作一篇哈!
代码示例
如果你按照上述方式搭建并未成功,可以参考我在github 项目 仓库中模块名为:
- spring-cloud-config-eureka-service
- spring-cloud-config-server
- spring-cloud-config-product-service
进行对比查看是否配置有误。
spring-cloud-get-started 项目地址:
下一篇: 一个自己实现的Vector 完善版本