如果一个子项目依赖于另一个子项目怎么办？如果一个项目需要另一个项目生成的 artifact 怎么办？

structuring builds 2

这是多项目构建的常见用例。Gradle 为此提供了项目依赖。

依赖于另一个项目

让我们探索一个具有以下布局的理论多项目构建：

.
├── api
│   ├── src
│   │   └──...
│   └── build.gradle.kts
├── services
│   └── person-service
│       ├── src
│       │   └──...
│       └── build.gradle.kts
├── shared
│   ├── src
│   │   └──...
│   └── build.gradle.kts
└── settings.gradle.kts
.
├── api
│   ├── src
│   │   └──...
│   └── build.gradle
├── services
│   └── person-service
│       ├── src
│       │   └──...
│       └── build.gradle
├── shared
│   ├── src
│   │   └──...
│   └── build.gradle
└── settings.gradle

在这个例子中，有三个子项目：shared、api 和 person-service

  1. person-service 子项目依赖于另外两个子项目，shared 和 api。

  2. api 子项目依赖于 shared 子项目。

我们使用 : 分隔符来定义项目路径，例如 services:person-service 或 :shared。有关定义项目路径的更多信息，请参阅 Settings.include(java.lang.String[]) 的 DSL 文档。

settings.gradle.kts
rootProject.name = "dependencies-java"
include("api", "shared", "services:person-service")
shared/build.gradle.kts
plugins {
    id("java")
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation("junit:junit:4.13")
}
api/build.gradle.kts
plugins {
    id("java")
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation("junit:junit:4.13")
    implementation(project(":shared"))
}
services/person-service/build.gradle.kts
plugins {
    id("java")
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation("junit:junit:4.13")
    implementation(project(":shared"))
    implementation(project(":api"))
}
settings.gradle
rootProject.name = 'basic-dependencies'
include 'api', 'shared', 'services:person-service'
shared/build.gradle
plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation "junit:junit:4.13"
}
api/build.gradle
plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation "junit:junit:4.13"
    implementation project(':shared')
}
services/person-service/build.gradle
plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation "junit:junit:4.13"
    implementation project(':shared')
    implementation project(':api')
}

项目依赖影响执行顺序。它会导致首先构建依赖的项目，并将该项目生成的类输出添加到 classpath 中。它还会将依赖项目的依赖项添加到 classpath 中。

如果执行 ./gradlew :api:compile，首先构建 shared 项目，然后构建 api 项目。

依赖于另一个项目生成的 artifact

有时，你可能想依赖于另一个项目中的某个特定任务的输出，而不是整个项目。但是，不建议显式声明一个项目对另一个项目的任务依赖，因为它会引入任务之间不必要的耦合。

推荐的模型依赖关系的方式，即一个项目中的任务依赖于另一个项目的输出，是生成输出并将其标记为“outgoing”（输出）artifact。Gradle 的依赖管理引擎允许你在项目之间共享任意 artifact，并按需构建它们。