Maven 简明教程

Maven - Build Life Cycle

What is Build Lifecycle?

构建生命周期是一个定义明确的阶段序列，该序列定义了执行目标的顺序。在此，阶段表示生命周期中的一个阶段。例如，一个典型的 Maven Build Lifecycle 包含以下阶段序列。

Phase

Handles

Description

prepare-resources

resource copying

可以在此阶段自定义资源复制。

validate

Validating the information

验证项目是否正确，以及是否提供了所有必要信息。

compile

compilation

在此阶段完成源代码编译。

Test

Testing

为适合测试框架的已编译源代码进行测试。

package

packaging

此阶段根据 POM.xml 中的打包创建 JAR/WAR 包。

install

installation

此阶段在本地/远程 maven 仓库中安装包。

Deploy

Deploying

将最终的软件包复制到远程仓库。

始终都有 pre 和 post 阶段来注册 goals ，这些阶段必须在特定阶段之前或之后运行。

当 Maven 开始构建项目时，它会逐步执行一系列已定义的阶段并执行目标，这些目标已注册到各个阶段。

Maven 具有以下三个标准生命周期−

clean
default(or build)
site

goal 表示一项有助于构建和管理项目，并可能绑定到一个或多个构建阶段的特定任务。未绑定到任何构建阶段的目标可以通过直接调用在构建生命周期之外执行。

执行顺序取决于目标和构建阶段的调用顺序。例如，考虑以下命令。 clean 和 package 参数是构建阶段，而 dependency:copy-dependencies 是目标。

mvn clean dependency:copy-dependencies package

此处将首先执行 clean 阶段，然后执行 dependency:copy-dependencies goal ，最后执行 package 阶段。

Clean Lifecycle

当我们执行 mvn post-clean 命令时，Maven 将调用包含以下阶段的 clean 生命周期。

pre-clean
clean
post-clean

Maven clean 目标 (clean:clean) 绑定到 clean 生命周期中的 clean 阶段。它的 clean:cleangoal 通过删除构建目录来删除构建结果。因此，当执行 mvn clean 命令时，Maven 将删除构建目录。

我们可以通过在 clean 生命周期中的任何上述阶段中指定目标来自定义此行为。

在以下示例中，我们将 maven-antrun-plugin:run 目标附加到 pre-clean、clean 和 post-clean 阶段。这将允许我们回显显示 clean 生命周期各个阶段的文本消息。

我们在 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>
   <build>
      <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-antrun-plugin</artifactId>
            <version>1.1</version>
            <executions>
               <execution>
                  <id>id.pre-clean</id>
                  <phase>pre-clean</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>pre-clean phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.clean</id>
                  <phase>clean</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>clean phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.post-clean</id>
                  <phase>post-clean</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>post-clean phase</echo>
                     </tasks>
                  </configuration>
               </execution>
            </executions>
         </plugin>
      </plugins>
   </build>
</project>

现在，打开命令控制台，转到包含 pom.xml 的文件夹，并执行以下 mvn 命令。

C:\MVN\project>mvn post-clean

Maven 将开始处理并显示 clean 生命周期中的所有阶段。

C:\MVN>mvn post-clean
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.pre-clean) @ project ---
[INFO] Executing tasks
     [echo] pre-clean phase
[INFO] Executed tasks
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ project ---
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.clean) @ project ---
[INFO] Executing tasks
     [echo] clean phase
[INFO] Executed tasks
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.post-clean) @ project ---
[INFO] Executing tasks
     [echo] post-clean phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.740 s
[INFO] Finished at: 2021-12-10T20:03:53+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

您可以尝试调整 mvn clean 命令，该命令将显示 pre-clean 和 clean。没有 post-clean 阶段将被执行。

Default (or Build) Lifecycle

这是 Maven 的主要生命周期，用于构建应用程序。它具有以下 21 个阶段。

Sr.No.	Lifecycle Phase & Description
1	validate 验证项目是否正确，以及是否可以使用完成构建过程所需的所有必要信息。
2	initialize 初始化构建状态，例如设置属性。
3	generate-sources 生成要包括在编译阶段中的所有源代码。
4	process-sources 处理源代码，例如筛选任何值。
5	generate-resources 生成要包含在程序包中的资源。
6	process-resources 将资源复制并处理到目标目录，为打包阶段做好准备。
7	compile 编译项目的源代码。
8	process-classes 后处理从编译中生成的源代码，例如，优化 Java 类中的字节码增强/优化。
9	generate-test-sources 生成要在编译阶段包含的任何测试源代码。
10	process-test-sources 处理测试源代码，例如筛选任何值。
11	test-compile 将测试源代码编译到测试目标目录。
12	process-test-classes 处理从测试代码文件编译中生成的文件。
13	test 使用合适的单元测试框架（Junit 是其中之一）运行测试。
14	prepare-package 在实际打包之前执行为准备程序包所必需的任何操作。
15	package 获取已编译代码，并将其打包为可分发的格式，如 JAR、WAR 或 EAR 文件。
16	pre-integration-test 在执行集成测试之前执行所需的操作。例如，设置所需的测试环境。
17	integration-test 处理和部署程序包（如果需要）到可运行集成测试的环境中。
18	post-integration-test 在执行集成测试后执行所需的操作。例如，清理环境。
19	verify 运行任何检查以验证程序包有效且满足质量标准。
20	install 将程序包安装到本地存储库，该存储库可用作其他项目的本地依赖项。
21	deploy 将最终版本包复制到远程存储库中，以便与其他开发者和项目共享。

