Spring Boot：使用外部配置文件

在 Spring Boot 项目中，默认配置文件通常位于 src/main/resources 路径下，随着环境的不同（如开发、测试、生产），会使用不同的配置文件（如 application-dev.yml、application-prod.yml 等）。为了更灵活地管理这些配置，避免敏感配置被打包、上传或暴露的风险，特别是在生产部署时，通常会使用外部配置文件。

1. 默认配置文件位置

默认情况下，Spring Boot 会识别 src/main/resources/ 目录下的配置文件，并根据环境变量 SPRING_PROFILES_ACTIVE 自动加载对应的 application-*.yml 文件。

app/
├── src/
│   └── main/
│       ├── java/
│       └── resources/
│           ├── application.yml
│           ├── application-dev.yml
│           └── application-prod.yml
└── pom.xml

但在项目打包时，这些配置文件将会被一并打包进最终生成的 JAR 文件。这意味着，在运行时如果需要修改配置，必须重新打包，非常不方便，特别是对生产环境。

2. 使用外部配置文件

为了解决打包后的灵活性问题，我们可以将环境配置文件迁移到 JAR 包外部，并通过参数或配置告知 Spring Boot 从外部位置加载配置文件。

2.1. 修改 application.yml

编辑 app/src/main/resources/application.yml，添加以下内容，让 Spring Boot 知道从指定目录加载额外配置文件：

spring:
  config:
    additional-location: file:./

此配置告诉 Spring Boot 在当前目录（即运行 JAR 包的目录）中查找额外的配置文件。

2.2. 移动配置文件至项目根目录

将除 application.yml 外的所有环境配置文件（如 application-dev.yml、application-prod.yml）移动到项目根目录 app/。

app/
├── src/
│   └── main/
│       ├── java/
│       └── resources/
│           └── application.yml
├── application-dev.yml
├── application-prod.yml
└── pom.xml

这样做的目的是将环境配置文件与 JAR 包解耦，方便部署时按需调整。

2.3. 修改 pom.xml 配置

为了避免环境配置文件被打包进 JAR 中，需要修改 pom.xml，排除它们：

<project>
    <!-- 其他配置 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>${spring-boot.version}</version>
                <configuration>
                    <mainClass>com.company.project.app.YourApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

            <!-- 排除与环境相关的配置文件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.3.1</version>
                <executions>
                    <execution>
                        <id>default-resources</id>
                        <phase>process-resources</phase>
                        <goals>
                            <goal>resources</goal>
                        </goals>
                        <configuration>
                            <resources>
                                <resource>
                                    <directory>src/main/resources</directory>
                                    <excludes>
                                        <exclude>*-dev.yml</exclude>
                                        <exclude>*-stag.yml</exclude>
                                        <exclude>*-prod.yml</exclude>
                                    </excludes>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

2.4. 配置 IntelliJ IDEA 的运行参数

在开发环境中调试时，如果你使用 IntelliJ IDEA，需要做如下设置以确保正确加载外部配置文件：

1. 打开 Run/Debug Configurations；
2. 配置 Active profiles：输入当前使用的 profile，例如 dev；
3. 配置 Working directory：设置为环境配置文件所在的路径；

图 2.1 - Idea Run/Debug 配置页面

2.5. 配置 .gitignore 忽略敏感配置

为了防止将本地或生产的敏感配置上传到 Git 仓库，可以在 .gitignore 中加入以下规则：

*-dev.*
*-stag.*
*-prod.*

这样可以保护不同环境下的配置不会被误提交。

2.6. 部署到服务器

在部署时，只需将 JAR 文件和对应的 application-*.yml 文件拷贝到服务器上同一目录下，然后执行：

java -jar your-app.jar --spring.profiles.active=prod

这样就可以让 Spring Boot 加载当前目录下的 application-prod.yml 文件，而无需重新打包。

---

参考链接

Spring Boot: 核心特性 - 外部应用程序属性