多模块项目仓库依赖管理技巧

目前golang学习网上已经有很多关于文章的文章了，自己在初次阅读这些文章中，也见识到了很多学习思路；那么本文《多模块项目仓库依赖管理技巧》，也希望能帮助到大家，如果阅读完后真的对你学习文章有帮助，欢迎动动手指，评论留言并分享~

1. 问题描述：子项目间仓库依赖的非传递性

在Gradle的多模块项目中，当一个子项目（例如core）依赖于另一个子项目（例如api）时，如果api子项目本身依赖于一个来自特定Maven仓库的外部库，core子项目在编译时可能会遇到“找不到依赖”的错误。这是因为Gradle的仓库声明不像依赖声明那样具有传递性。每个子项目在解析其依赖时，只会查找自身或其父级（如根build.gradle）声明的仓库。

考虑以下项目结构：

• api 子项目：声明了对 org.spongepowered:spongeapi 的 api 依赖，并配置了 spongepowered 仓库。
• core 子项目：声明了对 api 子项目的 implementation 依赖。

api.gradle 配置示例：

// api.gradle
plugins {
    id 'java-library'
}

repositories {
    // api子项目声明了spongepowered仓库
    maven { url 'https://repo.spongepowered.org/repository/maven-public/' }
}

dependencies {
    // api配置，使得spongeapi成为core的传递性API依赖
    api('org.spongepowered:spongeapi:8.0.0')
}

core.gradle 配置示例：

// core.gradle
dependencies {
    // core子项目依赖api子项目
    implementation(project(':api'))
}

当尝试编译 core 子项目时，可能会遇到如下错误：

> Could not find org.spongepowered:spongeapi:8.0.0-SNAPSHOT.

这个错误表明 core 子项目无法找到 api 子项目所依赖的 org.spongepowered:spongeapi 库。尽管 api 子项目明确声明了 spongepowered 仓库，但 core 子项目在解析 api 的传递性依赖时，并没有自动继承 api 子项目所声明的仓库配置。

2. 传统解决方案及其局限性

一种直接但效率不高的方法是，在每个需要使用 spongepowered 仓库的子项目中都重复声明该仓库。例如，在 core.gradle 中也添加 spongepowered 仓库：

// core.gradle (传统解决方案)
repositories {
    // 在core子项目中重复声明仓库
    maven { url 'https://repo.spongepowered.org/repository/maven-public/' }
}

dependencies {
    implementation(project(':api'))
}

这种方法虽然能解决问题，但引入了大量的重复代码（boilerplate），尤其是在多模块项目中有多个子项目依赖相同外部仓库时。这不仅增加了配置的复杂性，也使得仓库管理变得困难，一旦仓库地址发生变化，需要修改所有相关的 build.gradle 文件。

3. 推荐解决方案：统一仓库配置于 settings.gradle

为了解决上述问题并实现仓库配置的集中管理，Gradle 提供了在根项目的 settings.gradle 文件中通过 dependencyResolutionManagement 块统一声明仓库的机制。这种方式声明的仓库对所有子项目都有效，且是推荐的最佳实践。

settings.gradle 配置示例：

// settings.gradle
rootProject.name = 'your-multi-project' // 替换为你的根项目名称

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) // 可选，强制所有项目使用此处的仓库
    repositories {
        mavenCentral() // 通常包含的中央仓库
        maven { url 'https://repo.spongepowered.org/repository/maven-public/' } // 统一声明spongepowered仓库
        // 其他可能需要的仓库，如google(), jcenter()等
    }
}

解释：

• dependencyResolutionManagement：这是Gradle 6.0及更高版本引入的机制，用于集中管理项目的依赖解析策略，包括仓库配置、插件仓库配置等。
• repositories 块：在此块中声明的Maven或Ivy仓库将对项目中的所有子项目生效。这意味着 api 和 core 子项目都将能够访问 mavenCentral() 和 https://repo.spongepowered.org/repository/maven-public/。
• repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) (可选)：这个设置是推荐的最佳实践之一。它会强制所有子项目只能使用在 dependencyResolutionManagement 中定义的仓库。如果任何子项目在其自身的 build.gradle 文件中尝试声明 repositories 块，Gradle 将会报错，从而确保了仓库配置的严格统一性。

通过这种方式，core 子项目在解析 api 的传递性依赖 org.spongepowered:spongeapi 时，会自动从 settings.gradle 中声明的 spongepowered 仓库中查找，从而避免了 Could not find 错误。

4. 优势与注意事项

优势：

• 集中管理：所有子项目的仓库配置集中在一处，便于维护和审计。
• 减少重复：避免了在每个子项目的 build.gradle 中重复声明相同的仓库。
• 提高一致性：确保所有子项目都使用相同的仓库列表进行依赖解析，减少因仓库配置不一致导致的问题。
• 清晰的项目结构：使 build.gradle 文件更专注于项目的构建逻辑，而不是重复的仓库声明。

注意事项：

• Gradle 版本要求：dependencyResolutionManagement 机制在 Gradle 6.0 及更高版本中可用。对于旧版本的 Gradle，可能需要使用根项目 build.gradle 中的 allprojects { repositories { ... } } 或 subprojects { repositories { ... } } 块来达到类似的效果，但 settings.gradle 的方式是更现代和推荐的做法。
• 仓库顺序：仓库的声明顺序很重要。Gradle 会按照声明的顺序查找依赖。如果同一个依赖存在于多个仓库中，Gradle 会使用第一个找到的版本。通常，将私有仓库放在公共仓库之前，以确保优先使用内部版本。
• 插件仓库：dependencyResolutionManagement 也可以用于配置插件的仓库（pluginManagement.repositories），这对于多模块项目中的插件版本管理也很有用。
• 本地Maven仓库：如果你的项目依赖本地Maven仓库 (mavenLocal())，也应在 settings.gradle 中统一声明。

总结

在Gradle多模块项目中，正确管理仓库依赖是确保构建成功的关键。通过在根项目的 settings.gradle 文件中使用 dependencyResolutionManagement 统一配置所有子项目的仓库，我们能够有效解决子项目间仓库依赖不传递的问题，减少配置冗余，提高项目的可维护性和一致性。这种方法是构建健壮、高效Gradle多模块项目的最佳实践。

今天关于《多模块项目仓库依赖管理技巧》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！