Как избежать повторения версий зависимостей в многомодульном проекте Gradle?

Question

Вот пример проекта Spring Boot здесь , который содержит два модуля.

build.gradle для одного из модулей выглядит следующим образом:

buildscript {
    ext { springBootVersion = '2.1.4.RELEASE' }
    repositories { mavenCentral() }
    dependencies { classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}") }
}

plugins {
    id "io.spring.dependency-management" version "1.0.5.RELEASE"
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

bootJar {
    baseName = 'gs-multi-module-application'
    version = '0.0.1-SNAPSHOT'
}
sourceCompatibility = 1.8

repositories { mavenCentral() }

dependencies {
    compile('org.springframework.boot:spring-boot-starter-actuator')
    compile('org.springframework.boot:spring-boot-starter-web')
    compile project(':library')
    testCompile('org.springframework.boot:spring-boot-starter-test')
}

Другой модуль build.gradle выглядит так:

buildscript {
    repositories { mavenCentral() }
}

plugins { id "io.spring.dependency-management" version "1.0.5.RELEASE" }

ext { springBootVersion = '2.1.4.RELEASE' }

apply plugin: 'java'
apply plugin: 'eclipse'

jar {
    baseName = 'gs-multi-module-library'
    version = '0.0.1-SNAPSHOT'
}
sourceCompatibility = 1.8

repositories { mavenCentral() }

dependencies {
    compile('org.springframework.boot:spring-boot-starter')
    testCompile('org.springframework.boot:spring-boot-starter-test')
}

dependencyManagement {
    imports { mavenBom("org.springframework.boot:spring-boot-dependencies:${springBootVersion}") }
}

springBootVersion = '2.1.4.RELEASE' объявлен в обоих модулях. Для двухмодульного проекта это может не быть проблемой, но если в моем проекте было 10 модулей, и я хотел убедиться, что все модули всегда зависят от одной и той же версии Spring Boot, было бы неудобно и подвержено ошибкам повторять эту версию в каждом модуле.

Аналогично, я мог бы захотеть добавить зависимость от commons-io к обоим этим модулям и убедиться, что они оба всегда зависят от одной и той же версии commons-io.

Как мне избежать повторения номеров версий в каждом build.gradle файле?

Answer 1

См. эту документацию Gradle : в Gradle рекомендуется настраивать подпроекты, которые имеют общие черты в одном месте, например, в скрипте сборки root project (или с помощью пользовательских плагинов)

В вашем примере, взятом из документации по загрузке Spring, этот шаблон можно применить для централизации загрузки Spring и других распространенных версий зависимостей в одном месте, но вы можете пойти дальше и настроить другие общие черты (конфигурация подключаемого модуля Java, репозитории и т. Д.) ..)

Вот как я бы переписал пример Spring, чтобы он стал чище и сухим:

Корневой проект

/**
 * Add Springboot plugin into build script classpath (without applying it)
 * This is this only place where you need to define the Springboot version.
 *
 * See https://docs.spring.io/spring-boot/docs/current/gradle-plugin/reference/html/#managing-dependencies-using-in-isolation
 */
plugins {
    id "org.springframework.boot" version "2.1.4.RELEASE" apply false
}

// Set version for dependencies share between subprojects
ext {
    commonsIoVersion = "2.6"
}

subprojects {
    // common config for all Java subprojects
    apply plugin: "java"
    apply plugin: "eclipse"
    sourceCompatibility = 1.8
    repositories { 
        mavenCentral() 
    }

    // apply Spring Boot's dependency management plugin
    apply plugin: "io.spring.dependency-management"
}

Подпроект библиотеки

// no need for additional plugins

jar {
    baseName = 'gs-multi-module-library'
    version = '0.0.1-SNAPSHOT'
}

dependencies {
    implementation('org.springframework.boot:spring-boot-starter')
    implementation "commons-io:commons-io:${commonsIoVersion}"

    testCompile('org.springframework.boot:spring-boot-starter-test')
}

dependencyManagement {
    imports {
        mavenBom org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES 
    }
}

Подпроект приложения

plugins {
    id "org.springframework.boot"
}

bootJar { 
    baseName = 'gs-multi-module-application'
    version = '0.0.1-SNAPSHOT'
}

dependencies {
    implementation  project(':library')

    implementation ('org.springframework.boot:spring-boot-starter-actuator')
    implementation ('org.springframework.boot:spring-boot-starter-web')
    implementation "commons-io:commons-io:${commonsIoVersion}"

    // could also be configured in root project.
    testCompile('org.springframework.boot:spring-boot-starter-test')
}

Примечания

• В этом решении используется только новый plugins {} DSL (нет необходимости в старом блоке buildscript)
• версия io.spring.dependency-management не должна быть настроена явно, она будет наследоваться от загрузочного плагина Spring

Answer 2

Вы можете переместить блок ext{} в новый файл и сослаться на него в файле build.gradle вашего проекта с помощью оператора apply from:.

// project/versions.gradle
ext {
    springBootVersion = '2.1.4.RELEASE'
}

// project/build.gradle
buildscript {
    apply from: 'versions.gradle'
}

// module/build.gradle
dependencies {
    implementation "some.dependency:dependency:$springBootVersion"
}

Теперь вам нужно только определить версии зависимостейв одном месте.

Как правило, проект будет иметь файл уровня проекта build.gradle в дополнение к специфичным для модуля файлам build.gradle.Однако в репозитории, к которому вы предоставили общий доступ, отсутствует сценарий сборки на уровне проекта.Вот почему блок ext{} определен в скрипте сборки каждого модуля.Это, вероятно, не оптимально, и я рекомендую посмотреть другие репозитории, чтобы увидеть, как разные разработчики решали эту проблему.