开发Jenkins后置构建插件：如何获取Maven根pom文件路径？

嘿，这个问题我刚好有经验！在开发Jenkins后置构建插件时，要获取根pom的位置，其实有几种靠谱的方式，分场景来看：

1. 针对使用Jenkins Maven插件构建的项目（最推荐） #

如果你的项目是通过Jenkins官方的Maven插件（也就是maven-plugin）构建的，那获取根pom简直是小菜一碟。Jenkins的MavenBuild对象直接提供了获取根pom的方法，代码示例如下：

@Override
public void perform(Run<?, ?> run, FilePath workspace, Launcher launcher, TaskListener listener) throws InterruptedException, IOException {
    // 先判断当前构建是否是Maven类型
    if (run instanceof MavenBuild) {
        MavenBuild mavenBuild = (MavenBuild) run;
        File rootPomFile = mavenBuild.getRootPom();
        
        if (rootPomFile != null && rootPomFile.exists()) {
            // 获取根pom的父目录，也就是target所在的目录
            String targetDirPath = new File(rootPomFile.getParent(), "target").getAbsolutePath();
            
            listener.getLogger().println("✅ 找到根Pom位置：" + rootPomFile.getAbsolutePath());
            listener.getLogger().println("✅ Target文件夹路径：" + targetDirPath);
            
            // 接下来就可以遍历target里的报告文件进行合并啦
        } else {
            listener.error("❌ 无法找到有效的根Pom文件！");
        }
    } else {
        listener.warning("⚠️ 当前构建不是Maven插件构建的类型，无法自动获取根Pom位置");
    }
}

注意分布式构建的情况 #

如果你的Jenkins用了agent节点（分布式构建），直接用File对象可能会有路径问题，这时候建议用FilePath来操作远程文件：

if (run instanceof MavenBuild) {
    MavenBuild mavenBuild = (MavenBuild) run;
    // 获取根Pom相对于工作区的路径
    String rootPomRelativePath = mavenBuild.getRootPom().getPath();
    FilePath rootPomFile = workspace.child(rootPomRelativePath);
    
    if (rootPomFile.exists()) {
        FilePath targetDir = rootPomFile.getParent().child("target");
        // 比如列出target下的所有报告文件
        FilePath[] reportFiles = targetDir.list("**/*.xml"); // 假设报告是xml格式
        for (FilePath report : reportFiles) {
            listener.getLogger().println("找到报告文件：" + report.getName());
            // 处理报告逻辑
        }
    }
}

2. 针对非Maven插件构建的项目（比如自由风格执行mvn命令） #

如果用户是在自由风格项目里手动执行mvn命令，那MavenBuild对象就用不了了。这时候最好的方式是在你的插件里加一个配置项，让用户手动指定根Pom相对于工作区的路径（比如pom.xml或者modules/root/pom.xml）。

代码示例（假设你已经定义了插件配置类MergeReportPluginConfig）：

@Override
public void perform(Run<?, ?> run, FilePath workspace, Launcher launcher, TaskListener listener) throws InterruptedException, IOException {
    // 获取插件配置
    MergeReportPluginConfig config = run.getParent().getAction(MergeReportPluginConfig.class);
    if (config == null) {
        listener.error("❌ 请先配置根Pom文件路径！");
        return;
    }
    
    String pomRelativePath = config.getRootPomPath();
    FilePath rootPomFile = workspace.child(pomRelativePath);
    
    if (rootPomFile.exists()) {
        FilePath targetDir = rootPomFile.getParent().child("target");
        // 后续处理逻辑和上面一致
    } else {
        listener.error("❌ 指定的根Pom文件不存在：" + pomRelativePath);
    }
}

3. 尝试从环境变量获取（备选方案） #

有些情况下，Maven构建会自动设置MAVEN_PROJECTBASEDIR环境变量，指向根项目的目录。你可以尝试从构建环境中读取这个变量：

String projectBaseDir = run.getEnvironment(listener).get("MAVEN_PROJECTBASEDIR");
if (projectBaseDir != null) {
    FilePath rootPomFile = workspace.child(projectBaseDir).child("pom.xml");
    // 验证文件存在后继续处理
}

不过这个方式不太稳定，因为不是所有Maven构建都会设置这个变量，所以只建议作为备选。

内容的提问来源于stack exchange，提问作者pavan