你如何强制一个 maven MOJO 在构建结束时只执行一次？

Question

我有一个 MOJO，我想执行一次，并且仅在反应堆中最后一个项目的测试阶段之后运行一次。

使用：

if (!getProject().isExecutionRoot()) {
        return ;
}

在 execute() 方法的开头意味着我的 mojo 被执行一次，但是在构建的最开始 - 在所有其他子模块之前。

Answer 1

我为此找到的最佳解决方案是：

/**
 * The projects in the reactor.
 *
 * @parameter expression="${reactorProjects}"
 * @readonly
 */
private List reactorProjects;

public void execute() throws MojoExecutionException {

    // only execute this mojo once, on the very last project in the reactor
    final int size = reactorProjects.size();
    MavenProject lastProject = (MavenProject) reactorProjects.get(size - 1);
    if (lastProject != getProject()) {
        return;
    }
   // do work
   ...
}

这似乎适用于我测试过的小型构建层次结构。

Answer 2

最好的解决方案是依赖生命周期扩展，方法是从 org.apache.maven.AbstractMavenLifecycleParticipant 扩展您的类（另请参阅 https://maven.apache.org/examples/maven-3-lifecycle-extensions.html），该类添加了一个方法 afterSessionEnd 和 https://issues.apache.org/jira/browse/MNG-5640（在 Maven 3.2.2 中修复）。

Answer 3

有一个Sonatype blog entry 描述了如何执行此操作。最后一个要运行的项目将是根项目，因为它将包含对其余项目的模块引用。因此，您需要在 mojo 中进行测试，以检查当前项目的目录是否与启动 Maven 的目录相同：

boolean result = mavenSession.getExecutionRootDirectory().equalsIgnoreCase(basedir.toString());

在引用的条目中有一个非常全面的示例，说明如何在你的 mojo 中使用它。

Answer 4

如果您使用 @aggregator 标签并将您的 mojo 绑定到以下生命周期阶段之一，我认为您可能会得到您需要的东西：

• 准备包
• 包
• 预集成测试
• 集成测试
• 集成后测试
• 验证
• 安装
• 部署

Answer 5

使用 session.getEventDispatcher() 的解决方案自 Maven 3.x 起不再有效。整个事件已在此提交中删除：https://github.com/apache/maven/commit/505423e666b9a8814e1c1aa5d50f4e73b8d710f4

Answer 6

查看maven-monitor API

您可以将 EventMonitor 添加到调度程序，然后捕获“reactor-execute”事件的 END：这会在一切完成后调度，即即使在您看到 BUILD SUCCESSFUL/FAILED 输出之后。

这是我最近使用它在最后打印摘要的方式：

/**
 * The Maven Project Object
 *
 * @parameter expression="${project}"
 * @required
 * @readonly
 */
protected MavenProject project;


/**
 * The Maven Session.
 *
 * @parameter expression="${session}"
 * @required
 * @readonly
 */
protected MavenSession session;

...


@Override
public void execute() throws MojoExecutionException, MojoFailureException
{
    //Register the event handler right at the start only
    if (project.isExecutionRoot())
        registerEventMonitor();
    ...
}


/**
 * Register an {@link EventMonitor} with Maven so that we can respond to certain lifecycle events
 */
protected void registerEventMonitor()
{
    session.getEventDispatcher().addEventMonitor(
            new EventMonitor() {

                @Override
                public void endEvent(String eventName, String target, long arg2) {
                    if (eventName.equals("reactor-execute"))
                        printSummary();
                }

                @Override
                public void startEvent(String eventName, String target, long arg2) {}

                @Override
                public void errorEvent(String eventName, String target, long arg2, Throwable arg3) {}


            }
    );
}


/**
 * Print summary at end
 */
protected void printSummary()
{
    ...
}

Answer 7

你可以使用mavensession来解决这个问题

public boolean isThisTheLastProject() {
        return session.getProjectDependencyGraph().getSortedProjects().
                get(session.getProjectDependencyGraph().getSortedProjects().size()-1).getArtifactId().equalsIgnoreCase(project.getArtifactId());
    }

Answer 8

通常，这是配置问题。您可能必须为 mojo 设置一个项目，并使其依赖于所有其他项目。或者，您可以通过使其依赖于所有其他子项目来强制其中一个子项目位于最后。