1. 概述

Maven Profile 可以被用来创建自定义的构建配置，例如指定一个测试粒度，或者是指定部署环境。

2. 简单例子

  1. 通常，我们运行 mvn package，单元测试也会被执行，如果我们不希望执行单元测试，可以使用如下的 profile 配置：
1
2
3
4
5
6
7
8

  <profiles>
    <profile>
      <id>no-tests</id>
      <properties>
        <maven.test.skip>true</maven.test.skip>
      </properties>
    </profile>
  </profiles>
  1. 然后通过命令 mvn package -Pno-tests 来执行该 profile。
  2. 现在工程被打包，并且测试也被跳过了。

3. 声明 Profiles

  1. 通过指定不同的 id，我们可以创建无数个 profile。
  2. 我们可以创建一个 profile 来运行集成测试，也可以定义另一个 profile 来运行变异测试。
1
2
3
4
5
6
7
8

  <profiles>
    <profile>
      <id>integration-tests</id>
    </profile>
    <profile>
      <id>mutation-tests</id>
    </profile>
  </profiles>
  1. 在每一个 profile 元素内，我们可以配置许多元素，例如 dependencies，plugins，resources 和 finalName。
  2. 所以对上面的例子，我们可以对两个 profile 分别添加依赖和插件。

3.1. profile 作用域

  1. 之前，我们仅仅把 profiles 元素放在了 pom.xml 文件中，这样只会对该项目有效。
  2. 但是在 Maven 3 中，我们可以在如下位置添加 profiles：
    1. 项目范围：pom.xml 文件
    2. 用户范围：用户目录下的 settings.xml 文件
    3. 全局范围：全局 settings.xml 文件

4. 激活 Profile

4.1. 查看那个 profile 被激活

  1. 可以使用 help:active-profiles 来查询在我们默认的构建流程中，哪个 profile 被激活，一般情况下，查询结果为空。
  2. 另一种查看方式是将 maven-help-plugin 插件添加到 pom.xml 中，然后将其绑定到构建阶段下的 active-profile 目标上。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-help-plugin</artifactId>
        <version>3.2.0</version>
        <executions>
          <execution>
            <id>show-profile</id>
            <phase>compile</phase>
            <goals>
              <goal>active-profiles</goal>
            </goals>
          </execution>
        </executions>
      </plugin>

4.2 使用 -P 选项

  1. 我们可以使用 -P 选项来激活指定的 profile。
1

mvn package -P integration-tests

打印如下：

1
2
3

The following profiles are active:

 - integration-tests (source: com.ans20xx:demo01:1.0-SNAPSHOT)
  1. 如果我们想要一次激活多个 profile，我们可以使用如下命令：
1

mvn package -P integration-tests,mutation-tests

4.3. 默认激活

  1. 如果我们想要默认情况下执行某一个 profile，可以这样配置
1
2
3
4
5
6

    <profile>
      <id>integration-tests</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
    </profile>
  1. 然而，如果我们显式指定了 profile，那么默认的 profile 会被覆盖

4.4. 基于属性

  1. 我们可以使用命令行来激活 profile。
  2. 但是我们也可以通过 -D 系统属性来激活，例如，通过如下配置，我们可以使用 -Denvironment 命令来激活 profile：
1
2
3
4
5
6
7
8

<profile>
    <id>active-on-property-environment</id>
    <activation>
        <property>
            <name>environment</name>
        </property>
    </activation>
</profile>
  1. 通过如下配置，可以在属性不存在的时候激活：
1
2
3

<property>
    <name>!environment</name>
</property>
  1. 也可以通过如下配置，可以在属性为指定的值的时候来激活 profile，下面的就可以通过 -Denvironment=test 来激活：
1
2
3
4

<property>
    <name>environment</name>
    <value>test</value>
</property>
  1. 同理，也可以在属性不是某个指定的值的时候激活：
1
2
3
4

<property>
    <name>environment</name>
    <value>!test</value>
</property>

4.5. 基于 JDK 版本

  1. 可以基于 JDK 的版本来激活配置项
1
2
3
4
5
6

<profile>
    <id>active-on-jdk-11</id>
    <activation>
        <jdk>11</jdk>
    </activation>
</profile>

4.6. 基于操作系统

  1. 也可以基于一些操作系统信息来激活 profile>
  2. 可以通过 mvn enforcer:display-info 命令来获取与操作系统和 JDK 相关的信息：
1
2
3
4
5
6

[INFO]
[INFO] --- maven-enforcer-plugin:3.2.1:display-info (default-cli) @ demo01 ---
[INFO] Maven Version: 3.8.6
[INFO] JDK Version: 1.8.0_341 normalized as: 1.8.0-341
[INFO] Java Vendor: Oracle Corporation
[INFO] OS Info - Arch: amd64, Family: windows, Name: windows 11, Version: 10.0
  1. 所以，我们可以创建基于 windows 10.0 的配置：
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

<profile>
    <id>active-on-windows-10</id>
    <activation>
        <os>
            <name>windows 10</name>
            <family>Windows</family>
            <arch>amd64</arch>
            <version>10.0</version>
        </os>
    </activation>
</profile>

4.7. 基于文件

  1. 可以基于文件是否存在来运行 profile，下面的配置是在 testreport.xml 文件不存在的时候运行：
1
2
3
4
5

<activation>
    <file>
        <missing>target/testreport.html</missing>
    </file>
</activation>

5. 取消激活 profile

  1. 为了禁用某个 profile 可以使用 ! 或 -：
1

mvn compile -P -active-on-jdk-11