通过之前文章我们已经了解并掌握了如何使用Nacos的配置管理功能完成配置文件的动态配置,以及学习了有关Nacos配置加载规则。接下来我们使用Nacos配置多环境管理。
简介
在Nacos中,本身有多个不同的管理级别概念,包括:Data ID
、Group
、Namespace
。只要利用好这些层级概念的关系,就可以根据自己的需求来实现多环境的管理。
下面,就介绍一下多环境的几种实现方式:
方式一:使用 Data ID 与 profiles 实现
Data ID
在Nacos中,可以理解为就是一个 Spring Cloud 应用的配置文件名称。默认情况下 Data ID
的名称格式是:${spring.application.name}.properties
,即以Spring Cloud应用命名的properties文件。
实际上,Data ID
的规则中,还包含了环境逻辑,这一点与 Spring Cloud Config的设计类似。我们在启动应用时,可以通过 spring.profiles.active
来指定具体的环境变量名,此时客户端就会把Data ID
的规则变为:${spring.application.name}-${spring.profiles.active}.properties
既然我们知道上面的规则,接下来我们就可以动手试一试
第一步:先在Nacos中根据这个规则,创建两个不同环境的配置文件内容,并设置不同环境值:
第二步: 在alibaba-nacos-config-client
应用配置文件 bootstrap.properties中,增加环境配置:spring.profiles.active=DEV
第三步:启动应用,查看日志:
2019-07-10 17:05:05.947 INFO 17480 --- [-127.0.0.1_8848] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='alibaba-nacos-config-client-DEV.properties'}, NacosPropertySource {name='alibaba-nacos-config-client.properties'}]}
2019-07-10 17:05:05.948 INFO 17480 --- [-127.0.0.1_8848] o.s.boot.SpringApplication : The following profiles are active: DEV
方式二:使用 Group 实现
Group在Nacos中用来对 Data ID做集合管理的重要概念。所以,如果我们把一个环境变量配置视为一个集合,那么也就可实现不同环境的配置管理。对于 Group 的用法并没有固定的规定,所以我们在实际使用的时候,需要根据我们的具体需求,可以是架构运维上的多环境管理,也可以是业务上的不同模块的参数管理。为了避免冲突,我们需要在架构设计之初,做好一定的规划。这里,我先说说如何使用Group来实现多环境配置管理的具体实现方式。
第一步:先在Nacos中,通过区分 Group 来创建两个不同环境的配置分组内容:
如上图,我们为
alibaba-nacos-config-client
应用,定义了DEV环境
和TEST环境
的两个独立配置,这两个匹配与上一个方式不同,他们的 Data ID
是完全相同的,只是 Group
不同。
第二步:在alibaba-nacos-config-client
应用配置文件bootstrap.properties
中,增加Group
配置:spring.cloud.nacos.config.group=DEV_GROUP
第三步: 启动应用,我们可以看到日志
2019-07-10 17:23:16.739 INFO 16512 --- [-127.0.0.1_8848] o.s.c.a.n.c.NacosPropertySourceBuilder : Loading nacos data, dataId: 'alibaba-nacos-config-client.properties', group: 'DEV_GROUP'
2019-07-10 17:23:16.739 INFO 16512 --- [-127.0.0.1_8848] b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource {name='NACOS', propertySources=[NacosPropertySource {name='alibaba-nacos-config-client.properties'}]}
方式三:使用 Namespace 实现
Namespace 应该还是第一次出现。先看看官方的概念说明:用于进行租户粒度的配置隔离。不同的命名空间下,可以存在相同的 Group
或 Data ID
的配置。 Namespace 的常用场景之一是不同环境的配置的区分隔离,例如:开发环境、测试环境、生产环境的资源(如配置、服务)隔离等。
在官方的介绍中,就介绍了利用其可以作为环境的隔离使用,下面我们就来试一试。
第一步: 先在Nacos中,在 服务管理 - 命名空间 根据环境名称来创建多个 Namespace :
第二步:在配置文件最上方,可以看到除了 pulbic
之外,多了几个刚才创建的 Namespace。 分别在 DEV 和 TEST 空间下为 alibaba-nacos-config-client
应用创建对应的配置文件内容:
第三步:在alibaba-nacos-config-client
应用的配置文件bootstrap.properties
中,增加Namespace的指定配置,比如:spring.cloud.nacos.config.namespace=aabb84b1-fe32-4318-bb9c-a0f763cb5a61
注意:这里需要注意
namespace
的配置不是使用名称
,而是Namespace的ID
。
第四步: 启动应用,通过访问localhost:9004/test接口,验证一下返回内容是否正确。
这种方式下,目前版本的日志并不会输出与Namespace相关的信息,所以还无法以此作为加载内容的判断依据。
注:Namespace方式还可以和上面两种方式结合使用,完成更复杂的配置文件管理。
思考
上面我们分别利用Nacos配置管理功能中的几个不同纬度来实现多环境的配置管理。从结果上而言,不论用哪一种方式,都能够胜任需求,但是哪一种最好呢?
-
第一种:通过Data ID与profile实现。
优点:这种方式与Spring Cloud Config的实现非常像,用过Spring Cloud Config的用户,可以毫无违和感的过渡过来,由于命名规则类似,所以要从Spring Cloud Config中做迁移也非常简单。
缺点:这种方式在项目与环境多的时候,配置内容就会显得非常混乱。配置列表中会看到各种不同应用,不同环境的配置交织在一起,非常不利于管理。
建议:项目不多时使用,或者可以结合Group对项目根据业务或者组织架构做一些拆分规划。 -
第二种:通过Group实现。
优点:通过Group按环境讲各个应用的配置隔离开。可以非常方便的利用Data ID和Group的搜索功能,分别从应用纬度和环境纬度来查看配置。
缺点:由于会占用Group纬度,所以需要对Group的使用做好规划,毕竟与业务上的一些配置分组起冲突等问题。
建议:这种方式虽然结构上比上一种更好一些,但是依然可能会有一些混乱,主要是在Group的管理上要做好规划和控制。 -
第三种:通过Namespace实现(推荐)。
优点:官方建议的方式,通过Namespace来区分不同的环境,释放了Group的自由度,这样可以让Group的使用专注于做业务层面的分组管理。同时,Nacos控制页面上对于Namespace也做了分组展示,不需要搜索,就可以隔离开不同的环境配置,非常易用。
缺点:没有啥缺点,可能就是多引入一个概念,需要用户去理解吧。
建议:直接用这种方式长远上来说会比较省心。虽然可能对小团队而言,项目不多,第一第二方式也够了,但是万一后面做大了
注意:
不论用哪一种方式实现。对于指定环境的配置
- spring.profiles.active=DEV
- spring.cloud.nacos.config.group=DEV_GROUP
- spring.cloud.nacos.config.namespace=83eed625-d166-4619-b923-93df2088883a
都不要配置在应用的bootstrap.properties
中。而是在发布脚本的启动命令中,用-Dspring.profiles.active=DEV
的方式来动态指定,会更加灵活!