maven根据profile中定义的环境变量打包的设置

  categories:资料  tags:  author:

一个项目里总会有很多配置文件。而且一般都会有多套环境。开发的、测试的、正式的。而在这些不同的环境这些配置的值都会不一样。比如mail的配置、服务的url配置这些都是很常见的。所以在打包的时候就要根据environment来选不同的值或者配置文件。

比较常用的办法就是为不同的环境建立不同的配置文件目录。在打包的时候用对应的文件目录下的配置文件。

|-- resources
 |   |-- dev
 |   |-- product
 |   |-- qa
 |   `-- qa53

以前用ant的时候打包的时候处理就比较方便。打包前copy一下对应目录下的配置文件覆盖target下的那些文件再打包就可以了。在刚开始用 maven的时候就想要怎么解决,一直没有找到ant的这种方式的可行的办法。其实主要是按ant这种处理方法去思考了。只去想没有有cp这种 target。其实在maven里用profile就可以解决了。对于不同的environment定义不同的profile就ok了,目录结构还是沿用 原来的就可以。

在pom.xml里定义一个变量

<properties>
 ......
 <package.environment>qa53</package.environment>
 </properties>

这里定义的值是经常打包的一个profile,方便少敲点代码。然后定义一些profile

<profiles>
 <profile>
 <id>product</id>
 <properties>
 <package.environment>product</package.environment>
 </properties>
 </profile>
 <profile>
 <id>dev</id>
 <properties>
 <package.environment>dev</package.environment>
 </properties>
 </profile>
 <profile>
 <id>qa</id>
 <properties>
 <package.environment>qa</package.environment>
 </properties>
 </profile>
 </profiles>

最后再修改一下打包的plugin,引用这个变量。

<plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-war-plugin</artifactId>
 <configuration>
 <archive>
 <addMavenDescriptor>false</addMavenDescriptor>
 </archive>
 <webResources>
 <resource>
 <!-- this is relative to the pom.xml directory -->
 <directory>src/main/resources/${package.environment}</directory>
 <targetPath>WEB-INF/classes</targetPath>
 <filtering>true</filtering>
 </resource>
 </webResources>
 </configuration>
 </plugin>

这里注意一个参数<filtering>true</filtering>,一定要设置成true这样才会用对应environment目录下的配置文件覆盖原来的。ok。mvn package的时候就会用默认的qa53目录下的配置文件。如果要发布正式环境的包就运行。

mvn -Pproduct package

———————————–

Profiles是maven的一个很关键的术语:profile是用来定义一些在build lifecycle中使用的environmental variations,profile可以设置成在不同的环境下激活不同的profile(例如:不同的OS激活不同的profile,不同的JVM激活不同的profile,不同的dabase激活不同的profile等等)。

定义Profiles

你可以把profiles定义在4个地方:

%M2_HOME%/conf/settings.xml,这是针对该部电脑的所有user的profiles,是global profiles,它会影响所有的maven project build

<your -home-directory>/.m2/settings.xml,这是针对per user的profiles,是user级的profiles,它会影响当前user的所有maven project build

定义在pom.xml文件里面,这是仅针对该project的profiles,是project级的profiles

profiles.xml,它和pom.xml在同一个目录下,也是project级的profiles,使用profiles.xml的目的是希望把profiles的设置从pom.xml里抽离出来设置。

定义在这4个地方的profiles中,涉及范围越窄的profiles会覆盖范围越宽的profiles。即:定义在pom.xml里profiles会覆盖profiles.xml的,profiles.xml的会覆盖<your -home-directory>/.m2/settings.xml的,<your -home-directory>/.m2/settings.xml的会覆盖%M2_HOME%/conf/settings.xml的。

不过请注意:设置在pom.xml里的profiles是最最推荐的,因为pom.xml会被deploy到repository里,所以pom.xml里的profiles才会available for subsequent builds originating from the repository or as transitive dependencies。而settings.xml和profiles.xml里定义的profiles不会被deploy到repository,则有诸多限制,因此,只有下面几个profiles能够在settings.xml和profiles.xml里定义:

repositories

pluginRepositories

properties

其他类型的profiles必须在pom.xml里定义(上面3个profiles也可以在pom.xml里定义)。

Pom.xml能够定义的profiles包括:

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

———————————–

profile简介

profile可以让我们定义一系列的配置信息,然后指定其激活条件。这样我们就可以定义多个profile,然后每个profile对应不同的激活条件和配置信息,从而达到不同环境使用不同配置信息的效果。比如说,我们可以通过profile定义在jdk1.5以上使用一套配置信息,在jdk1.5以下使用另外一套配置信息;或者有时候我们可以通过操作系统的不同来使用不同的配置信息,比如windows下是一套信息,linux下又是另外一套信息,等等。具体的激活条件有哪些我在后文会讲到。

profile的定义位置

对于使用Maven3,我们可以有多个地方定义profile。定义的地方不同,它的作用范围也不同。

(1)    针对于特定项目的profile配置我们可以定义在该项目的pom.xml中。

(2)    针对于特定用户的profile配置,我们可以在用户的settings.xml文件中定义profile。该文件在用户家目录下的“.m2”目录下。

(3)    全局的profile配置。全局的profile是定义在Maven安装目录下的“conf/settings.xml”文件中的。

profile中能定义的信息

profile中能够定义的配置信息跟profile所处的位置是相关的。以下就分两种情况来讨论,一种是定义在settings.xml中,另一种是定义在pom.xml中。

profile定义在settings.xml中
当profile定义在settings.xml中时意味着该profile是全局的,它会对所有项目或者某一用户的所有项目都产生作用。因为它是全局的,所以在settings.xml中只能定义一些相对而言范围宽泛一点的配置信息,比如远程仓库等。而一些比较细致一点的需要根据项目的不同来定义的就需要定义在项目的pom.xml中。具体而言,能够定义在settings.xml中的信息有<repositories>、<pluginRepositories>和<properties>。定义在<properties>里面的键值对可以在pom.xml中使用。

profile定义在pom.xml中
定义在pom.xml中的profile可以定义更多的信息。主要有以下这些:

<repositories>
<pluginRepositories>
<dependencies>
<plugins>
<properties>
<dependencyManagement>
<distributionManagement>
还有build元素下面的子元素,主要包括:
<defaultGoal>
<resources>
<testResources>
<finalName>

 
profile的激活方式

Maven给我们提供了多种不同的profile激活方式。比如我们可以使用-P参数显示的激活一个profile,也可以根据环境条件的设置让它自动激活等。下面将对它们一一进行介绍:

使用activeByDefault设置激活

先看下面一个配置

    <profiles>  
            <profile>  
                 <id>profileTest1</id>  
                 <properties>  
                        <hello>world</hello>  
                 </properties>  
                 <activation>  
                        <activeByDefault>true</activeByDefault>  
                 </activation>  
            </profile>  
              
            <profile>  
                 <id>profileTest2</id>  
                 <properties>  
                        <hello>andy</hello>  
                 </properties>  
            </profile>  
     </profiles>

我们可以在profile中的activation元素中指定激活条件,当没有指定条件,然后指定activeByDefault为true的时候就表示当没有指定其他profile为激活状态时,该profile就默认会被激活。所以当我们调用mvn package的时候上面的profileTest1将会被激活,但是当我们使用mvn package –P profileTest2的时候将激活profileTest2,而这个时候profileTest1将不会被激活。

在settings.xml中使用activeProfiles指定处于激活状态的profile
我们可以在settings.xml中使用activeProfiles来指定需要激活的profile,这种方式激活的profile将所有情况下都处于激活状态。比如现在我们定义了如下两个profile

 

    <profiles>  
           <profile>  
                <id>profileTest1</id>  
                <properties>  
                       <hello>world</hello>  
                </properties>  
           </profile>  
             
           <profile>  
                <id>profileTest2</id>  
                <properties>  
                       <hello>andy</hello>  
                </properties>  
           </profile>  
    </profiles>

这里的profile可以是定义在settings.xml中的,也可以是定义在pom.xml中的。这个时候如果我们需要指定profileTest1为激活状态,那么我们就可以在settings.xml中定义activeProfiles,具体定义如下:

<activeProfiles>  
         <activeProfile>profileTest1</activeProfile>  
    </activeProfiles>

考虑这样一种情况,我们在activeProfiles下同时定义了多个需要激活的profile。这里还拿上面的profile定义来举例,我们定义了同时激活profileTest1和profileTest2。

    <activeProfiles>  
         <activeProfile>profileTest1</activeProfile>  
         <activeProfile>profileTest2</activeProfile>  
    </activeProfiles>

从profileTest1和profileTest2我们可以看出它们共同定义了属性hello。那么这个时候我在pom.xml中使用属性hello的时候,它到底取的哪个值呢?是根据activeProfile定义的顺序,后面的覆盖前面的吗?根据我的测试,答案是非也,它是根据profile定义的先后顺序来进行覆盖取值的,然后后面定义的会覆盖前面定义的。

使用-P参数显示的激活一个profile
假设我们现在有如下定义的profiles

    <profiles>  
           <profile>  
                  <id>profileTest1</id>  
                  <properties>  
                         <hello>world</hello>  
                  </properties>  
           </profile>  
           <profile>  
                  <id>profileTest2</id>  
                  <properties>  
                         <hello>andy</hello>  
                  </properties>  
           </profile>  
    <profiles>  

那么当我们在进行Maven操作时就可以使用-P参数显示的指定当前激活的是哪一个profile了。比如我们需要在对项目进行打包的时候使用id为profileTest1的profile,我们就可以这样做:

mvn package –P profileTest1

当我们使用activeByDefault或settings.xml中定义了处于激活的profile,但是当我们在进行某些操作的时候又不想它处于激活状态,这个时候我们可以这样做:
Cmd代码  收藏代码

Mvn package –P !profileTest1

这里假设profileTest1是在settings.xml中使用activeProfile标记的处于激活状态的profile,那么当我们使用“-P !profile”的时候就表示在当前操作中该profile将不处于激活状态。

根据环境来激活profile

profile一个非常重要的特性就是它可以根据不同的环境来激活,比如说根据操作系统的不同激活不同的profile,也可以根据jdk版本的不同激活不同的profile,等等。
根据jdk来激活profile

    <profiles>  
           <profile>  
                  <id>profileTest1</id>  
                  <jdk>1.5</jdk>  
           </profile>  
    <profiles>

上面情况表示在jdk为1.5版本系列的时候激活profileTest1。

 <profiles>  
           <profile>  
                  <id>profileTest1</id>  
                  <jdk>[1.4,1.7)</jdk>  
           </profile>  
    <profiles>

上面的情况表示在jdk为1.4、1.5和1.6的时候激活profileTest1。

根据操作系统来激活profile

<profiles>
<profile>
<id>profileTest1</id>
<activation>
<os>
<name>Windows XP</name>
<family>Windows</family>
<arch>x86</arch>
<version>5.1.2600</version>
</os>
</activation>
</profile>
</profiles>

上面的情况就是根据操作系统的类型来激活profileTest1。

根据系统属性来激活profile

<profiles>
<profile>
<id>profileTest1</id>
<activation>
<property>
<name>hello</name>
<value>world</value>
</property>
</activation>
</profile>
</profiles>

上面的profileTest1将在提供了系统属性hello,并且其值为world的时候激活。下面的做法可以激活profileTest1。

mvn package –Dhello=world

当是下面的这种定义形式时,profileTest1将在指定了系统属性hello,且其值为任意值的时候被激活。

<profiles>
<profile>
<id>profileTest1</id>
<activation>
<property>
<name>hello</name>
</property>
</activation>
</profile>
</profiles>

根据文件是否存在激活profile
<profiles>
<profile>
<id>profileTest1</id>
<activation>
<file>
<exists>target</exists>
</file>
</activation>
</profile>
</profiles>

上面的定义表示当存在target文件时激活profileTest1。

<profiles>
<profile>
<id>profileTest1</id>
<activation>
<file>
<missing>target</missing>
</file>
</activation>
</profile>
</profiles>

上面的定义表示当不存在target文件时激活profileTest1。

我们可以同时定义多个profile,那么在建立项目的过程中,到底激活的是哪一个profile呢?Maven为我们提供了一个指令可以查看当前处于激活状态的profile都有哪些,这个指定就是mvn help:active-profiles。

现在假设我们的settings.xml文件中有如下profile的定义:

<profiles>
<profile>
<id>profileTest1</id>
<activation>
<file>
<missing>target</missing>
</file>
</activation>
</profile>
</profiles>

<activeProfiles>
<activeProfile>profileTest1</activeProfile>
</activeProfiles>

这个时候我们可以看到,我们已经定义了profileTest1始终为激活状态,这个时候我们使用mvn help:active-profiles查看处于激活状态的profile时,就会打印出如下内容:



快乐成长 每天进步一点点