Maven生命周期(clean+site+default)

在 Maven 出现之前,项目构建的生命周期就已经存在,开发人员每天都在对项目进行清理,编译,测试及部署,但由于没有统一的规范,不同公司甚至不同项目之间的构建的方式都不尽相同。

Maven 从大量项目和构建工具中学习和反思,最后总结了一套高度完美的,易扩展的生命周期。这个生命周期将项目的清理、初始化、编译、测试、打包、集成测试、验证、部署和站点生成等几乎所有构建过程进行了抽象和统一。

生命周期与插件的关系

Maven 生命周期是抽象的,其本身不能做任何实际工作,这些实际工作(如源代码编译)都通过调用 Maven 插件 中的插件目标(plugin goal)完成的。

为了更好的理解 Maven 生命周期、插件以及插件目标三者的关系,我们可以将 Maven 生命周期理解成一个抽象父类,将插件理解成其子类,将插件目标理解成子类中重写的方法,其基本结构与下面的示例代码相似。

  1. package net.jhelp.www;
  2. /**
  3. * 模拟 maven 生命周期
  4. */
  5. public abstract class LifeCycle {
  6. //定义构建过程
  7. public void build() {
  8. //模拟生命周期各个阶段,即调用插件中目标
  9. clean();
  10. initialize();
  11. compile();
  12. packager();
  13. install();
  14. }
  15. //定义清理的过程
  16. public abstract void clean();
  17. //定义初始化的过程
  18. public abstract void initialize();
  19. //定义编译的过程
  20. public abstract void compile();
  21. //定义打包的过程
  22. public abstract void packager();
  23. //定义安装的过程
  24. public abstract void install();
  25. }

模拟 clean 插件的子类,代码如下。

  1. package net.jhelp.www;
  2. /**
  3. * 子类模拟clean 相关的插件
  4. */
  5. public abstract class CleanPlugin extends LifeCycle {
  6. //重写父类(生命周期)的清理工作
  7. //模拟插件目标
  8. @Override
  9. public void clean() {
  10. System.out.println("清理");
  11. }
  12. }

 

以上示例中,父类 LifeCycle 模拟的是 Maven 生命周期,子类 CleanPlugin 模拟的是 Maven 插件,而子类中重写的 clean() 模拟的是插件目标。

虽然示例中的代码与 Maven 实际代码相去甚远,但它们的基本理念是方法相同的。生命周期抽象了构建的各个步骤,定义了它们的执行顺序,但却没有提供具体的实现。插件中完成了对构建过程的实现,想要完成某个构建步骤,调用插件中的一个或多个插件目标即可。

生命周期中的每个构建过程都可以绑定一个或多个插件目标,且 Maven 为大多数的构建步骤都绑定了默认的插件。例如,针对源代码编译的插件是 maven-compiler-plugin、针对集成测试的插件是 maven-surefire-plugin 等。

注意:Maven 插件和插件目标了解即可,在本教程后面的章节 Maven 插件中会详细介绍。

三套生命周期

Maven 拥有三套标准的生命周期:

  • clean:用于清理项目
  • default:用于构建项目
  • site:用于建立项目站点

构建阶段

每套生命周期包含一系列的构建阶段(phase),这些阶段是有顺序的,且后面的阶段依赖于前面的阶段。用户与 Maven 最直接的交互方式就是调用这些生命周期阶段。以 clean 生命周期为例,它包含 pre-clean、clean 以及 post-clean 三个阶段,当用户调用 pre-clean 阶段时,则只有 pre-clean 阶段执行;当用户调用 clean 阶段时,pre-clean 和 clean 阶段都会执行。当用户调用 post-clean 阶段时,则 pre-clean、clean 以及 post-clean 三个阶段都会执行。

通过将阶段名传递给 mvn 命令,就可以调用构建阶段,例如:

  • mvn install

生命周期的独立性

与构建阶段的前后依赖关系不同,三套生命周期本身是相互独立的,用户可以只调用 clean 生命周期的某个阶段,也可以只调用 default 生命周期的某个阶段,而不会对其他生命周期造成任何影响。 

clean 生命周期

 clean 生命周期包括以下 3 个阶段。

  • pre-clean(清理前)
  • clean(清理)
  • post-clean(清理后)

我们可以通过在 clean 生命周期的各个阶段定义目标来修改这部分的操作行为。

示例 1

