构建与依赖 / 系统课时

插件目标绑定到生命周期

插件目标绑定到生命周期

这一课解决两个实际问题:怎样让插件目标在指定生命周期阶段自动执行,以及多个 execution 同时存在时如何判断先后。完成后你能直接从 POM 和构建日志确认绑定顺序,不再靠反复试跑猜结果。

学习目标

  • 用 <executions>、<phase> 和 <goals> 把插件目标绑定到生命周期。
  • 判断不同阶段与同一阶段内多个执行的先后关系。
  • 用构建日志验证绑定是否生效,并避免继承配置造成顺序误判。

execution 决定何时运行哪个目标

一个插件可以声明多个 <execution>。其中 id 用来区分执行实例,phase 决定它挂到哪个生命周期阶段,goals 决定该阶段真正调用插件的哪个目标,configuration 则可以为某次执行单独提供参数。

例如把资源生成任务放到 generate-resources,Maven 执行到该阶段时就会自动调用目标;如果只在 <plugins> 中声明插件,却既没有生命周期绑定,也没有目标的默认阶段,它不会因为“出现在 POM 里”就自动运行。

用三个 execution 观察真实顺序

片段示例:把下面插件加入已有项目的 <build><plugins>。AntRun 这里只负责打印标记,便于观察生命周期,不建议把大型业务构建长期写成 Ant 任务。

xml
<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-antrun-plugin</artifactId>
  <version>3.2.0</version>
  <executions>
    <execution>
      <id>prepare-a</id>
      <phase>generate-resources</phase>
      <goals>
        <goal>run</goal>
      </goals>
      <configuration>
        <target>
          <echo message="[order] A generate-resources"/>
        </target>
      </configuration>
    </execution>

    <execution>
      <id>prepare-b</id>
      <phase>generate-resources</phase>
      <goals>
        <goal>run</goal>
      </goals>
      <configuration>
        <target>
          <echo message="[order] B generate-resources"/>
        </target>
      </configuration>
    </execution>

    <execution>
      <id>process-c</id>
      <phase>process-resources</phase>
      <goals>
        <goal>run</goal>
      </goals>
      <configuration>
        <target>
          <echo message="[order] C process-resources"/>
        </target>
      </configuration>
    </execution>
  </executions>
</plugin>

prepare-a 与 prepare-b 绑定同一阶段,按 POM 中声明顺序执行;process-c 绑定到更晚的 process-resources,因此无论把它写在 XML 的前面还是后面,都要等 generate-resources 完成后才会运行。

多个执行的排序规则

判断顺序时按下面三层检查,不要只看 XML 上下位置。

  1. 先看生命周期阶段。generate-resources 一定早于 process-resources,test 早于 package,package 早于 verify。
  2. 再看同一阶段。Maven 3 中,同一插件配置在同一阶段的多个 POM 执行按声明顺序运行;生命周期由 packaging 自带的绑定会先于 POM 额外绑定的目标。
  3. 最后看继承与 Profile。父 POM、子 POM 和激活的 Profile 会共同形成有效 POM;不同 id 的执行可能合并进来,所以排错时应以有效 POM 为准,而不是只看当前文件。

Maven 4 还支持在阶段名后使用优先级,例如 test[100] 与 test[200],数值更大的更晚执行。这是 Maven 4 的能力;需要兼容 Maven 3 的项目不要使用这种写法。对关键构建依赖,优先分配到前后明确的不同生命周期阶段,通常比依赖同阶段声明顺序更稳妥。

运行构建并核对绑定

执行到 process-resources 即可覆盖上面三个执行:

bash
mvn process-resources

预期结果中,相关日志应按 A、B、C 的顺序出现;下面只摘录关键行,项目名会显示为实际的 <ID>:

text
[INFO] --- antrun:3.2.0:run (prepare-a) @ <ID> ---
[echo] [order] A generate-resources
[INFO] --- antrun:3.2.0:run (prepare-b) @ <ID> ---
[echo] [order] B generate-resources
[INFO] --- antrun:3.2.0:run (process-c) @ <ID> ---
[echo] [order] C process-resources
[INFO] BUILD SUCCESS

如果某个执行没有出现,优先检查 phase 拼写、goals 是否包含真实目标,以及当前命令是否真正走到了该阶段。配置来自父 POM 或 Profile 时,可通过 Help Plugin 的 effective-pom 目标查看合并后的结果,再按最终的 <executions> 判断实际绑定。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

插件目标绑定到生命周期

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通