在 Maven 插件中找到主要工件的路径

Question

我正在开发一个 Maven 插件来自动在服务器上安装 JAR。我的第一步应该是找到编译好的 JAR 并将其移动到服务器，但是我如何找到我的 JAR？

我的第一次尝试是：

public class MyMojo extends AbstractMojo {
    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        String workingPath = System.getProperty("user.dir");
        File targetDir = new File(workingPath + File.separatorChar + "target");

        for (File f : targetDir.listFiles()) {
            if (f.isFile() && f.getName().endsWith(".jar") {
                System.out.println("Found jar " + f.getName());
            }
        }
    }
}

但我不想使用固定目录“目标”。有什么方法可以知道 jar 将建在哪里？

Answer 1

您可以使用predefined variablesproject.build.directory、project.build.finalName 和project.packaging 的值来构建存档路径作为插件参数的默认值，例如：

public class MyMojo extends AbstractMojo {

    /**
     * @parameter default-value="${project.build.directory}/${project.build.finalName}.${project.packaging}"
     */
    private String archivePath;

    public void execute() throws MojoExecutionException {
        File archive = new File(archivePath);
        ...
    }
}

Answer 2

是的，执行此操作的简单方法是注入当前正在构建的MavenProject，并检索与其工件对应的文件，由getArtifact() 返回。无论项目的包装是什么（jar、war 等），或者工件的实际生成位置，这都适用。

@Mojo(name = "foo")
public class MyMojo extends AbstractMojo {

    @Parameter(defaultValue = "${project}", readonly = true, required = true)
    private MavenProject project;

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        // this is the main artifact file
        File file = project.getArtifact().getFile();
        getLog().info(file.toString());
    }

}

这声明了名为"foo" 的目标。它被注入值${project}，由PluginParameterExpressionEvaluator评估到当前的Maven项目。

您的 Maven 插件需要依赖于 maven-plugin-annotations（对于 @Parameter 和 @Mojo 注释），以及对于 maven-core 的 MavenProject：

<dependency>
  <groupId>org.apache.maven</groupId>
  <artifactId>maven-core</artifactId>
  <version>3.3.9</version>
</dependency>
<dependency>
  <groupId>org.apache.maven.plugin-tools</groupId>
  <artifactId>maven-plugin-annotations</artifactId>
  <version>3.5</version>
  <scope>provided</scope>
</dependency>

当然，这需要实际构建项目的工件，也就是说插件必须在package阶段之后运行；否则工件没有文件。