Gradle多模块项目开发环境本地Jar依赖替换方案咨询

问题背景 #

我正在开发一个Gradle多子项目工程，根build.gradle中声明了部分仅能从GitLab环境获取的私有项目依赖。开发环境下需要将这些私有依赖替换为本地目录下的Jar包，但手动修改构建文件不仅繁琐，还容易误提交到版本库，分支切换也很麻烦。希望通过设置环境变量env=dev实现自动切换，无需手动修改Gradle配置。

当前根项目构建配置大致如下：

subprojects {
    apply plugin: 'java'
    compileJava.options.encoding = 'UTF-8'

    dependencies {
        compileOnly "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"
        compileOnly "GroupName:ModuleB:${rootProject.ext.moduleBVersion}"
        testCompile "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"

        // 其他无问题的依赖...
    }

    tasks.withType(Ear) {
        dependencies {
            earlib "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"
            // 其他无问题的依赖...
        }
        ear {
            baseName "some valid name"
        }
    }
}

开发环境需要替换的逻辑为：

def sdkJars = fileTree(dir: "${rootProject.rootDir}\\BuildFiles")
compileOnly sdkJars
testCompile sdkJars

解决方案 #

方案一：使用依赖替换机制（resolutionStrategy） #

补全你尝试的依赖替换逻辑，通过Gradle的依赖替换功能，在dev环境下自动将指定私有依赖替换为本地Jar文件树：

subprojects {
    // 判断是否为开发环境：支持系统环境变量或Gradle参数传入
    def isDevEnv = System.getenv("env") == "dev" || (project.hasProperty("env") && project.getProperty("env") == "dev")

    configurations.all {
        resolutionStrategy.dependencySubstitution.all { DependencySubstitution dependency ->
            if (isDevEnv) {
                if (dependency.requested instanceof ModuleComponentSelector) {
                    def requested = dependency.requested
                    // 匹配指定Group下的所有私有模块
                    if (requested.group == "GroupName") {
                        // 替换为本地BuildFiles目录下的所有Jar包
                        def localJars = fileTree(dir: "${rootProject.rootDir}/BuildFiles", include: "*.jar")
                        dependency.useTarget(files(localJars))
                    }
                }
            }
        }
    }

    // 原有配置保持不变
    apply plugin: 'java'
    compileJava.options.encoding = 'UTF-8'

    dependencies {
        compileOnly "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"
        compileOnly "GroupName:ModuleB:${rootProject.ext.moduleBVersion}"
        testCompile "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"

        // 其他无问题的依赖...
    }

    tasks.withType(Ear) {
        dependencies {
            earlib "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"
            // 其他无问题的依赖...
        }
        ear {
            baseName "some valid name"
        }
    }
}

方案二：条件式声明依赖（更直观易维护） #

直接在dependencies块中根据环境条件切换远程依赖和本地Jar，逻辑更清晰：

subprojects {
    def isDevEnv = System.getenv("env") == "dev" || (project.hasProperty("env") && project.getProperty("env") == "dev")
    def sdkJars = fileTree(dir: "${rootProject.rootDir}/BuildFiles", include: "*.jar")

    apply plugin: 'java'
    compileJava.options.encoding = 'UTF-8'

    dependencies {
        if (isDevEnv) {
            // 开发环境使用本地Jar
            compileOnly sdkJars
            testCompile sdkJars
        } else {
            // 非开发环境使用远程私有依赖
            compileOnly "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"
            compileOnly "GroupName:ModuleB:${rootProject.ext.moduleBVersion}"
            testCompile "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"
        }

        // 其他无问题的依赖...
    }

    tasks.withType(Ear) {
        dependencies {
            if (isDevEnv) {
                earlib sdkJars
            } else {
                earlib "GroupName:ModuleA:${rootProject.ext.moduleAVersion}"
            }
            // 其他无问题的依赖...
        }
        ear {
            baseName "some valid name"
        }
    }
}

使用方式 #

启动构建时通过以下方式触发开发环境模式：

1. 系统环境变量：

   # Windows
   set env=dev
   gradle build
   
   # Linux/Mac
   env=dev gradle build
   

2. Gradle命令行参数：

   gradle build -Penv=dev
   

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