SpringCloud实战7-Config分布式配置管理
分布式环境下的统一配置框架,已经有不少了,比如百度的disconf,阿里的diamand
官方文档对spring Cloud Config的描述如下:
Spring Cloud Config为分布式系统中的外部配置提供服务器和客户端支持,使用Config Server,您可以在所有环境中管理应用程序的外部属性。客户端和服务器上的概念映射与Spring Environment和PropertySource抽象相同,
因此它们与Spring应用程序非常契合,但可以与任何以任何语言运行的应用程序一起使用。随着应用程序通过从开发人员到测试和生产的部署流程,您可以管理这些环境之间的配置,并确定应用程序具有迁移时需要运行的一切。
服务器存储后端的默认实现使用git,因此它轻松支持标签版本的配置环境,以及可以访问用于管理内容的各种工具。很容易添加替代实现,并使用Spring配置将其插入。
1.为什么要配置中心?
一个应用中不只是代码,还需要连接资源和其它应用,经常有很多需要外部设置的项去调整应用行为,如切换不同的数据库,设置功能开关等。
随着系统微服务的不断增加,首要考虑的是系统的可伸缩、可扩展性好,随之就是一个配置管理的问题。各自管各自的开发时没什么问题,到了线上之后管理就会很头疼,到了要大规模更新就更烦了。
而且你不可能停止你的服务集群去更新的你配置,这是不现实的做法,因此springcloud配置中心就是一个比较好的解决方案,下图就是一个springcloud配置中心的解决方案:
常见的配置中心的实现方法有:
1.硬编码(缺点:需要修改代码,风险大)
2.放在xml等配置文件中,和应用一起打包(缺点:需要重新打包和重启)
3.文件系统中(缺点:依赖操作系统等)
4.环境变量(缺点:有大量的配置需要人工设置到环境变量中,不便于管理,且依赖平台) 5.云端存储(缺点:与其他应用耦合)
Spring Cloud Config就是云端存储配置信息的,它具有中心化,版本控制,支持动态更新,平台独立,语言独立等特性。其特点是:
1.提供服务端和客户端支持(spring cloud config server和spring cloud config client) 2.集中式管理分布式环境下的应用配置 3.基于Spring环境,无缝与Spring应用集成 4.可用于任何语言开发的程序 5.默认实现基于git仓库,可以进行版本管理 6.可替换自定义实现
spring cloud config包括两部分:
1.spring cloud config server 作为配置中心的服务端:
1.拉取配置时更新git仓库副本,保证是最新结果
2.支持数据结构丰富,yml, json, properties 等
3.配合 eureke 可实现服务发现,配合 cloud bus 可实现配置推送更新
4.配置存储基于 git 仓库,可进行版本管理
5.简单可靠,有丰富的配套方案
2.Spring Cloud Config Client 客户端:
1.Spring Boot项目不需要改动任何代码,加入一个启动配置文件指明使用ConfigServer上哪个配置文件即可
SpringCloud Config与百度的disconf之类的有很大不同,主要区别在于下面三点:
1.配置的存储方式不同:disconf是把配置信息保存在mysql、zookeeper中,而spring cloud config是将配置保存在git/svn上 (即:配置当成源代码一样管理)
2.配置的管理方式不同:spring cloud config没有类似disconf的统一管理界面,既然把配置都当成git之类的源码来看待了,git的管理界面,就是配置的管理界面
3.配置变化的通知机制不同:disconf中配置变化后,依赖zk的事件watcher来通知应用,而spring cloud config则是依赖git每次push后,触发webhook回调,最终触发spring cloud bus(消息总线),然后由消息总线通知相关的应用。
从配置变化的通知机制上看,如果有100个应用节点,都依赖于统一配置,如果修改了配置,只想让某几个节点"灰度"更新配置,spring cloud config server更容易做到,这一点相对disconf更灵活
首先SpringCloud Config 是分为Server端和Client端的,Server端负责管理配置,Client端用来加载配置。我们每一个为服务都要集成一个Client端的。上面也提到过。因此,我们现在看一下Config的Server端的Demo实现。
首先在原来的项目中新建一个springcloud-config-server模块,并且引入相关依赖,如下:
org.springframework.cloud spring-cloud-config-server 1.4.0.RELEASE org.springframework.cloud spring-cloud-starter-eureka 1.3.5.RELEASE
我们可以看到引入了Eureka,为什么呢?很明显是为了高可用。
接着在启动类上面加入@EnableConfigServer注解,表示这里是配置中心服务。还有Eureka的客户端的注解代码如下:
@SpringBootApplication@EnableConfigServer@EnableDiscoveryClientpublic class ConfigApplication { public static void main(String[] args) { SpringApplication.run(ConfigApplication.class, args); } }
application.yml配置如下:
server: port: 7000#服务名字spring: application: name: config-server cloud: config: server: git:#git 仓库的地址 uri: https://gitee.com/xxxx/springcloud-config.git #git 仓库的账号密码 username: xxx password: xxx #加入注册中心,实现高可用 eureka: client: service-url: defaultZone: http://localhost:8888/eureka/,http://localhost:8889/eureka/
注意了,前提是你必须要在git仓库中先建立一个仓库,然后配置两个配置,一个开发dev,一个测试test 如下图:
dev的内容如下:
test的内容如下:
好了,让我们把springcloud-config模块启动起来,启动启动类,运行,访问git仓库中的cloud-config-dev.properties,如下:
接下来,我们进行springcloud Config的Client端的Demo,如下:
首先引入Client端的相关依赖,如下:
org.springframework.boot spring-boot-starter-actuator org.springframework.boot spring-boot-starter-web org.springframework.cloud spring-cloud-starter-config 1.4.0.RELEASE org.springframework.cloud spring-cloud-starter-eureka 1.3.5.RELEASE
这里提一下,为什么需要引入前面的actuctor依赖,因为,我们Client端需要在不重启的情况下,及时更新拉取加载配置中心的改变,然后修改内存中的配置的值。
接着在Client启动类的打上@EnableDiscoveryClient的注解,来注册到注册中心去,如下:
@SpringBootApplication@EnableDiscoveryClientpublic class ConfigClientApplication { public static void main(String[] args) { SpringApplication.run(ConfigClientApplication.class, args); } }
接下来这步骤很关键,就是要将Client模块下的application.yml文件改为bootstrap.yml,这是很关键的,因为bootstrap.yml是比application.yml先加载的。bootstrap.yml优先级高于application.yml。就好比如,你应用程序都跑起来了,你配置还没加载,这不是扯淡吗?
如下:
server: port: 7005spring: application: name: cloud-config cloud: config:#启动什么环境下的配置,dev 表示开发环境,这跟你仓库的文件的后缀有关,比如,仓库配置文件命名格式是cloud-config-dev.properties,所以profile 就要写dev profile: dev #面向服务,允许被发现 discovery: enabled: true #这个名字是Config Server端的服务名字,不能瞎写。 service-id: config-server #注册中心 eureka: client: service-url: defaultZone: http://localhost:8888/eureka/,http://localhost:8889/eureka/ #是否需要权限拉去,默认是true,如果不false就不允许你去拉取配置中心Server更新的内容 management: security: enabled: false
接着写一段测试代码,如下,建立一个测试Controller,代码如下:
@RestController//这里面的属性有可能会更新的,git中的配置中心变化的话就要刷新,没有这个注解内,配置就不能及时更新@RefreshScopepublic class TestController { @Value("${name}") private String name; @Value("${age}") private Integer age; @RequestMapping("/test") public String test(){ return this.name+this.age; } }
接着启动启动该工程,运行结果如下:
首先我们我们先看没更新配置之前的值,如下:
接着我们去git仓库中修改age的值为24,再用postman来发送post请求localhost:7005/refresh,如下:
可以看到postman返回config.client.version信息,表示告知Client,远程的仓库中的配置中心已经更新了的配置版本信息,改变的值为age。
接着我们继续刷新浏览器,localhost:7005/test,看一下年龄是否更新了,如下:
可以看到年龄跟新到24了。