SpringBoot項目多環(huán)境打包與配置文件排除

在實際開發(fā)中，Spring Boot 項目通常需要適配不同的運行環(huán)境，例如開發(fā)環(huán)境、測試環(huán)境、生產環(huán)境等。這些環(huán)境下的配置可能包含敏感信息，例如數(shù)據(jù)庫連接密碼、API密鑰等。因此，在項目打包時，我們不僅需要支持多環(huán)境配置，還要考慮如何排除敏感配置文件，以保證安全性。

1. 多環(huán)境配置的實現(xiàn)方法
2. 打包時排除配置文件的方法
3. 動態(tài)加載外部配置文件的最佳實踐

多環(huán)境配置的實現(xiàn)方法

1. 配置多環(huán)境文件

Spring Boot 默認加載 application.properties 或 application.yml 配置文件。

為了支持多環(huán)境配置，可以通過文件命名的方式區(qū)分環(huán)境，比如：

• application-dev.yml：開發(fā)環(huán)境配置
• application-test.yml：測試環(huán)境配置
• application-prod.yml：生產環(huán)境配置

各環(huán)境配置文件可以定義不同的參數(shù)。例如，以下是開發(fā)和生產環(huán)境的數(shù)據(jù)庫配置：

開發(fā)環(huán)境：application-dev.yml

server:
  port: 8081

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/dev_db
    username: dev_user
    password: dev_password

生產環(huán)境：application-prod.yml

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://prod-server:3306/prod_db
    username: prod_user
    password: prod_password

2. 動態(tài)切換環(huán)境

在 application.yml 中配置默認激活的環(huán)境：

spring:
  profiles:
    active: dev

通過命令行參數(shù)啟動時動態(tài)指定環(huán)境：

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

打包時排除配置文件的方法

在某些情況下，敏感的配置文件（如 application-prod.yml）可能包含生產環(huán)境的重要信息。

我們希望這些文件在打包時被排除，而不是直接包含在最終的 JAR 包中。

1. 使用 Maven 排除配置文件

方法 1：通過 maven-resources-plugin

在 Maven 的 pom.xml 中，通過 maven-resources-plugin 在資源打包階段排除文件：

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <excludes>
                <exclude>application-prod.yml</exclude>
                <!-- 排查所有目錄下的所有配置文件 <exclude>**/*.*</exclude> -->
            </excludes>
        </resource>
    </resources>
</build>

方法 2：通過 maven-assembly-plugin

使用 maven-assembly-plugin 自定義打包配置：

添加插件配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>3.3.0</version>
            <configuration>
                <descriptors>
                    <descriptor>src/main/assembly/assembly.xml</descriptor>
                </descriptors>
            </configuration>
        </plugin>
    </plugins>
</build>

創(chuàng)建 assembly.xml 文件：

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3">
    <id>jar-with-dependencies</id>
    <formats>
        <format>jar</format>
    </formats>
    <fileSets>
        <fileSet>
            <directory>${project.basedir}/src/main/resources</directory>
            <excludes>
                <exclude>application-prod.yml</exclude>
            </excludes>
        </fileSet>
    </fileSets>
</assembly>

執(zhí)行構建命令：

mvn clean package

2. 使用 Gradle 排除配置文件

在 Gradle 的 build.gradle 文件中，可以通過 processResources 任務排除文件：

tasks.processResources {
    exclude 'application-prod.yml'
}

構建時運行：

./gradlew clean build

動態(tài)加載外部配置文件

為了進一步提高安全性，我們可以將敏感配置文件存儲在外部，并通過動態(tài)加載的方式使用這些文件。

1. 存放外部配置文件

將敏感的配置文件（如 application-prod.yml）存放在服務器的安全路徑，例如 /etc/app-config/。

2. 啟動時指定外部配置路徑

通過啟動參數(shù) --spring.config.location 指定外部配置文件的路徑：

java -jar your-application.jar --spring.config.location=/etc/app-config/application-prod.yml

3. 配置環(huán)境變量

將配置路徑指定為環(huán)境變量，啟動時自動加載：

export SPRING_CONFIG_LOCATION=/etc/app-config/
java -jar your-application.jar

4. 在配置文件中指定額外路徑

在主配置文件中，使用 spring.config.additional-location 指定額外的加載路徑：

spring:
  config:
    additional-location: file:/etc/app-config/application-prod.yml

總結

多環(huán)境配置：

• 為不同的環(huán)境創(chuàng)建獨立的配置文件（application-dev.yml、application-prod.yml）。
• 使用 spring.profiles.active 動態(tài)切換環(huán)境。

配置文件排除：

• Maven：通過 maven-resources-plugin 或 maven-assembly-plugin 排除敏感文件。
• Gradle：通過 processResources 配置排除文件。

動態(tài)加載外部配置：

• 將敏感文件存儲在外部路徑，通過啟動參數(shù)、環(huán)境變量或額外路徑加載。

推薦實踐：

1. 敏感信息外部化：避免將敏感信息打包到 JAR 中。
2. 版本控制：將環(huán)境無關的公共配置納入版本管理，但排除敏感文件。
3. 環(huán)境隔離：通過 CI/CD 流程在不同環(huán)境中自動部署相應的配置。

以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論