Gradle插件：如何向后兼容替换已弃用的getDependencyProject()？

我在维护一个基于Groovy DSL编写的Gradle插件时遇到了难题：代码中使用了即将在Gradle 9中移除的已弃用方法getDependencyProject()，相关代码如下：

private static List<Project> getAllDependentProjectsExt(Project project, Set<Project> handledProjects) {
    if(handledProjects.contains(project)) return []
    handledProjects << project
    def projectDependencies = project.configurations*.dependencies*.withType(ProjectDependency).flatten() as Set<ProjectDependency>
    List<Project> dependentProjects = projectDependencies*.dependencyProject
    dependentProjects.each {
        dependentProjects += getAllDependentProjectsExt(it, handledProjects)
    }
    return dependentProjects.unique()
}

Gradle升级文档给出的替代方案是：

要访问或配置目标项目，可使用以下直接替代方式：
val projectDependency: ProjectDependency = getSomeProjectDependency()

// 旧方式：
val someProject = projectDependency.dependencyProject

// 新方式：
val someProject = project.project(projectDependency.path)

但问题在于ProjectDependency.path是Gradle 8.11才引入的，而在8.11之前的版本中，获取ProjectDependency路径的唯一方式就是使用已弃用的dependencyProject。我想知道如何在不提升插件最低Gradle版本至8.11的前提下解决这个问题？

可以通过版本兼容性判断+条件调用的方式实现兼容，既支持旧版Gradle（<8.11）继续使用原有逻辑，又在新版Gradle（≥8.11）采用官方推荐的新API，无需提升插件最低版本。

实现思路 #

1. 先判断当前运行的Gradle版本；
2. 针对不同版本分支调用对应的API获取依赖项目；
3. 替换原有代码中直接调用dependencyProject的逻辑。

修改后的代码 #

private static List<Project> getAllDependentProjectsExt(Project project, Set<Project> handledProjects) {
    if(handledProjects.contains(project)) return []
    handledProjects << project
    def projectDependencies = project.configurations*.dependencies*.withType(ProjectDependency).flatten() as Set<ProjectDependency>
    
    // 兼容不同Gradle版本的依赖项目获取逻辑
    List<Project> dependentProjects = projectDependencies.collect { dep ->
        if (GradleVersion.current() >= GradleVersion.version("8.11")) {
            // 新版Gradle使用path属性获取目标项目
            project.project(dep.path)
        } else {
            // 旧版Gradle继续使用弃用的dependencyProject
            dep.dependencyProject
        }
    }
    
    dependentProjects.each {
        dependentProjects += getAllDependentProjectsExt(it, handledProjects)
    }
    return dependentProjects.unique()
}

更灵活的反射兼容方案 #

如果不想硬编码版本号，也可以通过反射检查ProjectDependency是否存在path方法，适配逻辑更通用：

// 封装兼容工具方法
private static Project getDependentProject(Project project, ProjectDependency dep) {
    try {
        // 尝试调用path属性方法
        def pathGetter = dep.class.getMethod("getPath")
        return project.project(pathGetter.invoke(dep))
    } catch (NoSuchMethodException e) {
        // 不存在path方法时，回退到dependencyProject
        return dep.dependencyProject
    }
}

// 主方法中替换调用逻辑
private static List<Project> getAllDependentProjectsExt(Project project, Set<Project> handledProjects) {
    if(handledProjects.contains(project)) return []
    handledProjects << project
    def projectDependencies = project.configurations*.dependencies*.withType(ProjectDependency).flatten() as Set<ProjectDependency>
    
    List<Project> dependentProjects = projectDependencies.collect { dep ->
        getDependentProject(project, dep)
    }
    
    dependentProjects.each {
        dependentProjects += getAllDependentProjectsExt(it, handledProjects)
    }
    return dependentProjects.unique()
}

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