首先简单介绍下 Maven 的 profile 是什么。对于人来说,profile 是指人的肖像,轮廓,比如论坛里每个人注册了帐号后,可以设置自己的 profile,放上照片,介绍等等。对于 Maven 来说又是怎样呢?整个项目定义好了项目对象模型(POM),就像论坛为每个人提供了默认的行为功能,如果我想改变我机器上的 POM 呢?这时就可以使用 profile。下面举个例子:

Xml代码  收藏代码
  1. <profiles>  
  2.   <profile>  
  3.     <id>jdk16</id>  
  4.     <activation>  
  5.       <jdk>1.6</jdk>  
  6.     </activation>  
  7.     <modules>  
  8.       <module>simple-script</module>  
  9.     </modules>  
  10.   </profile>  
  11. </profiles>  

这个 profile 的意思是,当机器上的 JDK 为1.6的时候,构建 simple-script 这个子模块,如果是1.5或者1.4,那就不构建,这个 profile 是由环境自动激活的。

你可以把profiles定义在4个地方:
1.%M2_HOME%/conf/settings.xml
,这是针对该部电脑的所有userprofiles,是global profiles,它会影响所有的maven project build 
2.<your -home-directory>/.m2/settings.xml
,这是针对per userprofiles,是user级的profiles,它会影响当前user的所有maven project build 
3.定义在pom.xml文件里面,这是仅针对该projectprofiles,是project级的profiles 
4.profiles.xml
,它和pom.xml在同一个目录下,也是project级的profiles,使用profiles.xml的目的是希望把profiles的设置从pom.xml里抽离出来设置。 


定义在这4个地方的profiles中,涉及范围越窄的profiles会覆盖范围越宽的profiles。即:定义在pom.xmlprofiles会覆盖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会被deployrepository里,所以pom.xml里的profiles才会available for subsequent builds originating from the repository or as transitive dependencies。而settings.xmlprofiles.xml里定义的profiles不会被deployrepository 

我们需要在合适的地方使用合适的 profile ,并且在合适的时候用合适的方式将其激活,你不能在构建服务器上激活非公共的 profile,你也不能要求开发人员写很复杂的命令来使用常规的 profile。因此这里介绍一下几种 profile 的激活方式。

 

1. 根据环境自动激活。

如前一个例子,当 JDK 为1.6的时候,Maven 就会自动构建 simple-script 模块。除了 JDK 之外,我们还可以根据操作系统参数和 Maven 属性等来自动激活 profile,如:

Xml代码  收藏代码
  1. <profile>  
  2.   <id>dev</id>  
  3.   <activation>  
  4.     <activeByDefault>false</activeByDefault>  
  5.     <jdk>1.5</jdk>  
  6.     <os>  
  7.       <name>Windows XP</name>  
  8.       <family>Windows</family>  
  9.       <arch>x86</arch>  
  10.       <version>5.1.2600</version>  
  11.     </os>  
  12.     <property>  
  13.       <name>mavenVersion</name>  
  14.       <value>2.0.5</value>  
  15.     </property>  
  16.     <file>  
  17.       <exists>file2.properties</exists>  
  18.       <missing>file1.properties</missing>  
  19.     </file>  
  20.   </activation>  
  21.   ...  
  22. </profile>  

2. 通过命令行参数激活。

这是最直接和最简单的方式,比如你定义了一个名为 myProfile 的 profile,你只需要在命令行输入 mvn clean install -Pmyprofile 就能将其激活,这种方式的好处很明显,但是有一个很大的弊端,当 profile 比较多的时候,在命令行输入这写 -P 参数会让人觉得厌烦,所以,如果你一直用这种方式,觉得厌烦了,可以考虑使用其它自动激活的方式。

 

3. 配置默认自动激活。

方法很简单,在配置 profile 的时候加上一条属性就可以了,如:

Xml代码  收藏代码
  1. <profile>  
  2.   <id>dev</id>  
  3.   <activation>  
  4.     <activeByDefault>true</activeByDefault>  
  5.   </activation>  
  6.   ...  
  7. </profile>  

在一个特殊的环境下,配置默认自动激活的 profile 覆盖默认的 POM 配置,非常简单有效。

 

4. 配置 settings.xml 文件 profile 激活。

settings.xml 文件可以在 ~/.m2 目录下,为某个用户的自定义行为服务,也可以在 M2_HOME/conf 目录下,为整台机器的所有用户服务。而前者的配置会覆盖后者。同理,由 settings.xml 激活的 profile 意在为用户或者整个机器提供特定环境配置,比如,你可以在某台机器上配置一个指向本地数据库 URL 的 profile,然后使用该机器的 settings.xml 激活它。激活方式如下:

Xml代码  收藏代码
  1. <settings>  
  2.   ...  
  3.   <activeProfiles>  
  4.     <activeProfile>local_db</activeProfile>  
  5.   </activeProfiles>  
  6. </settings>  

 

Maven 提供的 profile 功能非常强大和灵活,用得好的话,可以有效的隔离很多特殊的配置,使得整个项目能在不同环境中顺利的构建。但是,强大和灵活带来得问题是相对难掌握,希望本文能对 Maven 使用者有帮助。

5.根据配置的external properties

不是定义在pom.xml里的properties都称为external properties

  1. <project> 
  2.  ... 
  3.  <profiles> 
  4.     <profile> 
  5.       <id>appserverConfig-dev</id> 
  6.       <activation> 
  7.         <property> 
  8.           <name>env</name> 
  9.           <value>dev</value> 
  10.         </property> 
  11.       </activation> 
  12.       <properties> 
  13.         <appserver.home>/path/to/dev/appserver</appserver.home> 
  14.       </properties> 
  15.     </profile> 
  16.   
  17.     <profile> 
  18.       <id>appserverConfig-dev-2</id> 
  19.       <activation> 
  20.         <property> 
  21.           <name>env</name> 
  22.           <value>dev-2</value> 
  23.         </property> 
  24.       </activation> 
  25.       <properties> 
  26.         <appserver.home>/path/to/dev/appserver2</appserver.home> 
  27.       </properties> 
  28.     </profile> 
  29.  </profiles> 
  30.   
  31.  <build> 
  32.     <plugins> 
  33.       <plugin> 
  34.         <groupId>org.myco.plugins</groupId> 
  35.         <artifactId>spiffy-integrationTest-plugin</artifactId> 
  36.         <version>1.0</version> 
  37.         <configuration> 
  38.           <appserverHome>${appserver.home}</appserverHome> 
  39.         </configuration> 
  40.       </plugin> 
  41.       ... 
  42.     </plugins> 
  43.  </build> 
  44.  ... 
  45. </project> 

上面定义的pom.xml定义了两个profile:不同的”env”参数值会激活不同的profile。当执行命令:
mvn -Denv=dev-2 integration-test
就会激活profile “appserverConfig-dev-2”
 
当执行命令:
mvn -Denv=dev integration-test
就会激活profile “appserverConfig-dev”

查看build time过程中使用了哪些Profiles
执行help pluginactive-profiles goal,使用命令:
            mvn help:active-profiles