复合构建 - Gradle 中文

复合构建是包含其他构建的构建。

复合构建类似于 Gradle 多项目构建，但不同之处在于，它包含整个 构建，而不是 子项目。

复合构建允许您

合并通常独立开发的构建，例如，在尝试修复应用程序使用的库中的错误时。
将大型多项目构建分解为更小、更独立的部分，可以根据需要独立或一起处理。

包含在复合构建中的构建称为包含构建。包含构建与复合构建或其他包含构建不共享任何配置。每个包含构建都独立配置和执行。

定义复合构建

以下示例演示了如何将通常独立开发的两个 Gradle 构建合并到复合构建中。

my-composite
├── gradle
├── gradlew
├── settings.gradle.kts
├── build.gradle.kts
├── my-app
│   ├── settings.gradle.kts
│   └── app
│       ├── build.gradle.kts
│       └── src/main/java/org/sample/my-app/Main.java
└── my-utils
    ├── settings.gradle.kts
    ├── number-utils
    │   ├── build.gradle.kts
    │   └── src/main/java/org/sample/numberutils/Numbers.java
    └── string-utils
        ├── build.gradle.kts
        └── src/main/java/org/sample/stringutils/Strings.java

my-utils 多项目构建生成了两个 Java 库，number-utils 和 string-utils。my-app 构建使用这些库中的函数生成可执行文件。

my-app 构建不直接依赖于 my-utils。相反，它声明对 my-utils 生成的库的二进制依赖项

my-app/app/build.gradle.kts

plugins {
    id("application")
}

application {
    mainClass = "org.sample.myapp.Main"
}

dependencies {
    implementation("org.sample:number-utils:1.0")
    implementation("org.sample:string-utils:1.0")
}

my-app/app/build.gradle

plugins {
    id 'application'
}

application {
    mainClass = 'org.sample.myapp.Main'
}

dependencies {
    implementation 'org.sample:number-utils:1.0'
    implementation 'org.sample:string-utils:1.0'
}

通过 `--include-build` 定义复合构建

--include-build 命令行参数将已执行的构建转换为复合构建，将包含构建中的依赖项替换为已执行构建中的依赖项。

例如，从 my-app 运行 ./gradlew run --include-build ../my-utils 的输出

$ ./gradlew --include-build ../my-utils run
> Task :app:processResources NO-SOURCE
> Task :my-utils:string-utils:compileJava
> Task :my-utils:string-utils:processResources NO-SOURCE
> Task :my-utils:string-utils:classes
> Task :my-utils:string-utils:jar
> Task :my-utils:number-utils:compileJava
> Task :my-utils:number-utils:processResources NO-SOURCE
> Task :my-utils:number-utils:classes
> Task :my-utils:number-utils:jar
> Task :app:compileJava
> Task :app:classes

> Task :app:run
The answer is 42


BUILD SUCCESSFUL in 0s
6 actionable tasks: 6 executed

通过设置文件定义复合构建

可以通过使用 Settings.includeBuild(java.lang.Object) 在 settings.gradle(.kts) 文件中声明包含的构建，从而使上述安排持久化。

可以使用设置文件同时添加子项目和包含的构建。

包含的构建按位置添加

settings.gradle.kts

includeBuild("my-utils")

在该示例中，settings.gradle(.kts) 文件将原本独立的构建组合在一起

settings.gradle.kts

rootProject.name = "my-composite"

includeBuild("my-app")
includeBuild("my-utils")

settings.gradle

rootProject.name = 'my-composite'

includeBuild 'my-app'
includeBuild 'my-utils'

要从 my-composite 执行 my-app 构建中的 run 任务，请运行 ./gradlew my-app:app:run。

你可以在 my-composite 中定义一个依赖于 my-app:app:run 的 run 任务（可选），以便你可以执行 ./gradlew run

build.gradle.kts

tasks.register("run") {
    dependsOn(gradle.includedBuild("my-app").task(":app:run"))
}

build.gradle

tasks.register('run') {
    dependsOn gradle.includedBuild('my-app').task(':app:run')
}

包含定义 Gradle 插件的构建