下面我们将 maven-antrun-plugin 插件的 run 目标绑定到 pre-clean、clean 和 post-clean 三个阶段中,以实现在 clean 生命周期的各个阶段中显示自定义文本信息,pom.xml 配置如下:

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <groupId>net.jhelp.www</groupId>
  6. <artifactId>maven</artifactId>
  7. <version>0.0.1-SNAPSHOT</version>
  8. <dependencies>
  9. <!-- junit依赖 -->
  10. <dependency>
  11. <groupId>junit</groupId>
  12. <artifactId>junit</artifactId>
  13. <version>4.9</version>
  14. <scope>compile</scope>
  15. </dependency>
  16. <!-- log4j依赖 -->
  17. <dependency>
  18. <groupId>log4j</groupId>
  19. <artifactId>log4j</artifactId>
  20. <version>1.2.17</version>
  21. </dependency>
  22. </dependencies>
  23. <build>
  24. <plugins>
  25. <!-- 添加插件 maven-antrun-plugin -->
  26. <plugin>
  27. <groupId>org.apache.maven.plugins</groupId>
  28. <artifactId>maven-antrun-plugin</artifactId>
  29. <version>1.1</version>
  30. <executions>
  31. <execution>
  32. <!--自定义阶段 id -->
  33. <id>www.jhelp.net pre-clean</id>
  34. <!--阶段 -->
  35. <phase>pre-clean</phase>
  36. <!--目标 -->
  37. <goals>
  38. <goal>run</goal>
  39. </goals>
  40. <!--配置 -->
  41. <configuration>
  42. <!-- 执行的任务 -->
  43. <tasks>
  44. <!-- 输出自定义文本信息 -->
  45. <echo>预清理阶段,欢迎您的到来,网址:www.jhelp.net</echo>
  46. </tasks>
  47. </configuration>
  48. </execution>
  49. <execution>
  50. <!--自定义阶段 id -->
  51. <id>www.jhelp.net clean</id>
  52. <!--阶段 -->
  53. <phase>clean</phase>
  54. <!--目标 -->
  55. <goals>
  56. <goal>run</goal>
  57. </goals>
  58. <!--配置 -->
  59. <configuration>
  60. <!-- 执行的任务 -->
  61. <tasks>
  62. <!--自定义文本信息 -->
  63. <echo>清理阶段,欢迎您的到来,网址:www.jhelp.net</echo>
  64. </tasks>
  65. </configuration>
  66. </execution>
  67. <execution>
  68. <!--自定义阶段 id -->
  69. <id>www.jhelp.net post-clean</id>
  70. <!--阶段 -->
  71. <phase>post-clean</phase>
  72. <!-- 目标 -->
  73. <goals>
  74. <goal>run</goal>
  75. </goals>
  76. <!--配置 -->
  77. <configuration>
  78. <!-- 执行的任务 -->
  79. <tasks>
  80. <!-- 执行的任务 -->
  81. <echo>后清理阶段,欢迎您的到来,网址:www.jhelp.net</echo>
  82. </tasks>
  83. </configuration>
  84. </execution>
  85. </executions>
  86. </plugin>
  87. </plugins>
  88. </build>
  89. </project>

