相对于Gradle子项目的依赖关系,它们也可以独立构建

时间:2018-04-27 02:29:59

标签: java gradle dependencies build.gradle legacy

背景

我继承了一个旧的,极其复杂的基于Gradle的Java项目,该项目包含许多子项目。其中许多都有闭源*.jar库,它们不应泄漏到其他(子)项目,以避免在多个项目使用不同版本的"相同的"库。

我试图更新项目以使用其中一些库的某些新版本,并且通常会清理依赖项,因为开发变得非常复杂。 更糟糕的是,一个项目被嵌套为Git submodule,它应该能够独立构建作为我正在工作的主要Gradle项目的子项目用。

Git子模块

这是一个类似于Git子模块/ Gradle项目/ Gradle子项目的简化结构:

robotcontroller
+--.git
+--gradle
+--libs
+--planning
|  +--src
|  +--build.gradle
+--plugins
|  +--nao
|  |  +--libs
|  |  |  +--robocommons.jar
|  |  +--src
|  |  +--build.gradle
|  +--pepper
|  |  +--libs
|  |  |  +--graphadapter.jar
|  |  +--src
|  |  +--build.gradle
+--build.gradle
+--gradlew
+--gradlew.bat
+--settings.gradle

plugins/nao/build.gradle

dependencies {
    compile project(':planning')
    // This is inside the subproject's "libs/" dir
    compile name: 'robocommons'
    compile group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.3'
}

[rootProject, this].each {
    it.repositories {
        flatDir {
            dirs "${rootDir}/plugins/nao/libs/"
        }
    }
}

plugins/pepper/build.gradle

dependencies {
    compile project(':planning')
    // This is inside the subproject's "libs/" dir
    compile name: 'graphadapter'
    compile group: 'com.google.guava', name: 'guava', version: '19.0'
}

[rootProject, this].each {
    it.repositories {
        maven {
            // Some proprietary, closed-source repo
        }
        flatDir {
            dirs "${rootDir}/plugins/pepper/libs/"
        }
    }
}   

plugins/build.gradle

dependencies {
    compile project(':plugins:nao')
    compile project(':plugins:pepper')
}

build.gradle

// Stuff like plugins here
...

allprojects {
  repositories {
    flatDir {
      dirs "${rootDir}/libs"
    }
    jcenter()

    maven {
        // Some other proprietary repo here
    }
  }

  dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.12'
  }
}

dependencies {
    compile subprojects
}

// Stuff like javadoc and sourceJar tasks
...

settings.gradle

include 'planning'
include 'plugins'
include 'plugins:nao'
include 'plugins:pepper'

" root" Git存储库

Gradle项目及其上面的所有子项目不仅需要能够自己构建,而且项目本身就是另一个Gradle项目的子项目,该项目位于不同的Git存储库中: / p>

complicatedrobotproject
+--.git
+--gradle
+--robotcontroller@SOMEREVISION // This is managed by the ".gitmodules" file
+--robocommons // A different, partially-compatible version of the source code used to make "robocommons.jar" is here
|  +--src
|  +--build.gradle
+--.gitmodules
+--build.gradle
+--gradlew
+--gradlew.bat
+--settings.gradle

build.gradle

allprojects {
    repositories {
        flatDir {
            dirs "${rootDir}/robotcontroller/libs"
        }
    }
}

dependencies {
    // some external dependencies
    ...
    compile project(":robotcontroller")
    compile project(":robocommons")

    // TEST
    testCompile group: 'junit', name: 'junit', version: '4.12'
}

settings.gradle

include 'robocommons'
include 'robotcontroller:planning'
include 'robotcontroller:plugins'
include 'robotcontroller:plugins:nao'
include 'robotcontroller:plugins:pepper'

问题

在上面的示例中,我的直接目标是将complicatedrobotproject/robocommons中找到的源代码替换为robocommons.jar。但是,构建项目的唯一方法是使用Git子模块robotcontroller的修改版本,实际上取决于:

来自修订版robotcontroller/plugins/nao/build.gradle

SOMEREVISION

dependencies {
    compile name ':robocommons' // When building "complicatedrobotproject", this in fact links "robocommons" the directory, not "robocommons.jar"!
    compile project(':robotcontroller:planning')
    compile group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.3'
}

通过向依赖项添加:robotcontroller,可以构建项目complicatedrobotproject,但不能将robotcontroller构建为独立的Gradle项目。采用该限定符然后使后者可以牺牲前者为代价。 robocommons.jar中出现的同样存在于目录robocommons中的类大部分但不完全等效。最后,我想将两者替换为适当的外部依赖关系,例如compile group: 'com.complicatedrobots', name: 'robocommons', version: '2.0.3',但这需要大量的重新实现,我首先要解决这种依赖性的噩梦。

我的任务不是让项目有意义;尽管这让我头疼,我只需要两个Git存储库都可以构建,并且在所有Gradle项目中使用单个版本的robocommons,无论构建哪个Git存储库。我甚至无法直接思考这个问题,因为我想到的每一种可能性都会阻碍其他需要工作的事情。

1 个答案:

答案 0 :(得分:0)

我不能说我理解那个版本中发生了什么,我感到痛苦。我要说的第一件事是composite builds可以为“正常”,可维护的构建提供途径,允许您将 robotcontroller 作为一个单独的项目。如果你沿着这条路走下去,你将不得不从父的 settings.gradle 文件中删除`include“:robotcontroller”,并用等效的复合构建配置替换它。

那就是说,我认为你可以很容易地完成这项工作,因为大多数部分似乎都已到位。我会这样做:

  1. 将当前位于 plugins / * / libs 中的所有JAR移动到 robotcontroller / libs 中,并在其文件名中添加一个版本

  2. 更新这些JAR的所有依赖项,以便它们包含相应的版本

  3. 删除 / robocommons 目录

  4. 您看, robotcontroller / libs 似乎已在 robotcontroller 和父项目中设置为平面目录存储库。在我看来,问题库在项目特定目录中的唯一原因是因为它们的名称中没有版本号来区分它们。通过添加版本号,您可以将它们并排放在同一目录中。

    这有意义吗?希望它无论如何都有帮助!