Maven jar profile 多环境

简言

为了减少开发人员反复修改配置,考虑在旧项目(非springboot)中使用 maven profile,在此记录下实现过程。

修改记录

  1. 之前直接使用 POM 中的 <resource> 标签来控制文件覆盖不稳定,时灵时不灵。导致测试、生产环境jar包内配置文件不正确。现在纠正为使用resource插件,如果给读到的读者带来了疑惑,请多谅解。

  2. 由 copy-resource 改为 antrun。

实现过程

1.profiles

在pom文件中加入profiles配置。根据项目的需要,我配置3个profile节点,分别对应开发、测试和生产3种环境。代码如下:

<!-- 多环境配置 -->
    <profiles>
        <profile>
            <id>default</id>
            <properties>
                <package.environment.conf>src/main/filters/conf/local</package.environment.conf>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <package.environment.conf>src/main/filters/conf/test</package.environment.conf>
            </properties>
        </profile>
        <profile>
            <id>production</id>
            <properties>    
                <package.environment.conf>src/main/filters/conf/production</package.environment.conf>
            </properties>
        </profile>
    </profiles>

简单解释下代码中各个节点:

  1. id节点自定义,定义什么,使用打包命令时就用什么。如test,打包时就是用mvn package -Ptest
  2. properties下属子节点自定义,名称自定义,结合下文中的<buile> <resource>使用。子节点多少视项目实际情况而定。
  3. activation 缺省设置,如果直接使用mvn package时,默认会使用defaule节点下的配置文件。如果不设置此节点,那么使用打包命令时需要显示执行id。

加入这段代码的目的是:在打包时,将目标环境对应目录下的配置文件覆盖项目原有的配置文件,以此来达到自动修改文件。举例说明下,通过mvn package -Ptest打包,目标环境为test。那么在打包的时候,会使用test定义的目录,即src/main/filters/conf/test。然后,会将该目录下的配置文件覆盖项目原有的配置文件。

2.build

定义过 profiles 后,就需要定义 build 节点内容了。两者的关系就是后者调用前者。

  <build>
        <finalName>${project.artifactId}-${project.version}</finalName>
        <resources>
            <resource>
                <directory>src/main/java</directory>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                                <excludes>
                    <exclude>db/*</exclude>
                    <exclude>*config.properties</exclude>
                    <exclude>*spring.xml</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>src/main/filters</directory>
                <excludes>
                    <exclude>conf/local/*</exclude>
                    <exclude>conf/production/*</exclude>
                    <exclude>conf/test/*</exclude>
                </excludes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.1.0</version>
                <executions>
                    <execution>
                        <id>copy-resources</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${basedir}/target/classes</outputDirectory>
                            <resources>
                                <resource>
                                    <directory>${package.environment.conf}</directory>
                                    <filtering>true</filtering>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

2.1 copy-resource

下面的代码就是对 profiles 节点定义内容的调用:

<phase>prepare-package</phase>
<goals>
    <goal>copy-resources</goal>
</goals>
<configuration>
    <outputDirectory>${basedir}/target/classes</outputDirectory>
    <resources>
        <resource>
            <directory>${package.environment.conf}</directory>
            <filtering>true</filtering>
        </resource>
    </resources>
</configuration>

<directory>${package.environment.conf}</directory> 配置就是打包命令中指定的profile节点中定义属性的目录。举个例子:
“mvn package -Ptest”,使用此打包命令时,会先去找对应的profile节点,即:

<profile>
    <id>test</id>
    <properties>
        <package.environment.conf>src/main/filters/conf/test</package.environment.conf>
    </properties>
</profile>

找到节点后,${package.environment.conf} 会引用 package.environment.conf 所定义的内容,即:src/main/filters/conf/test

2.2 phase

<phase> 翻译为阶段,即在什么时候将 test 环境下的文件覆盖原来的配置文件,在这里为了保证打包时能选择正确的配置文件,设置为打包准备阶段,即 prepare-package

2.3 outputDirectory

<outputDirectory>就是目标文件夹,即要将src/main/filters/conf/test目录下的文件,放到${basedir}/src/main/resources下,${basedir} 就是项目文件夹的根路径。

2.4 copy-resource 改为 antrun

项目背景

项目达成jar包后,被其他项目模块引用了。所以使用 IDEA 时需要开启 maven 委托,maven 配置才能生效,打包时间略长且不能使用 JRebel,给开发带来不便。所以根据实际需要改为使用 antrun 插件的 copy 来达到相同的目的。

<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-antrun-plugin</artifactId>
        <executions>
            <execution>
                <id>prepare-copy-resources</id>
                <phase>package</phase>
                <goals>
                    <goal>run</goal>
                </goals>
                <configuration>
                    <tasks>
                        <copy file="${package.environment.conf}/spring-application.xml" tofile="${basedir}/target/classes/spring-application.xml" overwrite="true" />
                        <copy file="${package.environment.conf}/config.properties" tofile="${basedir}/target/classes/config.properties" overwrite="true" />
                    </tasks>
                </configuration>
            </execution>
        </executions>
    </plugin>
</plugins>

结语

至此,项目工程打包时,通过指定profile自动修改配置文件的目的已经实现。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容