Java 平台插件带来了为 Java 生态系统声明平台的能力。平台可用于不同目的

平台是一种特殊类型的软件组件，不包含任何源代码：它仅用于引用其他库，以便它们在依赖项解析期间能够很好地协同工作。

平台可以发布为 Gradle 模块元数据 和 Maven BOM。

java-platform 插件不能与给定项目中的 java 或 java-library 插件结合使用。从概念上讲，一个项目要么是一个没有二进制文件的平台，要么生成二进制文件。

用法

要使用 Java 平台插件，请在构建脚本中包含以下内容

示例 1. 使用 Java 平台插件
build.gradle.kts
plugins {
    `java-platform`
}
build.gradle
plugins {
    id 'java-platform'
}

API 和运行时分离

Maven BOM 和 Java 平台之间的一个主要区别在于，在 Gradle 中，依赖项和 约束 被声明并限定在某个配置及其扩展配置中。虽然许多用户只关心为编译时依赖项声明约束，从而被运行时和测试依赖项继承，但它允许声明仅适用于运行时或测试的依赖项或约束。

为此，该插件公开了两个 配置，可用于声明依赖项：api 和 runtime。api 配置应用于声明在针对平台编译时应使用的约束和依赖项，而 runtime 配置应用于声明在运行时可见的约束或依赖项。

示例 2. 声明 API 和运行时约束
build.gradle.kts
dependencies {
    constraints {
        api("commons-httpclient:commons-httpclient:3.1")
        runtime("org.postgresql:postgresql:42.2.5")
    }
}
build.gradle
dependencies {
    constraints {
        api 'commons-httpclient:commons-httpclient:3.1'
        runtime 'org.postgresql:postgresql:42.2.5'
    }
}

请注意，此示例使用约束，而不是依赖项。通常，这是您想要执行的操作：仅当此类组件直接或间接添加到依赖项图中时，约束才会生效。这意味着平台中列出的所有约束都不会添加依赖项，除非其他组件引入该依赖项：它们可以被视为建议。

例如，如果平台对 org:foo:1.1 声明约束，并且没有任何其他内容引入对 foo 的依赖项，则 foo 将不会出现在图中。但是，如果 foo 出现，则通常的冲突解决将启动。如果某个依赖项引入 org:foo:1.0，那么我们将选择 org:foo:1.1 来满足平台约束。

默认情况下，为了避免在约束中添加依赖项而不是平台中添加依赖项的常见错误，如果您尝试这样做，Gradle 将失败。如果由于某种原因，您还希望添加依赖项以及约束，则需要显式启用它

示例 3. 允许声明依赖项
build.gradle.kts
javaPlatform {
    allowDependencies()
}
build.gradle
javaPlatform {
    allowDependencies()
}

本地项目约束

如果您有一个多项目构建，并且想要发布一个链接到子项目的平台，您可以通过声明对属于该平台的子项目的约束来实现，如下面的示例所示

示例 4. 声明对子项目的约束
build.gradle.kts
dependencies {
    constraints {
        api(project(":core"))
        api(project(":lib"))
    }
}
build.gradle
dependencies {
    constraints {
        api project(":core")
        api project(":lib")
    }
}

项目符号将在已发布的元数据中变为经典的 group:name:version 符号。

从另一个平台获取约束

有时，您定义的平台是另一个现有平台的扩展。

为了让您的平台包含来自该第三方平台的约束，需要将它导入为 platform 依赖项

示例 5. 导入平台
build.gradle.kts
javaPlatform {
    allowDependencies()
}

dependencies {
    api(platform("com.fasterxml.jackson:jackson-bom:2.9.8"))
}
build.gradle
javaPlatform {
    allowDependencies()
}

dependencies {
    api platform('com.fasterxml.jackson:jackson-bom:2.9.8')
}

发布平台

发布 Java 平台通过应用 maven-publish 插件和配置使用 javaPlatform 组件的 Maven 发布来完成

示例 6. 发布为 BOM
build.gradle.kts
publishing {
    publications {
        create<MavenPublication>("myPlatform") {
            from(components["javaPlatform"])
        }
    }
}
build.gradle
publishing {
    publications {
        myPlatform(MavenPublication) {
            from components.javaPlatform
        }
    }
}

这将为平台生成一个 BOM 文件，其中包含一个 <dependencyManagement> 块，其 <dependencies> 对应于平台模块中定义的约束。

使用平台

由于 Java 平台是一种特殊类型的组件，因此必须使用 platform 或 enforcedPlatform 关键字声明对 Java 平台的依赖，如 管理传递依赖 部分中所述。例如，如果您想在子项目之间共享依赖版本，则可以定义一个平台模块，该模块将声明所有版本

示例 7. 在平台模块中推荐版本
build.gradle.kts
dependencies {
    constraints {
        // Platform declares some versions of libraries used in subprojects
        api("commons-httpclient:commons-httpclient:3.1")
        api("org.apache.commons:commons-lang3:3.8.1")
    }
}
build.gradle
dependencies {
    constraints {
        // Platform declares some versions of libraries used in subprojects
        api 'commons-httpclient:commons-httpclient:3.1'
        api 'org.apache.commons:commons-lang3:3.8.1'
    }
}

然后让子项目依赖于平台以获取建议

示例 8. 从平台获取建议
build.gradle.kts
dependencies {
    // get recommended versions from the platform project
    api(platform(project(":platform")))
    // no version required
    api("commons-httpclient:commons-httpclient")
}
build.gradle
dependencies {
    // get recommended versions from the platform project
    api platform(project(':platform'))
    // no version required
    api 'commons-httpclient:commons-httpclient'
}