Maven - Profile

什么是profile

profile是在maven xml中配置的,由<profiles></profiles>包围的一块配置

<profiles>
        <profile>
            <!-- do configuration -->
        </profile>
        <profile>
            <!-- do configuration -->
        </profile>
</profile>

profile的作用

通常情况下,线上和线下的一些配置是不一样的。通常,我们会把不同环境的配置放置到不同的文件中。
举个例子:
线上要读取的配置文件是config-online.properties
线下要读取的配置文件是config-test.properties

如何在不修改代码的情况下,实现不同的环境读取不同的配置呢?这里就可以使用profile。

当然,profile的作用不止是区分环境,能实现的功能主要有:

  • 区分运行环境
  • 区分JDK版本
  • 区分操作系统
  • 区分文件是否存在

哪里配置profile

  • pom.xml -- 每个maven工程中的pom.xml,只对该pom.xml所属的工程生效。这个是最常用的
  • .m2/settings.xml -- 全局的
  • Maven安装目录conf/settings.xml -- 全局的

怎么激活profile

pom.xml中撰写不同的profile,然后通过不同的方式来激活

<profiles>
    <profile>
        <!--通过-P参数激活-->
        <id></id>
        
        <!--activation标识什么情况下激活该profile-->
        <activation>
            <!--默认情况下,激活该profile-->
            <activeByDefault>true</activeByDefault>

            <!--根据os激活-->
            <os></os>
            
            <!--根据jdk激活,例子见下-->
            <jdk></jdk>
            
            <!--根据-D参数激活-->
            <property>
                <name></name>
                <value></value>
            </property>
        </activation>

        <properties>
        </properties>   
    </profile>
</profiles>

id

<profiles>
    <profile>
        <id>develop</id>
    </profile>
    <profile>
        <id>test</id>
    </profile>
    <profile>
        <id>online</id>
    </profile>
</profiles>

mvn compile -Pdevelop

activation - jdk

<profiles>
    <profile>
        <activation>
            <!--当jdk版本为1.7时,该profile生效-->
            <jdk>1.7</jdk>
            <!--当jdk版本大于1.5,小于等于1.8时,该profile生效-->
            <jdk>(1.5,1.8]</jdk>
        </activation>
    </profile>
</profiles>

activation - property

<profiles>
    <profile>
        <activation>
            <!--当名称为debug的参数被定义时,且值为true时,该profile生效-->
            <property>
                <name>debug</name>
                <value>true</value>
            </property>
        </activation>
    </profile>
</profiles>

mvn install -Ddebug=true

<profiles>
    <profile>
        <activation>
            <!--当名称为debug的参数被定义时,该profile生效-->
            <property>
                <name>debug</name>
            </property>
        </activation>
    </profile>
</profiles>

activation - os

<profiles>
    <profile>
        <!--当os为Windows XP时,该profile生效-->
        <os>
            <name>Windows XP</name>
            <family>Windows</family>
            <arch>x86</arch>
            <version>5.1.2600</version>
        </os>
    </profile>
</profiles>

详细参数见Require OS Version

哪些元素可以根据profile自定义

pom中的下列元素中的配置均可通过profile定义

  • <repositories>
  • <pluginRepositories>
  • <dependencies>
  • <plugins>
  • <properties> (not actually available in the main POM, but used behind the scenes)
  • <modules>
  • <reporting>
  • <dependencyManagement>
  • <distributionManagement>
  • a subset of the <build> element, which consists of:
    • <defaultGoal>
    • <resources>
    • <testResources>
    • <finalName>

例子1:
如要发布一个jar包,测试环境发SNAPSHOT版本的,线上环境发Release版本的,可这样配置:

<project>
    <groupId>xxx</groupId>
    <artifactId>xxx</artifactId>
    <version>${project.version}</version>

    <profiles>
        <profile>
            <id>test</id>
            <properties>
                <project.version>1.0.0-SNAPSHOT</project.version>
            </properties>
        </profile>
        
        <profile>
            <id>online</id>
            <properties>
                <project.version>1.0.0</project.version>
            </properties>
        </profile>
    </profiles>
</project>

mvn deploy -Ptest
或者
mvn deploy -Ponline

例子2:
需要根据不同的环境选取不同的resource:

<profiles>
    <profile>
        <id>test</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <build>
            <resources>
                <resource>
                    <directory>profiles/test</directory>
                </resource>
                <resource>
                    <directory>src/main/resources</directory>
                </resource>
            </resources>
        </build>
    </profile>
    
    <profile>
        <id>online</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <build>
            <resources>
                <resource>
                    <directory>profiles/online</directory>
                </resource>
                <resource>
                    <directory>src/main/resources</directory>
                </resource>
            </resources>
        </build>
    </profile>
</profiles>

同时,在工程中会有这样的文件夹:

+---profiles
    +---test
        ---config.properties
    +---online
        ---config.properties

参考

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