这个不讲spring cloud config的基本用法,如果不了解的可以先看下官网spring cloud中文(中文其实就是Google翻译过来的,最好看英文的)。这边提供我自己使用spring cloud config的一些思路,希望可以帮到大家。
对于spring cloud config,主要理解他的环境库(Environment Repository)的三个变量参数就可以大概可以使用了,
1.{application}maps to "spring.application.name" on the client side;
2.{profile}maps to "spring.profiles.active" on the client (comma separated list);
3.{label}which is a server side feature labelling a "versioned" set of config files.
在这边我添加我的理解:{application}和{profile}主要是为了对应配置仓库中的参数文件,如{application}-{profile}.yml类型的文件,{label}对应这config-repo的git版本,通过{label}可以让项目中指定不同的config-repo的git版本,这样使得配置文件的管理也方便了很多。
1.sever端
引进spring-cloud-config-server的jar包,在启动类上面加入@EnableConfigServer注解,然后再application.yml中加入config-repo的地址就可以了,spring cloud config的server端就这样配置好了,很简单(或者使用spring的自动生成项目网站SPRING INITIALIZR生成项目)。
注意:如果application.yml中配置的config-repo要是git项目才可以使用,不然会报错误,如果不想把config-repo放在git中,可以使用spring.profiles.active=native指定不使用git,spring.cloud.config.server.native.searchLocations指定本地路径或文件系统的路径。
2.client端
引进spring-cloud-starter-config的jar包,在bootstrap.yml文件中指定server端的uri就可以使用了。
3.config-repo配置文件仓库
这部分主要是思考这几个问题(config-repo存储在git中的前提下):
1.文件怎么命名;application.properties和application.yml的配置文件会发送给所有的客户端,application-dev.yml类型的文件会在profile是dev时候被加载,{application}.yml类型的文件会被相应的spring.application.name模块加载,.text和.json文件可以用于加载参数或者加载数据减轻数据库的压力;
2.文件归类;不同项目、不同模块、不同作用、不同版本的配置文件要能区分出来,毕竟公司所有的配置文件不是一个小数量,所以为了以后好维护最好可以明确区分出来;
3.文件优化;因为config-repo的application.yml类型的文件是自动被所有的客户加载的,所以所有的客户端相同的配置参数最好放在一个文件中,而application-dev.yml可以被所有的profile值为dev的客户端加载;也就是说尽量把配置参数提炼出来,方便以后快速开发新的模块;
带着上面的三个问题,我们来尝试过的解决下,下面我列出每种方法:
1.使用{application}-{profile}.yml命名,每个模块对应一个配置文件,相同模块不同profile的也分开配置文件出来。这种分类方式是最简单的,但是没有把相同的配置参数放在一起,增加了查找指定配置参数的复杂度,修改文件时也可能要两边都要修改等缺点,总体感觉就是用这种方式来存储配置文件还不如不要使用spring cloud config来的方便。
2.在server端的serverconfig.xml(也就是配置文件中)的spring.cloud.config.server.git.uri中增加{application}占位符,这种可以很好的区分出各个模块出来,但是在微服务中模块的数量也是非常多的,最好可以增加一层项目分类。
3.pattern匹配和多个存储库,还可以通过应用程序和配置文件名称的模式匹配来支持更复杂的需求。pattern格式是带有通配符的{application}/{profile}名称(pattern可以使用通配符开头),下图中的simple、special和local的repos对应模块的spring.application.name的值(也就是对应配置文件名);
在repo中的pattern属性是一个数组,因此您可以使用属性文件中的YAML数组(或[0],[1]等后缀)绑定到多个模式。如果要运行具有多个配置文件的应用程序,则可能需要执行此操作(其中*/staging表示["*/staging", "*/staging,*"])。
serverconfig.xml中增加searchPaths参数还可以在存储库中增加个子文件夹,可用于分类配置文件。下图的意思是搜索config-repo和子文件夹foo目录中的文件还有以bar开头的任何子文件夹中的文件。
上面内容是从官网摘抄下来的,可惜没有在源码例子中使用,所以刚开始接触的时候比较难理解。使用多个config-repo存储来分类不同类型配置文件,使得查找配置文件方便很多,而在config-repo增加子文件夹可以更细的分开不同类型的配置文件,将需要经常增删改查配置参数或者多次重复的配置参数可以放在一个特定的config-repo中等等,总体来说是一个很不错的分类配置文件的方法。但是我个人的不是那么喜欢这个方法,主要原因是该方法需要多个git仓库,也就是说你需要弄一个专门存放配置文件的账号,然后根据不同的需要建立各个git Repositories,这样查看配置文件的时候总会有点不是那么方便,还有对于没有接触过spring cloud config的人来说很难理解pattern参数,因此我自己在下面提出了另外一个适合我使用的分类方式。
4.将所有项目都可能会使用的配置文件放在config-repo下面,并以类似application-log4j2.yml的方式命名,增加log4j2只是为了方便查找;用子文件夹b2bMall来区分不同的项目,用模块名命名配置文件;为了不重复书写配置参数,如dev和prd的profile,将从各个模块中提取相同的参数出来并存储在application-dev.yml和application-prd.yml文件中,如果增加了project,为了让客户端获取指定的配置文件可将dev或prd改为b2bMallDev或b2bMallPrd以项目名做前缀的profile。对于dev和prd的相同的参数,可存放在application.yml文件中。在项目中每个模块相同的参数一般都是写数据库连接redis连接这类的,都是不需要经常改的,所以最后我们只需要把每个模块中经常需要修改的参数提取出来,放在对应模块的resource文件夹中就好了。
下面是各个模块的代码, 就不多说了
下图都是模块中的配置文件
模块中的application.yml主要存放经常需要修改的参数