如何在Gradle中定义可跨项目依赖的Zip构件（兼容Maven仓库）

要让testB能通过includeBuild正确引用testA生成的xxx.zip，同时不破坏原有Maven仓库的依赖逻辑，我们可以遵循Gradle原生的构件属性匹配机制（和Java插件的jar依赖逻辑一致），具体步骤如下：

步骤1：调整testA的构件配置 #

首先，我们需要让testA的构件坐标和testB的依赖匹配，同时正确发布zip构件并设置匹配属性：

修改testA的build.gradle：

group = 'org.test'
version = '0.0.0.1_test'
archivesBaseName = 'xxx' // 关键：让构件的artifactId和testB依赖中的"xxx"对应

task someZip (type: Zip) {
    from './settings.gradle'
    archiveName = 'xxx.zip'
    destinationDir = file("${buildDir}/test")
}

artifacts {
    // 将zip任务的产出添加到archives配置（和Java插件的jar逻辑一致）
    archives(someZip) {
        // 设置构件分类为library，匹配Java插件的默认属性
        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category, Category.LIBRARY))
        // 设置构件类型为zip，对应testB依赖中的@zip后缀
        attribute(ArtifactTypeDefinition.ARTIFACT_TYPE_ATTRIBUTE, "zip")
    }
}

步骤2：配置testB的依赖匹配规则 #

testB的magic配置需要明确它要接收的构件属性，这样Gradle才能在includeBuild模式下匹配到testA的zip构件：

修改testB的build.gradle：

if (System.getenv('LOCAL_COMPILATION') != 'true') {
    repositories {
        maven { url '192.168.1.100' }
    }
}

configurations {
    magic {
        canBeResolved = true // 标记此配置用于解析依赖
        // 添加属性匹配规则，和testA的构件属性完全对应
        attributes {
            attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category, Category.LIBRARY))
            attribute(ArtifactTypeDefinition.ARTIFACT_TYPE_ATTRIBUTE, "zip")
        }
    }
}

dependencies {
    magic 'org.test:xxx:0.0.0.+@zip'
}

task ultimateZip (type: Zip) {
    from configurations.magic
    archiveName = 'ultimate.zip'
    destinationDir = file("${buildDir}/ultimate-test")
}

为什么这样做？ #

• 坐标匹配：archivesBaseName = 'xxx'让testA的构件坐标变为org.test:xxx:0.0.0.1_test，完全匹配testB中的依赖声明，这样includeBuild才能正确识别testA为依赖模块。
• 属性匹配：Gradle的依赖解析是基于属性匹配的，我们给testA的zip构件设置和Java插件jar一致的category属性，同时指定artifactType为zip，确保testB的magic配置能精准找到这个构件——这和Java插件自动处理jar依赖的逻辑完全相同。
• 兼容Maven仓库：当LOCAL_COMPILATION=false时，testB会从Maven仓库拉取org.test:xxx:0.0.0.+的zip包，原有逻辑不受任何影响，因为我们只是补充了includeBuild模式下的匹配规则。

测试验证 #

在LOCAL_COMPILATION=true的环境下运行testB的ultimateZip任务：

export LOCAL_COMPILATION=true
./gradlew :ultimateZip

Gradle会自动触发testA的someZip任务构建，然后将生成的xxx.zip打包到ultimate.zip中，完全符合预期。

内容的提问来源于stack exchange，提问作者Piotr Siupa