Java 中 Gradle 怎么利用 settings.gradle 管理多项目模块的包含关系

浅磊同学_8233

浅磊同学_8233

2026-07-27

945人浏览

原创

settings.gradle 是 gradle 多项目构建的入口配置文件,仅声明子项目(如 include "api", "service")、路径映射、项目命名(rootproject.name)及复合构建(includebuild),不定义任务或依赖;子项目依赖须在各 build.gradle 中通过 implementation project(':xxx') 声明,且被 include 的子项目才可被正确引用。

java 中 gradle 怎么利用 settings.gradle 管理多项目模块的包含关系

settings.gradle 是 Gradle 多项目构建的入口配置文件,它不定义任务或依赖,只负责声明哪些子项目参与构建、如何命名、路径如何映射。正确配置它,是多模块项目可维护、可复用的基础。

明确包含哪些子项目(include)

最核心的操作是用 include 声明子项目目录。Gradle 会把每个参数当作一个子项目名称,并默认在对应相对路径下查找 build.gradle(或 build.gradle.kts)。

  • 基础写法:include "api", "service", "web" → 对应 api/、service/、web/ 三个子目录
  • 嵌套结构:include "core:utils", "core:network" → 创建层级化项目名,实际路径为 core/utils/ 和 core/network/
  • 自定义路径映射(较少用):include("legacy") 后加 project(":legacy").projectDir = file("../old-system")

统一管理项目名称(rootProject.name)

根项目的名称默认是根目录名,但可通过 rootProject.name 显式设置,避免因重命名目录导致构建脚本出错或 CI 脚本失效。

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • rootProject.name = "my-ecommerce-platform"
  • 子项目名称由 include 中的字符串决定,如 include "order", "payment",则完整路径为 :order、:payment
  • 名称中不能含空格或特殊字符,否则后续引用(如依赖声明 implementation project(':api'))会失败

按需启用/排除子项目(includeBuild / excludeProject)

大型项目常需组合多个代码仓库,或临时跳过某些模块:

  • includeBuild "../shared-libs":将外部独立的 Gradle 构建作为复合构建引入,其子项目也会被纳入依赖解析范围
  • 没有原生 exclude 指令,但可通过条件判断跳过:if (System.getenv("SKIP_INTEGRATION") != "true") { include "integration-tests" }
  • 注意:被跳过的子项目不会出现在 gradle projects 列表中,也不会参与任何构建生命周期

与 build.gradle 协同:项目间依赖靠这里声明

settings.gradle 不处理依赖 —— 它只让子项目“可见”。真正建立模块关系的是各子项目 build.gradle 中的 implementation project(':xxx')。

  • 例如 service/build.gradle 中写 implementation project(':api'),Gradle 才会在编译时把 api 的输出加入 classpath
  • 若 settings.gradle 没 include "api",该依赖声明会直接报错:Project with path ':api' could not be found
  • 建议配合 gradle --dry-run projects 验证子项目是否已正确定义

settings.gradle 是多项目结构的“地图”,画得准,后续所有依赖、构建、IDE 导入才不会迷路。不复杂但容易忽略。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java maven

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9957

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7102

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6252

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1084

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

888

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1316

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2609

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19951

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1175

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习