激活Maven profile的几种方式

转载

wx60d4764eb475e 2021-06-29 16:24:36

文章标签 代码 文章分类 后端开发

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

Xml代码

<profiles>
<profile>
<id>jdk16</id>
<activation>
<jdk>1.6</jdk>
</activation>
<modules>
<module>simple-script</module>
</modules>
</profile>
</profiles>

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

你可以把profiles定义在4个地方：
1.%M2_HOME%/conf/settings.xml，这是针对该部电脑的所有user的profiles，是global profiles，它会影响所有的maven project build
2.<your -home-directory>/.m2/settings.xml，这是针对per user的profiles，是user级的profiles，它会影响当前user的所有maven project build
3.定义在pom.xml文件里面，这是仅针对该project的profiles，是project级的profiles
4.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，

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

1. 根据环境自动激活。

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

Xml代码

<profile>
<id>dev</id>
<activation>
<activeByDefault>false</activeByDefault>
<jdk>1.5</jdk>
<os>
<name>Windows XP</name>
<family>Windows</family>
<arch>x86</arch>
<version>5.1.2600</version>
</os>
<property>
<name>mavenVersion</name>
<value>2.0.5</value>
</property>
<file>
<exists>file2.properties</exists>
<missing>file1.properties</missing>
</file>
</activation>
...
</profile>

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

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

3. 配置默认自动激活。

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

Xml代码

<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
...
</profile>

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

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

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

Xml代码

<settings>
...
<activeProfiles>
<activeProfile>local_db</activeProfile>
</activeProfiles>
</settings>

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

5.根据配置的external properties

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

<project>
...
<profiles>
<profile>
<id>appserverConfig-dev</id>
<activation>
<property>
<name>env</name>
<value>dev</value>
</property>
</activation>
<properties>
<appserver.home>/path/to/dev/appserver</appserver.home>
</properties>
</profile>
<profile>
<id>appserverConfig-dev-2</id>
<activation>
<property>
<name>env</name>
<value>dev-2</value>
</property>
</activation>
<properties>
<appserver.home>/path/to/dev/appserver2</appserver.home>
</properties>
</profile>
</profiles>
<build>
<plugins>
<plugin>
<groupId>org.myco.plugins</groupId>
<artifactId>spiffy-integrationTest-plugin</artifactId>
<version>1.0</version>
<configuration>
<appserverHome>${appserver.home}</appserverHome>
</configuration>
</plugin>
...
</plugins>
</build>
...
</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 plugin的active-profiles goal，使用命令：
mvn help:active-profiles