一、概述
软件研发一般需经过开发-测试-发布三个主要过程,由于不同环境数据、功能等差异性,会导致每个研发环境中的配置文件可能会有所不同,若此时只有一份配置文件,则在环境切换时需要手动去修改配置信息,这样一来不仅麻烦而且很容易出错。
为解决多环境下配置问题,Spring提供了Spring Boot Profile这个功能,只需要在启动项目时指定当前环境所需得配置文件即可。在Maven中也有相似的功能(Maven Profile),也可指定启动时读取指定配置文件。
在使用Spring Boot Profile时,只需要在启动命令中添加一个参数(--spring.profiles.active=
)即可指定当前环境激活的配置文件。
java -jar 1.0.0-SNAPSHOT.jar --spring.profiles.active=prod
二、Nacos Config Profile
spring-cloud-starter-alibaba-nacos-config
在加载配置的时候,不仅仅加载了以 Data ID为 ${spring.application.name}.${file-extension:properties}
为前缀的基础配置,还加载了Data ID为 ${spring.application.name}-${profile}.${file-extension:properties}
的基础配置。
在日常开发中如果遇到多套环境下的不同配置,可以通过 Spring 提供的 ${spring.profiles.active}
这个配置项来配置激活相应的配置。
三、案例演示
本文案例代码是基于上一篇文章《二、Spring Cloud Alibaba-Nacos-服务注册与发现》进行增加的。
本文选择服务提供者(nacos-provider)
模块基于Nacos Config进行多环境配置案例演示。
3.1、Maven依赖(POM)
<!-- Nacos-Config Start -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<!-- Nacos-Config Start -->
3.2、使用Nacos UI发布配置
注意: 控制台发布配置时不要加注释,否则打成 Jar 包后运行会报无法解析配置文件的错误。
通过浏览器访问Nacos Server:http://192.168.145.129:8848/nacos;点击配置列表即可新增并发布配置。
- 发布一个名为
service-provider-config-dev.yaml
的 开发环境 配置。
server:
port: 8070
spring:
application:
name: service-provider
cloud:
nacos:
discovery:
server-addr: 192.168.145.129:8848
- 发布一个名为
service-provider-config-prod.yaml
的 生产环境 配置。
3.3、修改项目内部配置(bootstrap.properties)
- 删除工程原有的
application.yml
配置文件,并新建一个名为bootstrap-dev.properties
的配置文件,并在此文件中配置加载Nacos Config发布的开发环境配置信息:
spring.application.name=service-provider-config
spring.cloud.nacos.config.server-addr=192.168.145.129:8848
spring.cloud.nacos.config.file-extension=yaml
spring.profiles.active=dev
- 新建一个名为
bootstrap-prod.properties
的配置文件,并在此文件中配置加载Nacos Config发布的生产环境配置信息:
spring.application.name=service-provider-config
spring.cloud.nacos.config.server-addr=192.168.145.129:8848
spring.cloud.nacos.config.file-extension=yaml
spring.profiles.active=prod
3.4、多环境配置测试
- 指定开发环境配置启动项目:
启动项目后,查看控制台日志输出中启动端口号:
- 指定生产环境配置启动项目:
与激活开发环境一样,需要Run中指定启动配置项prod
,再启动项目。
比较控制台可以看出,当我们激活不同环境时,系统的确会自动加载指定的配置信息。
四、总结
本文详细介绍了Spring Boot Profile多环境下指定配置启动功能,并结合Nacos Config分布式配置中心进行了案例演示,充分讲解了实际项目中的使用步骤及详情。