spring cloud 2.x版本 Config配置中心教程
前言
本文采用Spring cloud本文为2.1.8RELEASE,version=Greenwich.SR3
本文基于前面的文章eureka-server的实现。 参考
概述
在分布式系统中,由于服务数量巨多,为了方便服务配置文件统一管理,所以需要分布式配置中心组件。Spring Cloud Config为分布式系统中的外部化配置提供服务器和客户端支持。
本篇涉及项目的结构为一个Config Server单机模式和适用于链接Git仓库,一个Config Client通过server来展示配置文件数据。 同时使用两个bus来模拟配置文件刷新。
创建config-server工程
Config-server功能
- 用于外部配置的http,基于资源的api
- 加密和解密属性
- 使用可嵌入spring boot的应用程序
1.1 创建配置中心server:config-server
1.2 添加config-server的pom.xml相关依赖
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency>
1.3 添加config-server的application添加配置信息
#加载本地文件配置 spring: application: name: config-server profiles: active: native #加载本地配置 cloud: config: server: native: #加载本地目录文件 search-locations: /Users/xxxx/config-server server: port: 13081 eureka: instance: hostname: eureka1.client.com lease-renewal-interval-in-seconds: 5 lease-expiration-duration-in-seconds: 10 client: service-url: defaultZone: http://eureka1.server.com:8701/eureka/,http://eureka2.server.com:8702/eureka/,http://eureka3.server.com:8703/eureka/
1.4 启动类ConfigServerApplication增加注解
package spring.cloud.demo.configserver; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.config.server.EnableConfigServer; @EnableConfigServer @SpringBootApplication public class ConfigServerApplication { public static void main(String[] args) { SpringApplication.run(ConfigServerApplication.class, args); } }
至此,一个单机本地config-server就搭建完成
1.5 创建配置中心client:config-client
1.6 添加config-client的pom相关依赖
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency>
1.7添加config-client的bootstrap.yml相关配置(注意这里不是application.yml)
bootstrap.yml
spring: application: name: config-client cloud: config: label: master profile: dev fail-fast: true uri: http://localhost:13081 #通过域名访问配置中心服务端 discovery: enabled: true eureka: instance: hostname: eureka1.client.com lease-renewal-interval-in-seconds: 5 lease-expiration-duration-in-seconds: 10 client: service-url: defaultZone: http://eureka1.server.com:8701/eureka/,http://eureka2.server.com:8702/eureka/,http://eureka3.server.com:8703/eureka/
1.8新建从服务端请求的配置文件config-client-dev.yml
客户端从服务端获取资源配置的路径规则:
- /{application}/{profile}[/{label}]
- /{application}-{profile}.yml
- /{label}/{application}-{profile}.yml
- /{application}-{profile}.properties
- /{label}/{application}-{profile}.properties
本文采用第二种规则。
配置内容:
spring: application: name: config-client server: port: 52601 eureka: instance: hostname: eureka1.client.com lease-renewal-interval-in-seconds: 5 lease-expiration-duration-in-seconds: 10 client: service-url: defaultZone: http://eureka1.server.com:8701/eureka/,http://eureka2.server.com:8702/eureka/,http://eureka3.server.com:8703/eureka/ info: local-config-client-dev
将新建的config-client-dev.yml放到config-server配置的/Users/xxxx/config-server目录下,如果config-server没有配置目录,默认使用resources目录下。
1.9 ConfigClientApplication增加注解
package spring.cloud.demo.configclient; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; @EnableDiscoveryClient @SpringBootApplication public class ConfigClientApplication { public static void main(String[] args) { SpringApplication.run(ConfigClientApplication.class, args); } }
2.0 创建测试类
在config-client创建测试Controller:ConfigClientController
package spring.cloud.demo.configclient.controller; import org.springframework.beans.factory.annotation.Value; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; /** * 测试是否能获取到配置信息的controller * @auther: maomao * @DateT: 2019-09-17 */ @RestController public class ConfigClientController { @Value("${info}") private String info; @RequestMapping("/config/info") public String info() { return info; } }
2.1 启动相关服务
分别启动eureka-server、config-server、config-client。访问:http://localhost:52601/config/info,显示如下
![image-20190923104137281](/Users/fengfujie/Library/Application Support/typora-user-images/image-20190923104137281.png)
证明本地配置文件已经生效。
2.2 从远程git加载资源配置文件
修改config-server的application.yml配置文件:
##加载本地文件配置 #spring: # application: # name: config-server # profiles: # active: native #加载本地配置 # cloud: # config: # server: # native: #加载本地目录文件 # search-locations: /Users/fengfujie/config-server #加载远程git仓库资源文件 spring: application: name: config-server cloud: config: server: git: # 配置git仓库的地址 uri: https://github.com/fengfujie25/sping-cloud-config # git仓库的账号 username: xxxxxx # git仓库的密码 password: xxxxxx server: port: 13081 eureka: instance: hostname: eureka1.client.com lease-renewal-interval-in-seconds: 5 lease-expiration-duration-in-seconds: 10 client: service-url: defaultZone: http://eureka1.server.com:8701/eureka/,http://eureka2.server.com:8702/eureka/,http://eureka3.server.com:8703/eureka/
重新启动config-server服务。然后刷新http://localhost:52601/config/info地址,显示如下
![image-20190923105019135](/Users/fengfujie/Library/Application Support/typora-user-images/image-20190923105019135.png)
证明已经成功获取了远程git资源的配置信息。
2.3 通过服务名称访问config-server
以上配置都是通过域名访问的config-server,为了保证系统的高可用,因为生产环境的配置服务中心都是集群配置,所有客户端才通过服务名称来访问。
修改config-client的bootstrap.yml
spring: application: name: config-client cloud: config: label: master profile: dev fail-fast: true #uri: http://localhost:13081 #通过域名访问配置中心服务端 discovery: enabled: true service-id: config-server #通过服务访问配置中心服务端 eureka: instance: hostname: eureka1.client.com lease-renewal-interval-in-seconds: 5 lease-expiration-duration-in-seconds: 10 client: service-url: defaultZone: http://eureka1.server.com:8701/eureka/,http://eureka2.server.com:8702/eureka/,http://eureka3.server.com:8703/eureka/
spring.cloud.config.discovery.service-id:通过服务名称访问配置中心服务端
重新启动config-client.并访问http://localhost:5301/config/info,显示结果同【2.2】则代表配置信息已生效,证明是通过服务名称访问的config-server.
至此,spring cloud集成config的配置就全部完成。但是存在一个问题,如果修改远程git仓库的资源配置,项目并不会刷新,所以配置信息是不生效的。
2.4 动态刷新config-server配置
动态刷新config-serve配置方式
- 基于RabbitMQ动态刷新
- 原生刷新(伪动态刷新)
本文采用比较简单的原生刷新方式。
2.4.1增加相关pom.xml依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
2.4.2 在ConfigClientController增加@RefreshScope注解
package spring.cloud.demo.configclient.controller; import org.springframework.beans.factory.annotation.Value; import org.springframework.cloud.context.config.annotation.RefreshScope; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; /** * @auther: maomao * @DateT: 2019-09-17 */ @RestController @RefreshScope public class ConfigClientController { @Value("${info:error}") private String info; @RequestMapping("/config/info") public String info() { return info; } }
此方式同时还要修改@Value注解内容为@Value("${info:error}"),因为刷新的时候需要配置信息有默认值,否则会报错。
2.4.3 重新启动config-client
访问http://localhost:5301/config/info,看服务是否可以正常访问。
然后可以修改git资源仓库中的配置信息。
-
通过post访问:http://localhost:5301/actuator/refresh,显示如下:
![image-20190923115000716](/Users/fengfujie/Library/Application Support/typora-user-images/image-20190923115000716.png)
-
刷新http://localhost:5301/config/info,结果显示:
![image-20190923115101228](/Users/fengfujie/Library/Application Support/typora-user-images/image-20190923115101228.png)
证明refresh已经生效。
此方式每次都需要手动刷新一下才行,比较麻烦。GitHub提供一种Webhooks方法可以实现不用每次手动刷新。
![image-20190923122041185](/Users/fengfujie/Library/Application Support/typora-user-images/image-20190923122041185.png)
Payload URL: 触发后回调的URL
Content type: 数据格式,两种一般使用json
Secret: 用作给POST的Body加密的字符串,采用HMAC算法
Events: 触发的事件列表
事件类型 | 描述 |
---|---|
Just the push event |
仓库有push的时候触发,默认事件 |
Send me everything | 派我来一切 |
Let me select individual events | 选择个别事件 |
这样我们就可以利用Webhook的机制去触发客户端的更新,但是当客户端越来越多的时候,Webhook机制也不够优雅,每次增加客户端都需要改动Webhook也不现实。
其实,Spring cloud给了我们更好的解决方案-spring cloud bus。
spring cloud bus后续更新。
总结
本文简单的实现了config-server和config-client的单机和远程git仓库的配置的调用以及配置信息的简单的动态更新。
代码地址
<center><font color=red>《Srping Cloud 2.X小白教程》目录</font></center>
- spring cloud 2.x版本 Eureka Server服务注册中心教程
- spring cloud 2.x版本 Eureka Client服务提供者教程
- spring cloud 2.x版本 Ribbon服务发现教程(内含集成Hystrix熔断机制)
- spring cloud 2.x版本 Feign服务发现教程(内含集成Hystrix熔断机制)
- spring cloud 2.x版本 Zuul路由网关教程
- spring cloud 2.x版本 config分布式配置中心教程
- spring cloud 2.x版本 Hystrix Dashboard断路器教程 ###转载请注明出处,联系方式:4272231@163.com
- SpringCloud教程 | 第六篇: 分布式配置中心(Spring Cloud Config)(Finchley版本)
- SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)(Finchley版本)
- 企业级 SpringCloud 教程 (七)高可用的分布式配置中心(Spring Cloud Config)
- SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)
- SpringCloud教程六:分布式配置中心(SpringCloud Config)
- 史上最简单的SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)...
- 史上最简单的SpringCloud教程 | 第六篇: 分布式配置中心(Spring Cloud Config)
- SpringCloud 教程 | 第六篇:分布式配置中心(Spring Cloud Config)
- 企业级 SpringCloud 教程 (六)分布式配置中心(Spring Cloud Config)
- 史上最简单的SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)
- 史上最简单的SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)
- spring cloud 系列第8篇 —— config+bus 分布式配置中心与配置热刷新 (F版本)
- 史上最简单的SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)
- 史上最简单的SpringCloud教程 | 第六篇: 分布式配置中心(Spring Cloud Config)
- 史上最简单的SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)
- Spring boot2.0.x+SpringCloud(Finchley版本)分布式架构--分布式配置中心(Spring Cloud Config)(五)
- 史上最简单的SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)
- 第七篇: 高可用的分布式配置中心(Spring Cloud Config)(Finchley版本)
- SpringCloud微服务云架构构建B2B2C电子商务平台之-(七)高可用的分布式配置中心(Spring Cloud Config)视频教程
- 史上最简单的SpringCloud教程 | 第七篇: 高可用的分布式配置中心(Spring Cloud Config)