Java 平台插件带来了为 Java 生态系统声明平台的能力。平台可以用于不同的目的
-
一起发布的模块的描述(例如,共享相同的版本)
-
一组异构库的推荐版本。一个典型的例子包括 Spring Boot BOM
平台是一种特殊的软件组件,它不包含任何源代码:它仅用于引用其他库,以便它们在依赖解析期间协同工作。
平台可以发布为 Gradle 模块元数据 和 Maven BOM。
在给定的项目中,java-platform 插件不能与 java 或 java-library 插件组合使用。从概念上讲,一个项目要么是一个平台(没有二进制文件),要么 生成二进制文件。 |
用法
要使用 Java 平台插件,请在您的构建脚本中包含以下内容
plugins {
`java-platform`
}
plugins {
id 'java-platform'
}
API 和运行时分离
Maven BOM 和 Java 平台之间的主要区别在于,在 Gradle 中,依赖项和 约束 被声明并限定在配置及其扩展配置的范围内。虽然许多用户只关心声明 编译时 依赖项的约束(因此被运行时和测试继承),但它允许声明仅适用于运行时或测试的依赖项或约束。
为此,该插件公开了两个 配置,可用于声明依赖项:api
和 runtime
。api
配置应用于声明在针对平台编译时应使用的约束和依赖项,而 runtime
配置应用于声明在运行时可见的约束或依赖项。
dependencies {
constraints {
api("commons-httpclient:commons-httpclient:3.1")
runtime("org.postgresql:postgresql:42.2.5")
}
}
dependencies {
constraints {
api 'commons-httpclient:commons-httpclient:3.1'
runtime 'org.postgresql:postgresql:42.2.5'
}
}
请注意,此示例使用了约束而不是依赖项。一般来说,这正是您想要做的:只有当组件被添加到依赖关系图中(直接或传递地)时,约束才会应用。这意味着平台中列出的所有约束都不会添加依赖项,除非另一个组件将其引入:它们可以被视为建议。
例如,如果一个平台声明了对 |
默认情况下,为了避免在平台中添加依赖项而不是约束的常见错误,如果您尝试这样做,Gradle 将会失败。如果出于某种原因,您还想在约束之外添加依赖项,则需要显式启用它
javaPlatform {
allowDependencies()
}
javaPlatform {
allowDependencies()
}
本地项目约束
如果您有一个多项目构建,并且想要发布一个链接到子项目的平台,您可以通过声明属于该平台的子项目的约束来实现,如下例所示
dependencies {
constraints {
api(project(":core"))
api(project(":lib"))
}
}
dependencies {
constraints {
api project(":core")
api project(":lib")
}
}
项目表示法将在发布的元数据中变为经典的 group:name:version
表示法。
从另一个平台获取约束
有时,您定义的平台是另一个现有平台的扩展。
为了使您的平台包含来自该第三方平台的约束,需要将其作为 platform
依赖项导入
javaPlatform {
allowDependencies()
}
dependencies {
api(platform("com.fasterxml.jackson:jackson-bom:2.9.8"))
}
javaPlatform {
allowDependencies()
}
dependencies {
api platform('com.fasterxml.jackson:jackson-bom:2.9.8')
}
发布平台
发布 Java 平台是通过应用 maven-publish
插件并配置使用 javaPlatform
组件的 Maven 发布来实现的
publishing {
publications {
create<MavenPublication>("myPlatform") {
from(components["javaPlatform"])
}
}
}
publishing {
publications {
myPlatform(MavenPublication) {
from components.javaPlatform
}
}
}
这将为平台生成一个 BOM 文件,其中包含一个 <dependencyManagement>
块,其 <dependencies>
对应于平台模块中定义的约束。
消费平台
由于 Java 平台是一种特殊的组件,因此必须使用 platform
或 enforcedPlatform
关键字声明对 Java 平台的依赖,如 管理传递依赖 部分所述。例如,如果您想在子项目之间共享依赖版本,您可以定义一个平台模块,该模块将声明所有版本
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")
}
}
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'
}
}
然后让子项目依赖于该平台以获得建议
dependencies {
// get recommended versions from the platform project
api(platform(project(":platform")))
// no version required
api("commons-httpclient:commons-httpclient")
}
dependencies {
// get recommended versions from the platform project
api platform(project(':platform'))
// no version required
api 'commons-httpclient:commons-httpclient'
}