了解 Gradle 模块元数据 - Gradle 构建系统

Gradle 模块元数据是一种用于序列化 Gradle 组件模型的格式。它类似于 Apache Maven™ 的 POM 文件或 Apache Ivy™ ivy.xml 文件。元数据文件的目标是为消费者提供在仓库上发布的合理模型。

Gradle 模块元数据是一种独特的格式，旨在通过使其成为多平台和变体感知来改进依赖项解析。

特别是，Gradle 模块元数据支持

发布 Gradle 模块元数据将为您的消费者实现更好的依赖管理

通过检测不兼容的模块尽早发现问题
一致选择平台特定的依赖项
原生依赖项版本对齐
自动获取特定库功能的依赖项

当使用 Maven 发布插件或 Ivy 发布插件时，Gradle 模块元数据会自动发布。

Gradle 模块元数据的规范可以在这里找到。

与其他格式的映射

Gradle 模块元数据会自动发布到 Maven 或 Ivy 仓库。但是，它不会替换 pom.xml 或 ivy.xml 文件：它与这些文件一起发布。这样做是为了最大程度地与第三方构建工具兼容。

Gradle 尽力将 Gradle 特有的概念映射到 Maven 或 Ivy。当构建文件使用只能在 Gradle 模块元数据中表示的功能时，Gradle 将在发布时警告您。下表总结了一些 Gradle 特定功能如何映射到 Maven 和 Ivy

表 1. Gradle 特定概念到 Maven 和 Ivy 的映射
Gradle	Maven	Ivy	描述
依赖约束	`<dependencyManagement>` 依赖项	未发布	Gradle 依赖约束是传递的，而 Maven 的依赖管理块不是
丰富的版本约束	发布 requires 版本	发布 requires 版本
组件功能	未发布	未发布	组件功能是 Gradle 独有的
功能变体	变体工件已上传，依赖项作为可选依赖项发布	变体工件已上传，依赖项未发布	功能变体是可选依赖项的良好替代品
自定义组件类型	工件已上传，依赖项是映射描述的那些	工件已上传，依赖项被忽略	自定义组件类型可能在任何情况下都无法从 Maven 或 Ivy 使用。它们通常存在于自定义生态系统的上下文中。

禁用元数据兼容性发布警告

如果您想禁止警告，可以使用以下 API 来执行此操作

对于 Maven，请参阅 MavenPublication 中的 suppress* 方法
对于 Ivy，请参阅 IvyPublication 中的 suppress* 方法

示例 1. 禁用发布警告

build.gradle.kts

publications {
    register<MavenPublication>("maven") {
        from(components["java"])
        suppressPomMetadataWarningsFor("runtimeElements")
    }
}

build.gradle

publications {
    maven(MavenPublication) {
        from components.java
        suppressPomMetadataWarningsFor('runtimeElements')
    }
}

与其他构建工具的交互

由于 Gradle 模块元数据尚未广泛传播，并且旨在最大程度地与其他工具兼容，因此 Gradle 做了以下几件事

Gradle 模块元数据与给定仓库（Maven 或 Ivy）的正常描述符一起系统地发布
pom.xml 或 ivy.xml 文件将包含一个标记注释，该注释告诉 Gradle 此模块存在 Gradle 模块元数据

标记的目标不是让其他工具解析模块元数据：它仅供 Gradle 用户使用。它向 Gradle 解释说存在更好的模块元数据文件，并且应该使用它代替。这并不意味着从 Maven 或 Ivy 的消费也会被破坏，只是它在降级模式下工作。

这必须被视为性能优化：Gradle 将首先查看最有可能存在的文件，而不是必须执行 2 个网络请求，一个获取 Gradle 模块元数据，然后在未命中时获取 POM/Ivy 文件，然后仅在模块实际使用 Gradle 模块元数据发布时执行第二个请求。

如果您知道您依赖的模块始终使用 Gradle 模块元数据发布，则可以通过配置仓库的元数据源来优化网络调用

示例 2. 仅解析 Gradle 模块元数据

build.gradle.kts

repositories {
    maven {
        url = uri("http://repo.mycompany.com/repo")
        metadataSources {
            gradleMetadata()
        }
    }
}

build.gradle

repositories {
    maven {
        url = "http://repo.mycompany.com/repo"
        metadataSources {
            gradleMetadata()
        }
    }
}

Gradle 模块元数据验证

Gradle 模块元数据在发布之前会经过验证。

强制执行以下规则

变体名称必须唯一，
每个变体必须至少具有一个属性，
两个变体不能具有完全相同的属性和功能，
如果存在依赖项，则所有变体中至少有一个必须携带版本信息。

这些规则确保了生成的元数据的质量，并有助于确认消费不会出现问题。

Gradle 模块元数据可再现性

由于其实现方式，生成模块元数据文件的任务当前永远不会被 Gradle 标记为 UP-TO-DATE。但是，如果构建输入和构建脚本都没有更改，则任务结果实际上是最新的：它始终产生相同的输出。

如果用户希望每次构建调用都有一个唯一的 module 文件，则可以在生成的元数据中链接一个标识符到创建它的构建。用户可以选择在其 publication 中启用此唯一标识符

示例 3. 配置发布的构建标识符

build.gradle.kts

publishing {
    publications {
        create<MavenPublication>("myLibrary") {
            from(components["java"])
            withBuildIdentifier()
        }
    }
}

build.gradle

publishing {
    publications {
        myLibrary(MavenPublication) {
            from components.java
            withBuildIdentifier()
        }
    }
}

通过上述更改，生成的 Gradle 模块元数据文件将始终不同，从而迫使下游任务将其视为过时。

禁用 Gradle 模块元数据发布

在某些情况下，您可能希望禁用 Gradle 模块元数据的发布

您要上传到的仓库拒绝元数据文件（未知格式）
您正在使用 Maven 或 Ivy 特有的概念，这些概念未正确映射到 Gradle 模块元数据

在这种情况下，禁用 Gradle 模块元数据的发布只需禁用生成元数据文件的任务即可

示例 4. 禁用 Gradle 模块元数据的发布

build.gradle.kts

tasks.withType<GenerateModuleMetadata> {
    enabled = false
}

build.gradle

tasks.withType(GenerateModuleMetadata) {
    enabled = false
}

此页面是否对您有帮助？