Maven - 构建配置文件

上一页
下一页

什么是构建配置文件？

构建配置文件是一组配置值，可用于设置或覆盖 Maven 构建的默认值。使用构建配置文件，您可以为不同的环境（例如生产环境与开发环境）自定义构建。

配置文件在 pom.xml 文件中使用其 activeProfiles/profiles 元素指定，并通过多种方式触发。配置文件在构建时修改 POM，并用于为不同的目标环境提供参数（例如，开发、测试和生产环境中数据库服务器的路径）。

构建配置文件类型

构建配置文件主要分为三种类型。

类型 定义位置
每个项目 在项目 POM 文件 pom.xml 中定义
每个用户 在 Maven settings.xml 文件中定义 (%USER_HOME%/.m2/settings.xml)
全局 在 Maven 全局 settings.xml 文件中定义 (%M2_HOME%/conf/settings.xml)

配置文件激活

Maven 构建配置文件可以通过多种方式激活。

  • 显式使用命令行输入。
  • 通过 Maven 设置。
  • 基于环境变量（用户/系统变量）。
  • 操作系统设置（例如，Windows 系统）。
  • 文件存在/不存在。

配置文件激活示例

让我们假设您的项目的目录结构如下：

Maven Build Profile

现在，在 **src/main/resources** 下，有三个特定于环境的文件：

序号 文件名和描述
1

env.properties

如果没有提及配置文件，则使用默认配置。
2

env.test.properties

使用测试配置文件时的测试配置。
3

env.prod.properties

使用生产配置文件时的生产配置。

显式配置文件激活

在下面的示例中，我们将 maven-antrun-plugin:run 目标附加到测试阶段。这将允许我们为不同的配置文件回显文本消息。我们将使用 pom.xml 定义不同的配置文件，并使用 maven 命令在命令行中激活配置文件。

假设我们在 C:\MVN\project 文件夹中创建了以下 pom.xml。

<project xmlns = "http://maven.apache.org/POM/4.0.0"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
   http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.companyname.projectgroup</groupId>
   <artifactId>project</artifactId>
   <version>1.0</version>
   <profiles>
      <profile>
         <id>test</id>
         <build>
            <plugins>
               <plugin>
                  <groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-antrun-plugin</artifactId>
                  <version>1.1</version>
                  <executions>
                     <execution>
                        <phase>test</phase>
                        <goals>
                           <goal>run</goal>
                        </goals>
                        <configuration>
                           <tasks>
                              <echo>Using env.test.properties</echo>
                              <copy file="src/main/resources/env.test.properties"
                                 tofile="${project.build.outputDirectory}/env.properties"/>
                           </tasks>
                        </configuration>
                     </execution>
                  </executions>
               </plugin>
            </plugins>
         </build>
      </profile>
   </profiles>
</project>

现在打开命令行，转到包含 pom.xml 的文件夹，并执行以下 **mvn** 命令。使用 -P 选项将配置文件名作为参数传递。

C:\MVN\project>mvn test -Ptest

Maven 将开始处理并显示测试构建配置文件的结果。

C:\MVN>mvn test -Ptest
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ project ---
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 3 resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ project ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ project ---
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] skip non existing resourceDirectory C:\MVN\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ project ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ project ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (default) @ project ---
[INFO] Executing tasks
     [echo] Using env.test.properties
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  2.011 s
[INFO] Finished at: 2021-12-10T20:29:39+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

现在，您可以执行以下步骤作为练习：

  • 将另一个 profile 元素添加到 pom.xml 的 profiles 元素中（复制现有的 profile 元素，并将其粘贴到 profile 元素结束的位置）。

  • 将此 profile 元素的 id 从 test 更新为 normal。

  • 更新 task 部分以回显 env.properties 并将 env.properties 复制到目标目录。

  • 再次重复上述三个步骤，将 id 更新为 prod，并更新 task 部分以使用 env.prod.properties。

  • 就是这样。现在您已经准备好了三个构建配置文件（normal/test/prod）。

现在打开命令行，转到包含 pom.xml 的文件夹，并执行以下 **mvn** 命令。使用 -P 选项将配置文件名作为参数传递。

C:\MVN\project>mvn test -Pnormal

C:\MVN\project>mvn test -Pprod

检查构建的输出以查看差异。

通过 Maven 设置激活配置文件

打开位于 %USER_HOME%/.m2 目录中的 Maven **settings.xml** 文件，其中 **%USER_HOME%** 代表用户主目录。如果 settings.xml 文件不存在，则创建一个新的文件。

使用 activeProfiles 节点将测试配置文件添加为活动配置文件，如下例所示。

<settings xmlns = "http://maven.apache.org/POM/4.0.0"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
   http://maven.apache.org/xsd/settings-1.0.0.xsd">
   <mirrors>
      <mirror>
         <id>maven.dev.snaponglobal.com</id>
         <name>Internal Artifactory Maven repository</name>
         <url>http://repo1.maven.org/maven2/</url>
         <mirrorOf>*</mirrorOf>
      </mirror>
   </mirrors>
   <activeProfiles>
      <activeProfile>test</activeProfile>
   </activeProfiles>
</settings>

现在打开命令行，转到包含 pom.xml 的文件夹，并执行以下 **mvn** 命令。不要使用 -P 选项传递配置文件名。Maven 将显示测试配置文件作为活动配置文件的结果。

C:\MVN\project>mvn test

通过环境变量激活配置文件

现在从 maven settings.xml 中删除活动配置文件，并更新 pom.xml 中提到的测试配置文件。向 profile 元素添加 activation 元素，如下所示。

当系统属性“env”指定为值“test”时，测试配置文件将被触发。创建一个环境变量“env”，并将其值设置为“test”。

<profile>
   <id>test</id>
   <activation>
      <property>
         <name>env</name>
         <value>test</value>
      </property>
   </activation>
</profile>

让我们打开命令行，转到包含 pom.xml 的文件夹，并执行以下 **mvn** 命令。

C:\MVN\project>mvn test

通过操作系统激活配置文件

添加 activation 元素以包含操作系统详细信息，如下所示。当系统为 Windows XP 时，此测试配置文件将被触发。

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

现在打开命令行，转到包含 pom.xml 的文件夹，并执行以下 **mvn** 命令。不要使用 -P 选项传递配置文件名。Maven 将显示测试配置文件作为活动配置文件的结果。

C:\MVN\project>mvn test

通过文件存在/不存在激活配置文件

现在添加 activation 元素以包含操作系统详细信息，如下所示。当 **target/generated-sources/axistools/wsdl2java/com/companyname/group** 不存在时，测试配置文件将被触发。

<profile>
   <id>test</id>
   <activation>
      <file>
         <missing>target/generated-sources/axistools/wsdl2java/
           com/companyname/group</missing>
      </file>
   </activation>
</profile>

现在打开命令行，转到包含 pom.xml 的文件夹，并执行以下 **mvn** 命令。不要使用 -P 选项传递配置文件名。Maven 将显示测试配置文件作为活动配置文件的结果。

C:\MVN\project>mvn test
打印页面
上一页
下一页
广告