包含构建的一个特例是定义 Gradle 插件的构建。

这些构建应使用设置文件中的 pluginManagement {} 块内的 includeBuild 语句包含。

使用此机制，包含的构建还可以提供可以在设置文件本身中应用的设置插件

settings.gradle.kts

pluginManagement {
    includeBuild("../url-verifier-plugin")
}

settings.gradle

pluginManagement {
    includeBuild '../url-verifier-plugin'
}

对包含的构建的限制

大多数构建都可以包含在复合构建中，包括其他复合构建。有一些限制。

在常规构建中，Gradle 确保每个项目都有一个唯一的项目路径。它使项目可识别且可寻址，且没有冲突。

在复合构建中，Gradle 为来自包含构建的每个项目添加额外的限定符，以避免项目路径冲突。在复合构建中识别项目的完整路径称为构建树路径。它由包含构建的构建路径和项目的项目路径组成。

默认情况下，构建路径和项目路径派生自磁盘上的目录名称和结构。由于包含的构建可以位于磁盘上的任何位置，因此它们的构建路径由包含目录的名称确定。这有时会导致冲突。

总之，包含的构建必须满足以下要求

每个包含的构建都必须具有唯一的构建路径。
每个包含的构建路径不得与主构建的任何项目路径冲突。

这些条件保证每个项目即使在复合构建中也能被唯一标识。

如果出现冲突，解决方法是更改包含构建的构建名称

settings.gradle.kts

includeBuild("some-included-build") {
    name = "other-name"
}

当一个复合构建包含在另一个复合构建中时，这两个构建具有相同的父级。换句话说，嵌套的复合构建结构被展平。

与复合构建交互

与复合构建交互通常类似于常规的多项目构建。可以执行任务、运行测试，并且可以将构建导入到 IDE 中。

执行任务

可以从命令行或 IDE 中以与常规多项目构建中的任务相同的方式执行包含构建中的任务。执行任务将导致执行任务依赖项，以及从其他包含构建构建依赖项工件所需的那些任务。

可以使用完全限定路径在包含构建中调用任务，例如，:included-build-name:project-name:taskName。项目和任务名称可以缩写。

$ ./gradlew :included-build:subproject-a:compileJava
> Task :included-build:subproject-a:compileJava

$ ./gradlew :i-b:sA:cJ
> Task :included-build:subproject-a:compileJava

要从命令行排除任务，需要提供任务的完全限定路径。

包含构建任务会自动执行以生成所需的依赖项工件，或者包含构建可以声明对包含构建中任务的依赖项。

导入到 IDE

复合构建最实用的功能之一是 IDE 集成。

导入复合构建允许轻松地共同开发来自不同 Gradle 构建的源代码。对于每个包含构建，每个子项目都包含为 IntelliJ IDEA 模块或 Eclipse 项目。配置源依赖项，提供跨构建导航和重构。

声明包含构建替换的依赖项

默认情况下，Gradle 将配置每个包含构建以确定它可以提供的依赖项。执行此操作的算法很简单。Gradle 将检查包含构建中项目的组和名称，并将任何匹配 ${project.group}:${project.name} 的外部依赖项替换为项目依赖项。

默认情况下，不会为主构建注册替换。

要使主构建的（子）项目可通过 ${project.group}:${project.name} 寻址，你可以通过自包含 includeBuild(".") 来告知 Gradle 将主构建视为已包含的构建。

在某些情况下，由 Gradle 确定的默认替换不足或必须针对特定复合进行更正。对于这些情况，可以显式声明已包含构建的替换。

例如，名为 anonymous-library 的单项目构建会生成一个 Java 实用程序库，但不声明 group 属性的值

build.gradle.kts

plugins {
    java
}

build.gradle

plugins {
    id 'java'
}

当此构建包含在复合中时，它将尝试替换依赖模块 undefined:anonymous-library（undefined 是 project.group 的默认值，anonymous-library 是根项目名称）。显然，这在复合构建中没有用。

要在复合构建中使用未发布的库，你可以显式声明它提供的替换

settings.gradle.kts

includeBuild("anonymous-library") {
    dependencySubstitution {
        substitute(module("org.sample:number-utils")).using(project(":"))
    }
}