打开命令行窗口,跳转到 pom.xml 所在的目录,执行命令mvn post-clean,结果如下。

  • [INFO] Scanning for projects...
  • [INFO]
  • [INFO] ----------------------< net.jhelp.www:maven >-----------------------
  • [INFO] Building maven 0.0.1-SNAPSHOT
  • [INFO] --------------------------------[ jar ]---------------------------------
  • [INFO]
  • [INFO] --- maven-antrun-plugin:1.1:run (www.biancheng.net pre-clean) @ maven ---
  • [INFO] Executing tasks
  • [echo] 预清理阶段,欢迎您的到来,网址:www.jhelp.net
  • [INFO] Executed tasks
  • [INFO]
  • [INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ maven ---
  • [INFO]
  • [INFO] --- maven-antrun-plugin:1.1:run (www.biancheng.net clean) @ maven ---
  • [INFO] Executing tasks
  • [echo] 清理阶段,欢迎您的到来,网址:www.jhelp.net
  • [INFO] Executed tasks
  • [INFO]
  • [INFO] --- maven-antrun-plugin:1.1:run (www.biancheng.net post-clean) @ maven ---
  • [INFO] Executing tasks
  • [echo] 后清理阶段 欢迎您的到来,网址:www.jhelp.net
  • [INFO] Executed tasks
  • [INFO] ------------------------------------------------------------------------
  • [INFO] BUILD SUCCESS
  • [INFO] ------------------------------------------------------------------------
  • [INFO] Total time: 0.365 s
  • [INFO] Finished at: 2021-03-01T13:25:07+08:00
  • [INFO] ------------------------------------------------------------------------

default 生命周期

default 生命周期定义了项目真正构建时所需要的所有步骤,它是所有生命周期中最核心,最重要的部分。

default 生命周期包含非常多的阶段,如下表。

阶段描述
validate验证项目是否正确以及所有必要信息是否可用。
initialize初始化构建状态。
generate-sources生成编译阶段需要的所有源码文件。
process-sources处理源码文件,例如过滤某些值。
generate-resources生成项目打包阶段需要的资源文件。
process-resources处理资源文件,并复制到输出目录,为打包阶段做准备。
compile编译源代码,并移动到输出目录。
process-classes处理编译生成的字节码文件
generate-test-sources生成编译阶段需要的测试源代码。
process-test-sources处理测试资源,并复制到测试输出目录。
test-compile编译测试源代码并移动到测试输出目录中。
test使用适当的单元测试框架(例如 JUnit)运行测试。
prepare-package在真正打包之前,执行一些必要的操作。
package获取编译后的代码,并按照可发布的格式进行打包,例如 JAR、WAR 或者 EAR 文件。
pre-integration-test在集成测试执行之前,执行所需的操作,例如设置环境变量。
integration-test处理和部署所需的包到集成测试能够运行的环境中。
post-integration-test在集成测试被执行后执行必要的操作,例如清理环境。
verify对集成测试的结果进行检查,以保证质量达标。
install安装打包的项目到本地仓库,以供其他项目使用。
deploy拷贝最终的包文件到远程仓库中,以共享给其他开发人员和项目。

示例 2

将 maven-antrun-plugin 插件的 run 目标绑定 default 生命周期的部分阶段中,以实现在 default 生命周期的特定阶段中显示定义文本信息。

更新 D:\maven 文件夹中的 pom.xml 文件,内容如下。

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <groupId>net.jhelp.www</groupId>
  6. <artifactId>maven</artifactId>
  7. <version>0.0.1-SNAPSHOT</version>
  8. <dependencies>
  9. <!-- junit依赖 -->
  10. <dependency>
  11. <groupId>junit</groupId>
  12. <artifactId>junit</artifactId>
  13. <version>4.9</version>
  14. <scope>compile</scope>
  15. </dependency>
  16. <!-- log4j依赖 -->
  17. <dependency>
  18. <groupId>log4j</groupId>
  19. <artifactId>log4j</artifactId>
  20. <version>1.2.17</version>
  21. </dependency>
  22. </dependencies>
  23. <build>
  24. <plugins>
  25. <!-- 添加插件 maven-antrun-plugin -->
  26. <plugin>
  27. <groupId>org.apache.maven.plugins</groupId>
  28. <artifactId>maven-antrun-plugin</artifactId>
  29. <version>1.1</version>
  30. <executions>
  31. <execution>
  32. <id>www.jhelp.net validate</id>
  33. <phase>validate</phase>
  34. <goals>
  35. <goal>run</goal>
  36. </goals>
  37. <configuration>
  38. <tasks>
  39. <echo>欢迎您的到来,网址:www.jhelp.net 验证阶段……</echo>
  40. </tasks>
  41. </configuration>
  42. </execution>
  43. <execution>
  44. <id>www.jhelp.net compile</id>
  45. <phase>compile</phase>
  46. <goals>
  47. <goal>run</goal>
  48. </goals>
  49. <configuration>
  50. <tasks>
  51. <echo>欢迎您的到来,网址:www.jhelp.net 编译阶段……</echo>
  52. </tasks>
  53. </configuration>
  54. </execution>
  55. <execution>
  56. <id>www.jhelp.net test</id>
  57. <phase>test</phase>
  58. <goals>
  59. <goal>run</goal>
  60. </goals>
  61. <configuration>
  62. <tasks>
  63. <echo>欢迎您的到来,网址:www.jhelp.net 测试阶段……</echo>
  64. </tasks>
  65. </configuration>
  66. </execution>
  67. <execution>
  68. <id>www.jhelp.net package</id>
  69. <phase>package</phase>
  70. <goals>
  71. <goal>run</goal>
  72. </goals>
  73. <configuration>
  74. <tasks>
  75. <echo>欢迎您的到来,网址:www.jhelp.net 打包阶段……</echo>
  76. </tasks>
  77. </configuration>
  78. </execution>
  79. <execution>
  80. <id>www.jhelp.net deploy</id>
  81. <phase>deploy</phase>
  82. <goals>
  83. <goal>run</goal>
  84. </goals>
  85. <configuration>
  86. <tasks>
  87. <echo>欢迎您的到来,网址:www.jhelp.net 部署阶段……</echo>
  88. </tasks>
  89. </configuration>
  90. </execution>
  91. </executions>
  92. </plugin>
  93. </plugins>
  94. </build>
  95. </project>

打开命令行窗口,跳转到 pom.xml 所在的目录,执行命令:D:\maven>mvn compile,结果如下。

  • [INFO] Scanning for projects...
  • [INFO]
  • [INFO] ----------------------< net.jhelp.www:maven >-----------------------
  • [INFO] Building maven 0.0.1-SNAPSHOT
  • [INFO] --------------------------------[ jar ]---------------------------------
  • [INFO]
  • [INFO] --- maven-antrun-plugin:1.1:run (www.jhelp.net validate) @ maven ---
  • [INFO] Executing tasks
  • [echo] 欢迎您的到来,网址:www.jhelp.net 验证阶段……
  • [INFO] Executed tasks
  • [INFO]
  • [INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ maven ---
  • [WARNING] Using platform encoding (GBK actually) to copy filtered resources, i.e. build is platform dependent!
  • [INFO] skip non existing resourceDirectory D:\maven\src\main\resources
  • [INFO]
  • [INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ maven ---
  • [INFO] No sources to compile
  • [INFO]
  • [INFO] --- maven-antrun-plugin:1.1:run (www.jhelp.net compile) @ maven ---
  • [INFO] Executing tasks
  • [echo] 欢迎您的到来,网址:www.jhelp.net 编译阶段……
  • [INFO] Executed tasks
  • [INFO] ------------------------------------------------------------------------
  • [INFO] BUILD SUCCESS
  • [INFO] ------------------------------------------------------------------------
  • [INFO] Total time: 0.652 s
  • [INFO] Finished at: 2021-03-01T15:07:50+08:00
  • [INFO] ------------------------------------------------------------------------

site 生命周期

sit 生命周期的目的是建立和部署项目站点,Maven 能够根据 POM 包含的信息,自动生成一个友好的站点,该站点包含一些与该项目相关的文档。

site 生命周期包含以下 4 个阶段:

  • pre-site
  • site
  • post-site
  • site-deploy

下面我们将 maven-antrun-plugin 插件的 run 目标绑定到 site 生命周期的所有阶段中,以实现在该生命周期各个阶段显示自定义文本信息。

更新 D:\maven 目录下的 pom.xml 文件,内容如下。

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <groupId>net.jhelp.www</groupId>
  6. <artifactId>maven</artifactId>
  7. <version>0.0.1-SNAPSHOT</version>
  8. <dependencies>
  9. <!-- junit依赖 -->
  10. <dependency>
  11. <groupId>junit</groupId>
  12. <artifactId>junit</artifactId>
  13. <version>4.9</version>
  14. <scope>compile</scope>
  15. </dependency>
  16. <!-- log4j依赖 -->
  17. <dependency>
  18. <groupId>log4j</groupId>
  19. <artifactId>log4j</artifactId>
  20. <version>1.2.17</version>
  21. </dependency>
  22. </dependencies>
  23. <build>
  24. <plugins>
  25. <plugin>
  26. <groupId>org.apache.maven.plugins</groupId>
  27. <artifactId>maven-site-plugin</artifactId>
  28. <version>3.7.1</version>
  29. </plugin>
  30. <plugin>
  31. <groupId>org.apache.maven.plugins</groupId>
  32. <artifactId>maven-project-info-reports-plugin</artifactId>
  33. <version>3.0.0</version>
  34. </plugin>
  35. <!-- 添加插件 maven-antrun-plugin -->
  36. <plugin>
  37. <groupId>org.apache.maven.plugins</groupId>
  38. <artifactId>maven-antrun-plugin</artifactId>
  39. <version>1.3</version>
  40. <executions>
  41. <execution>
  42. <id>www.jhelp.net pre-site</id>
  43. <phase>pre-site</phase>
  44. <goals>
  45. <goal>run</goal>
  46. </goals>
  47. <configuration>
  48. <tasks>
  49. <echo>欢迎您的到来,网址:www.jhelp.net pre-site 阶段……</echo>
  50. </tasks>
  51. </configuration>
  52. </execution>
  53. <execution>
  54. <id>www.jhelp.net site</id>
  55. <phase>site</phase>
  56. <goals>
  57. <goal>run</goal>
  58. </goals>
  59. <configuration>
  60. <tasks>
  61. <echo>欢迎您的到来,网址:www.jhelp.net site 阶段……</echo>
  62. </tasks>
  63. </configuration>
  64. </execution>
  65. <execution>
  66. <id>www.jhelp.net post-site</id>
  67. <phase>post-site</phase>
  68. <goals>
  69. <goal>run</goal>
  70. </goals>
  71. <configuration>
  72. <tasks>
  73. <echo>欢迎您的到来,网址:www.jhelp.net post-site 阶段……</echo>
  74. </tasks>
  75. </configuration>
  76. </execution>
  77. <execution>
  78. <id>www.jhelp.net site-deploy</id>
  79. <phase>site-deploy</phase>
  80. <goals>
  81. <goal>run</goal>
  82. </goals>
  83. <configuration>
  84. <tasks>
  85. <echo>欢迎您的到来,网址:www.jhelp.net site-deploy 阶段……</echo>
  86. </tasks>
  87. </configuration>
  88. </execution>
  89. </executions>
  90. </plugin>
  91. </plugins>
  92. </build>
  93. </project>

打开命令行窗口,跳转到 pom.xml 所在的目录,执行 mvn 命令:mvn post-site,结果如下。

  • [INFO] Scanning for projects...
  • [INFO]
  • [INFO] ----------------------< net.jhelp.www:maven >-----------------------
  • [INFO] Building maven 0.0.1-SNAPSHOT
  • [INFO] --------------------------------[ jar ]---------------------------------
  • [INFO]
  • [INFO] --- maven-antrun-plugin:1.3:run (www.jhelp.net pre-site) @ maven ---
  • [INFO] Executing tasks
  • [echo] 欢迎您的到来,网址:www.jhelp.net pre-site 阶段……
  • [INFO] Executed tasks
  • [INFO]
  • [INFO] --- maven-site-plugin:3.7.1:site (default-site) @ maven ---
  • [WARNING] Input file encoding has not been set, using platform encoding GBK, i.e. build is platform dependent!
  • [INFO] configuring report plugin org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0
  • [INFO] 15 reports detected for maven-project-info-reports-plugin:3.0.0: ci-management, dependencies, dependency-info, dependency-management, distribution-management, index, issue-management, licenses, mailing-lists, modules, plugin-management, plugins, scm, summary, team
  • [INFO] Rendering site with default locale English (en)
  • [WARNING] No project URL defined - decoration links will not be relativized!
  • [INFO] Rendering content with org.apache.maven.skins:maven-default-skin:jar:1.2 skin.
  • [INFO] Generating "Dependencies" report --- maven-project-info-reports-plugin:3.0.0:dependencies
  • [INFO] Generating "Dependency Information" report --- maven-project-info-reports-plugin:3.0.0:dependency-info
  • [INFO] Generating "About" report --- maven-project-info-reports-plugin:3.0.0:index
  • [INFO] Generating "Plugin Management" report --- maven-project-info-reports-plugin:3.0.0:plugin-management
  • [INFO] Generating "Plugins" report --- maven-project-info-reports-plugin:3.0.0:plugins
  • [INFO] Generating "Summary" report --- maven-project-info-reports-plugin:3.0.0:summary
  • [INFO]
  • [INFO] --- maven-antrun-plugin:1.3:run (www.jhelp.net site) @ maven ---
  • [INFO] Executing tasks
  • [echo] 欢迎您的到来,网址:www.jhelp.net site 阶段……
  • [INFO] Executed tasks
  • [INFO]
  • [INFO] --- maven-antrun-plugin:1.3:run (www.jhelp.net post-site) @ maven ---
  • [INFO] Executing tasks
  • [echo] 欢迎您的到来,网址:www.jhelp.net post-site 阶段……
  • [INFO] Executed tasks
  • [INFO] ------------------------------------------------------------------------
  • [INFO] BUILD SUCCESS
  • [INFO] ------------------------------------------------------------------------
  • [INFO] Total time: 2.824 s
  • [INFO] Finished at: 2021-03-01T16:02:44+08:00
  • [INFO] ------------------------------------------------------------------------
腾讯云推出云产品限时特惠抢购活动:2C2G云服务器7.9元/月起
本文链接:https://www.jhelp.net/p/ZsKDzOX05KIOGkDh (转载请保留)。
关注下面的标签,发现更多相似文章