使用maven中的profile动态打包不同环境的配置文件

SYKMI

已于 2023-07-07 11:53:11 修改

阅读量5.1k

点赞数 3

分类专栏： Maven 文章标签： maven java

于 2023-06-27 22:55:44 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_44001317/article/details/131426446

版权

Maven 专栏收录该内容

11 篇文章

订阅专栏

maven中的profile可以在打包时动态选择不同的配置文件进行打入，在项目具有开发、测试、生产环境时可以更方便优雅的进行不同环境的打包运行
示例图：在这里插入图片描述

1-配置profile

第一步需要为每个环境配置一个profile标签，在pom文件中进行配置。我这里只演示dev和test的环境配置

    <profiles>
        <profile>
            <id>dev</id> <!--给每个环境一个唯一的id-->
            <properties><!--在这个标签中配置你的自定义变量，下面的env就是我自己定义的-->
                <env>dev</env>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault><!--默认激活的环境-->
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <env>test</env>
            </properties>
        </profile>
    </profiles>

这里需要说明的是自定义的变量，这个变量可以在pom文件中的其他地方以${标签名}的形式进行引用，同时也可以在springboot的配置文件中进行引用，在springboot的配置文件中进行引用时，使用@标签名@进行引用

2-配置需要进行打包的文件

当我们配置好环境之后，需要在pom里新建resources标签进行根据指定环境打包指定配置文件的处理

        <resources>
            <resource>
                <directory>src/main/resources</directory><!--指定资源文件夹-->
                <includes>
                    <include>**/*.properties</include><!--将该资源文件夹下的properties文件全部打包-->
                </includes>
                <excludes>
                    <exclude>**/payConfig/**</exclude><!--这里排除payConfig文件夹，也就是说该文件夹中的文件不会被打包，因为这个文件夹下的配置文件需要动态处理-->
                </excludes>
                <filtering>false</filtering><!--这些资源文件将保持原样，不会进行任何替换或修改操作-->
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>application-${env}.yml</include><!--这里使用占位符进行动态引用以确定具体的打包文件-->
                    <include>application.yml</include><!--主配置文件必须打包-->
                </includes>
                <filtering>true</filtering><!--开启过滤，在打包时application.yml中配置的@env@将被确定到底是什么变量-->
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>config/payConfig/aliPay/${env}/*.properties</include>
                    <include>config/payConfig/wxPay/${env}/*.properties</include>
                </includes>
                <filtering>false</filtering><!--这里不需要设置过滤，上面的${env}是pom内部变量的使用，设置过滤是为了替换文件内的引用变量-->
            </resource>
        </resources>

提示1：filtering标签用于指定是否对资源文件进行过滤处理。
当一个资源文件需要在构建期间进行替换或修改时，可以使用过滤机制。例如，将属性值注入到配置文件中，或根据环境对资源文件进行不同的配置。
提示2：** 表示多级目录匹配。* 表示一级目录匹配。

3-配置SpringBoot配置文件

在这里插入图片描述
可以看到配置文件中使用了@env@占位符进行配置，也就是说，我们只有在使用maven进行编译的时候才确定到底是什么值，由于在第二步中已经在pom中开启了过滤，所以在打包时占位符将被替换

4-编译测试

我不使用默认的dev环境，手动选择test进行编译
在这里插入图片描述

下面是编译后的文件结构

可以看到成功将test环境的文件进行编译，其他不包含，并且application.yml中的值也被替换

同时也可以使用mvn clean package -P[dev|test|pro]指定环境进行命令行形式打包
TIPS：
-P代表（Profiles配置文件）在<profiles>指定的<id>中，可以通过-P进行传递或者赋值。打包时执行mvn clean package -P prod将触发prod环境的profile配置打包时执行mvn clean package -P test将触发test环境的profile配置
-D代表（Properties属性）-D属性名=属性值如果pom文件中已经通过properties标签指定了值的话，使用命令将替换pom中的值。如果没有的话，它将被设置
大功告成