settings.gradle

includeBuild('anonymous-library') {
    dependencySubstitution {
        substitute module('org.sample:number-utils') using project(':')
    }
}

使用此配置后，my-app 复合构建将用对 anonymous-library 根项目的依赖替换对 org.sample:number-utils 的任何依赖。

停用配置的已包含构建替换

如果你需要解析某个模块的已发布版本，而该模块也作为已包含构建的一部分可用，则可以在要解析的配置的ResolutionStrategy上停用已包含构建替换规则。这是必需的，因为这些规则在构建中全局应用，而 Gradle 在解析期间默认情况下不考虑已发布版本。

例如，我们创建一个单独的 publishedRuntimeClasspath 配置，该配置解析为在其中一个本地构建中也存在的模块的已发布版本。这是通过停用全局依赖替换规则来完成的

build.gradle.kts

configurations.create("publishedRuntimeClasspath") {
    resolutionStrategy.useGlobalDependencySubstitutionRules = false

    extendsFrom(configurations.runtimeClasspath.get())
    isCanBeConsumed = false
    attributes.attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.JAVA_RUNTIME))
}

build.gradle

configurations.create('publishedRuntimeClasspath') {
    resolutionStrategy.useGlobalDependencySubstitutionRules = false

    extendsFrom(configurations.runtimeClasspath)
    canBeConsumed = false
    attributes.attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage, Usage.JAVA_RUNTIME))
}

一个用例是比较已发布的 JAR 文件和本地构建的 JAR 文件。

必须声明已包含构建替换的情况

许多构建将自动作为已包含构建运行，而无需声明替换。以下是需要声明替换的一些常见情况

当 archivesBaseName 属性用于设置已发布工件的名称时。
当发布 default 以外的配置时。
当 MavenPom.addFilter() 用于发布与项目名称不匹配的工件时。
当 maven-publish 或 ivy-publish 插件用于发布并且发布坐标与 ${project.group}:${project.name} 不匹配时。

复合构建替换不起作用的情况

即使明确声明了依赖项替换，某些构建在包含在复合构建中时也不会正常运行。此限制是因为替换的项目依赖项将始终指向目标项目的 default 配置。每当为项目的默认配置指定了工件和依赖项与发布到存储库中的工件和依赖项不匹配时，复合构建可能会表现出不同的行为。

以下是发布的模块元数据可能与项目默认配置不同的情况

当发布 default 以外的配置时。
当使用 maven-publish 或 ivy-publish 插件时。
当 POM 或 ivy.xml 文件作为发布的一部分被调整时。

使用这些功能的构建在包含在复合构建中时不能正常运行。

依赖于包含构建中的任务

虽然包含的构建彼此隔离并且不能声明直接依赖项，但复合构建可以在其包含的构建中声明任务依赖项。使用 Gradle.getIncludedBuilds() 或 Gradle.includedBuild(java.lang.String) 访问包含的构建，并通过 IncludedBuild.task(java.lang.String) 方法获取任务引用。

使用这些 API，可以在特定包含的构建中声明对任务的依赖项

build.gradle.kts

tasks.register("run") {
    dependsOn(gradle.includedBuild("my-app").task(":app:run"))
}

build.gradle

tasks.register('run') {
    dependsOn gradle.includedBuild('my-app').task(':app:run')
}

或者，可以在某些或所有包含的构建中声明对具有特定路径的任务的依赖项

build.gradle.kts

tasks.register("publishDeps") {
    dependsOn(gradle.includedBuilds.map { it.task(":publishMavenPublicationToMavenRepository") })
}

build.gradle

tasks.register('publishDeps') {
    dependsOn gradle.includedBuilds*.task(':publishMavenPublicationToMavenRepository')
}

复合构建的限制

当前实现的限制包括

不支持发布内容不反映项目默认配置的包含构建。
请参阅复合构建不起作用的情况。
如果多个包含相同的构建，则在并行运行时多个复合构建可能会冲突。
Gradle 不会在 Gradle 调用之间共享共享复合构建的项目锁定，以防止并发执行。

此页面有帮助吗？