以下是几个与 Maven 生命周期相关的概念，值得提及：

当通过 Maven 命令调用某个阶段时，例如 mvn compile ，只会执行该阶段及其之前的阶段。
根据打包类型（JAR/WAR/EAR），不同的 Maven 目标将绑定到 Maven 生命周期不同的阶段。

在以下示例中，我们将 maven-antrun-plugin:run 目标附加到构建生命周期的几个阶段。这将允许我们通过回显文本消息来显示生命周期的阶段。

我们在 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>
   <build>
      <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-antrun-plugin</artifactId>
            <version>1.1</version>
            <executions>
               <execution>
                  <id>id.validate</id>
                  <phase>validate</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>validate phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.compile</id>
                  <phase>compile</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>compile phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.test</id>
                  <phase>test</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>test phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.package</id>
                  <phase>package</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>package phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.deploy</id>
                  <phase>deploy</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>deploy phase</echo>
                     </tasks>
                  </configuration>
               </execution>
            </executions>
         </plugin>
      </plugins>
   </build>
</project>

现在打开命令控制台，转到包含 pom.xml 的文件夹并执行以下 mvn 命令。

C:\MVN\project>mvn compile

Maven 将开始处理并显示构建生命周期中直至编译阶段的阶段。

C:\MVN>mvn compile
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.validate) @ project ---
[INFO] Executing tasks
     [echo] validate phase
[INFO] Executed tasks
[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] skip non existing resourceDirectory C:\MVN\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ project ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (id.compile) @ project ---
[INFO] Executing tasks
     [echo] compile phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  3.033 s
[INFO] Finished at: 2021-12-10T20:05:46+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

Site Lifecycle

Maven Site 插件通常用于创建新文档来创建报告、部署站点等。它具有以下阶段 -

pre-site
site
post-site
site-deploy

在以下示例中，我们将 maven-antrun-plugin:run 目标附加到 Site 生命周期所有阶段。这将允许我们通过回显文本消息来显示生命周期的阶段。

我们在 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>
   <build>
      <plugins>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.7</version>
         </plugin>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-project-info-reports-plugin</artifactId>
            <version>2.9</version>
         </plugin>
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-antrun-plugin</artifactId>
            <version>1.1</version>
            <executions>
               <execution>
                  <id>id.pre-site</id>
                  <phase>pre-site</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>pre-site phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.site</id>
                  <phase>site</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>site phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.post-site</id>
                  <phase>post-site</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>post-site phase</echo>
                     </tasks>
                  </configuration>
               </execution>

               <execution>
                  <id>id.site-deploy</id>
                  <phase>site-deploy</phase>
                  <goals>
                     <goal>run</goal>
                  </goals>
                  <configuration>
                     <tasks>
                        <echo>site-deploy phase</echo>
                     </tasks>
                  </configuration>
               </execution>

            </executions>
         </plugin>
      </plugins>
   </build>
</project>

现在打开命令控制台，转到包含 pom.xml 的文件夹并执行以下 mvn 命令。

C:\MVN\project>mvn site

Maven 将开始处理并显示站点生命周期中直至站点阶段的阶段。

C:\MVN>mvn site
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-antrun-plugin:3.0.0:run (id.pre-site) @ project ---
[INFO] Executing tasks
[WARNING]      [echo] pre-site phase
[INFO] Executed tasks
[INFO]
[INFO] --- maven-site-plugin:3.7:site (default-site) @ project ---
[WARNING] Input file encoding has not been set, using platform encoding Cp1252, i.e. build is platform dependent!
[WARNING] No project URL defined - decoration links will not be relativized!
[INFO] Rendering site with org.apache.maven.skins:maven-default-skin:jar:1.2 skin.
[INFO]
[INFO] --- maven-antrun-plugin:3.0.0:run (id.site) @ project ---
[INFO] Executing tasks
[WARNING]      [echo] site phase
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.323 s
[INFO] Finished at: 2021-12-10T20:22:31+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>