在Spring Boot中从命令行设置活动配置文件和配置位置

技术背景

在Spring Boot应用开发中，通常会有多个环境，如开发（development）、测试（staging）和生产（production）。为了适应不同环境的配置需求，我们会为每个环境创建特定的配置文件，如application-development.yml、application-staging.yml和application-production.yml。同时，我们需要一种方式来动态指定应用在运行时使用哪个配置文件，这就涉及到设置活动配置文件和配置文件的位置。

实现步骤

1. 准备配置文件

在项目的src/main/resources目录下创建application.yml文件，并设置默认的活动配置文件，示例如下：

spring:
  profiles.active: development

另外，在指定的目录（如C:\config）下创建特定环境的配置文件，如application-development.yml、application-staging.yml和application-production.yml。

2. 从命令行设置活动配置文件和配置位置

方式一：Java系统属性（VM参数）

确保-D参数在application.jar之前，否则不会被识别。示例命令如下：

java -jar -Dspring.profiles.active=prod application.jar

如果配置位置需要指定，可添加-Dspring.config.location参数，例如：

java -jar -Dspring.profiles.active=prod -Dspring.config.location=C:\Config application.jar

方式二：程序参数

使用--开头的参数来设置活动配置文件和配置位置，示例命令如下：

java -jar application.jar --spring.profiles.active=prod --spring.config.location=c:\config

3. 使用Maven运行时设置

Spring Boot 2.x（仅适用于Maven）

mvn spring-boot:run -Dspring-boot.run.profiles=local

Spring Boot 1.x 和 2.x

mvn spring-boot:run -Dspring.profiles.active=local

如果需要设置多个配置文件，使用逗号分隔，例如：

mvn spring-boot:run -Dspring.profiles.active=local,foo,bar

4. 设置操作系统环境变量

可以通过设置SPRING_PROFILES_ACTIVE环境变量来指定活动配置文件，示例命令如下：

SPRING_PROFILES_ACTIVE=dev gradle clean bootRun

5. 在Gradle中配置

在build.gradle文件中添加以下配置，使bootRun任务能够获取配置文件和配置位置：

bootRun {
    String activeProfile =  System.properties['spring.profiles.active']
    String confLoc = System.properties['spring.config.location']
    systemProperty "spring.profiles.active", activeProfile
    systemProperty "spring.config.location", "file:$confLoc"
}

更简单的配置方式：

bootRun {
    systemProperties = System.properties
}

核心代码

Java系统属性方式

java -jar -Dspring.profiles.active=prod -Dspring.config.location=C:\Config application.jar

程序参数方式

java -jar application.jar --spring.profiles.active=prod --spring.config.location=c:\config

Maven运行方式

mvn spring-boot:run -Dspring.profiles.active=local

Gradle配置方式

bootRun {
    systemProperties = System.properties
}

最佳实践

• 使用环境变量：将敏感信息（如数据库用户和密码）存储在环境变量中，避免将其硬编码在配置文件中，这样可以提高安全性，并且避免在版本控制中泄露敏感信息。
• 明确参数顺序：在使用Java系统属性（-D参数）时，确保参数在application.jar之前，以确保参数被正确识别。
• 使用逗号分隔多个配置文件：如果需要同时激活多个配置文件，可以使用逗号分隔配置文件名称，如mvn spring-boot:run -Dspring.profiles.active=local,foo,bar。

常见问题

1. 参数未生效

可能是因为参数顺序不正确，或者IDE没有正确传递参数。确保-D参数在application.jar之前，并且在IDE中正确配置了运行参数。

2. 配置文件未找到

确保配置文件的路径正确，并且路径以/结尾（如果是目录）。例如，在Windows系统中，路径可以写成C:\Config\；在Unix系统中，路径可以写成/home/xyz/projectName/cfg/。

3. 不同Spring Boot版本的差异

Spring Boot 2.x和1.x在使用Maven运行时设置活动配置文件的方式略有不同。Spring Boot 2.x可以使用-Dspring-boot.run.profiles，而Spring Boot 1.x使用-Dspring.profiles.active。在实际使用时，需要根据自己的Spring Boot版本选择合适的方式。