依赖元数据指的是与依赖项相关联的信息，它描述了依赖项的特性、关系和需求。

此元数据包括以下详细信息，例如

  1. 身份：模块依赖项通过其组、名称和版本 (GAV) 坐标进行唯一标识。

  2. 依赖项：此依赖项所需的其他二进制文件列表，包括其版本。

  3. 变体：组件的不同形式（例如，compile、runtime、apiElements、runtimeElements），可以在不同的上下文中使用。

  4. 工件：组件生成的实际文件（如 JAR、ZIP 等），可能包括编译后的代码、资源或文档。

  5. 能力：描述模块提供或使用的功能或特性，帮助避免不同模块提供相同能力时发生冲突。

  6. 属性：用于区分变体的键值对（例如 org.gradle.jvm.version:8）。

根据仓库类型，依赖元数据以不同的格式存储

  • Gradle: Gradle 模块元数据 (.module) 文件

  • Maven: Maven POM (pom.xml) 文件

  • Ivy: Ivy 描述符 (ivy.xml) 文件

某些仓库可能包含单个组件的多种元数据类型。当 Gradle 发布到 Maven 仓库时，它会同时发布 Gradle 模块元数据 (GMM) 文件和 Maven POM 文件。

此元数据在依赖解析中起着至关重要的作用，它允许二进制工件的依赖项与工件本身一起被跟踪。通过读取依赖元数据，Gradle 能够确定给定依赖项所需的其他工件的版本。

支持的元数据格式

外部模块依赖项需要模块元数据，以便 Gradle 可以确定模块的传递依赖项。Gradle 支持各种元数据格式来实现这一点。

Gradle 模块元数据 (GMM) 文件

Gradle 模块元数据专门设计用于支持 Gradle 依赖管理模型的所有功能，使其成为首选格式。

您可以在此处找到规范。

{
  "formatVersion": "1.1",
  "component": {
    "group": "com.example",
    "module": "my-library",
    "version": "1.0"
  }
}

POM 文件

Gradle 原生支持 Maven POM 文件。默认情况下，Gradle 将首先查找 POM 文件。但是，如果该文件包含特殊标记，Gradle 将使用 Gradle 模块元数据 代替。

<project xmlns="http://maven.apache.org/POM/4.0.0">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>my-library</artifactId>
  <version>1.0</version>
</project>

Ivy 文件

Gradle 还支持 Ivy 描述符文件。Gradle 将首先查找 ivy.xml 文件，但如果此文件包含特殊标记，它将使用 Gradle 模块元数据 代替。

<ivy-module version="2.0">
  <info organisation="com.example" module="my-library" revision="1.0"/>
  <dependencies>
    <dependency org="org.example" name="dependency" rev="1.2"/>
  </dependencies>
</ivy-module>

支持的元数据来源

在仓库中搜索组件时，Gradle 默认检查支持的元数据文件格式。

Gradle 首先查找 .module（Gradle 模块元数据）文件。在 Maven 仓库中，Gradle 接下来查找 .pom 文件。在 Ivy 仓库中，它检查 ivy.xml 文件。在扁平目录仓库中，它直接查找 .jar 文件，而不期望任何元数据。

如果您定义了自定义仓库，则可以配置 Gradle 如何搜索元数据。例如，您可以设置 Maven 仓库以选择性地解析没有关联 POM 文件的 JAR。这通过为仓库配置元数据来源来完成

build.gradle.kts
repositories {
    maven {
        url = uri("http://repo.mycompany.com/repo")
        metadataSources {
            mavenPom()
            artifact()
        }
    }
}
build.gradle
repositories {
    maven {
        url = "http://repo.mycompany.com/repo"
        metadataSources {
            mavenPom()
            artifact()
        }
    }
}

您可以指定多个元数据来源，Gradle 将按预定义的顺序搜索它们。支持以下元数据来源

元数据来源 描述 默认顺序 Maven Ivy / 扁平目录

gradleMetadata()

查找 Gradle .module 文件

第 1

是

是

mavenPom()

查找 Maven .pom 文件

第 2

是

是

ivyDescriptor()

查找 ivy.xml 文件

第 2

否

是

artifact()

直接查找工件，无需关联的元数据

第 3

是

是

默认情况下，Gradle 将要求依赖项具有关联的元数据。

要放宽此要求并允许 Gradle 解析没有关联元数据的工件，请指定 artifact 元数据来源

mavenCentral {
    metadataSources {
        mavenPom()
        artifact()
    }
}

以上示例指示 Gradle 首先从 POM 文件中查找组件元数据，如果不存在，则从工件本身派生元数据。

在解析元数据文件（Ivy 或 Maven）时，Gradle 会检查一个标记，该标记指示是否存在匹配的 Gradle 模块元数据文件。如果找到，Gradle 将优先选择 Gradle 元数据。

要禁用此行为，请使用 ignoreGradleMetadataRedirection() 选项

build.gradle.kts
repositories {
    maven {
        url = uri("http://repo.mycompany.com/repo")
        metadataSources {
            mavenPom()
            artifact()
            ignoreGradleMetadataRedirection()
        }
    }
}
build.gradle
repositories {
    maven {
        url = "http://repo.mycompany.com/repo"
        metadataSources {
            mavenPom()
            artifact()
            ignoreGradleMetadataRedirection()
        }
    }
}