SpringBoot多环境打包与配置文件排除实践记录_Java

spring boot 项目多环境打包与配置文件排除实践

在实际开发中，spring boot 项目通常需要适配不同的运行环境，例如开发环境、测试环境、生产环境等。这些环境下的配置可能包含敏感信息，例如数据库连接密码、api密钥等。因此，在项目打包时，我们不仅需要支持多环境配置，还要考虑如何排除敏感配置文件，以保证安全性。

多环境配置的实现方法打包时排除配置文件的方法动态加载外部配置文件的最佳实践

一、多环境配置的实现方法

1. 配置多环境文件

spring boot 默认加载 application.properties 或 application.yml 配置文件。为了支持多环境配置，可以通过文件命名的方式区分环境，比如：

application-dev.yml：开发环境配置
application-test.yml：测试环境配置
application-prod.yml：生产环境配置

各环境配置文件可以定义不同的参数。例如，以下是开发和生产环境的数据库配置：

开发环境：application-dev.yml

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

生产环境：application-prod.yml

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

2. 动态切换环境

在 application.yml 中配置默认激活的环境：

spring:
  profiles:
    active: dev

通过命令行参数启动时动态指定环境：

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

二、打包时排除配置文件的方法

在某些情况下，敏感的配置文件（如 application-prod.yml）可能包含生产环境的重要信息。我们希望这些文件在打包时被排除，而不是直接包含在最终的 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>

创建 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>

执行构建命令：

mvn clean package

2. 使用 gradle 排除配置文件

在 gradle 的 build.gradle 文件中，可以通过 processresources 任务排除文件：

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

构建时运行：

./gradlew clean build

三、动态加载外部配置文件

为了进一步提高安全性，我们可以将敏感配置文件存储在外部，并通过动态加载的方式使用这些文件。

1. 存放外部配置文件

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

2. 启动时指定外部配置路径

通过启动参数 --spring.config.location 指定外部配置文件的路径：

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

3. 配置环境变量

将配置路径指定为环境变量，启动时自动加载：

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

四、总结

多环境配置

为不同的环境创建独立的配置文件（application-dev.yml、application-prod.yml）。
使用 spring.profiles.active 动态切换环境。

配置文件排除

maven：通过 maven-resources-plugin 或 maven-assembly-plugin 排除敏感文件。
gradle：通过 processresources 配置排除文件。

动态加载外部配置

将敏感文件存储在外部路径，通过启动参数、环境变量或额外路径加载。

推荐实践

敏感信息外部化：避免将敏感信息打包到 jar 中。
版本控制：将环境无关的公共配置纳入版本管理，但排除敏感文件。
环境隔离：通过 ci/cd 流程在不同环境中自动部署相应的配置。

到此这篇关于springboot - 多环境打包与配置文件排除实践的文章就介绍到这了,更多相关springboot 多环境打包内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！

SpringBoot多环境打包与配置文件排除实践记录

2024年11月22日 • Java •我要评论