讲师中心 微信公众号
AI工具推荐 视频效率加速

Gradle include和includeBuild应该怎么选

秋涛小哥_1424

秋涛小哥_1424

发布时间:2026-10-31 11:49:00

|

625人浏览过

|

来源于php中文网

原创

该用include时是将本地项目作为子模块纳入同一构建,共享生命周期和配置;必须用includeBuild时是两个独立项目通过坐标匹配实现源码级依赖替换,保持构建隔离性。

gradle include和includebuild应该怎么选

什么时候该用 include,而不是 includeBuild

当你想把另一个本地项目“变成自己构建的一部分”,也就是让它和当前项目共享同一个 settings.gradle、同一个构建生命周期、同一个 Gradle Daemon 实例,就选 include。典型场景是:你正在拆分一个单体项目,把模块逐步独立成子项目,但还没到物理分离的程度;或者你维护的是一个统一仓库里的多模块 Android 项目(比如 :app、:network、:common),所有模块都在同一 Git 仓库下。

这时候你改 common 的代码,运行 ./gradlew assembleDebug,app 会自动编译并使用最新的 common 字节码——因为它们根本就是同一个构建里的两个 Project 实例。

  • include 要求被引入项目必须是子目录(或通过相对路径可定位),且不能有自己独立的 settings.gradle
  • IDEA 同步后,被 include 的模块会出现在 Project 视图里,作为普通 module 显示
  • 依赖写法是 implementation project(':common'),不是坐标形式
  • 如果被引入项目本身也用了 includeBuild 或含 pluginManagement 块,容易触发冲突或同步失败

什么时候必须用 includeBuild

当你手头有两个完全独立的 Gradle 项目(不同 Git 仓库、不同根目录、各自有完整的 settings.gradle 和 build.gradle),又不想 publish 到本地 Maven,只想让主项目在编译时“临时替换”某个远端坐标为本地源码,就只能用 includeBuild。

比如你正在开发一个 SDK(my-sdk),同时在业务 App(my-app)里验证它。SDK 已经定义了发布坐标 com.example:my-sdk:2.1.0,App 的 build.gradle 里写的是 implementation 'com.example:my-sdk:2.1.0'。这时你在 my-app/settings.gradle 里加一行 includeBuild '../my-sdk',Gradle 就会在解析依赖时,自动用 my-sdk 的源码构建结果替代远程仓库里同坐标的 jar/aar。

  • 被 includeBuild 的项目必须有合法的 settings.gradle,且不能是另一个复合构建(即不能自己也调了 includeBuild)
  • 坐标(group、name、version)必须严格匹配,否则 Gradle 不会替换,仍走远端仓库
  • IDEA 同步后,my-sdk 不会显示为 module,只在 External Libraries 下以 “Composite Build” 标识出现
  • 执行 ./gradlew dependencies 可看到该依赖标记为 composite build

includeBuild 常见失效原因

最常遇到的不是配不对,而是“配对了但没生效”。根本原因是 Gradle 的依赖解析顺序和坐标匹配机制比表面看起来更严格。

  • 被引入项目的 build.gradle 没正确声明 group 和 version(例如只在 publishing 块里写了,但没在 project.group 和 project.version 设值)
  • 主项目依赖写的是 implementation project(':xxx'),而 includeBuild 只响应坐标依赖,两者不兼容
  • 远端仓库(如 Maven Central)恰好存在同名同版本构件,且仓库优先级高于 composite build —— Gradle 默认不会覆盖,除非明确禁用远端仓库或用 resolutionStrategy 强制 force
  • 路径含空格或中文,Windows 下尤其容易触发 Project directory not part of the build 错误,建议全英文路径

一个容易被忽略的细节:构建隔离性

include 是强耦合:两个项目共用一套插件版本、JDK 配置、dependencyResolutionManagement 块。改一个地方,可能影响所有子项目。

includeBuild 是弱耦合:每个构建保持自己的插件、Java 版本、仓库配置。但代价是:如果 my-sdk 用了 Java 17,而 my-app 还在 Java 11,构建会失败——Gradle 不会帮你降级编译器,它只负责把构建结果“连起来”。

所以真正要选哪个,关键不在“怎么配”,而在“你愿不愿意让这两个项目共享构建上下文”。如果答案是否定的,哪怕多配几行,也该用 includeBuild。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

更多
Java Maven/Gradle 构建与依赖管理合集
Java Maven/Gradle 构建与依赖管理合集

系统讲解 Java 项目构建工具的使用与进阶配置,涵盖 Maven 的 POM 文件结构、生命周期(clean/compile/package/install/deploy)与插件机制、依赖范围(compile/provided/test/runtime)与传递依赖管理、多模块聚合与继承、私有 Nexus 仓库发布,以及 Gradle 的 Groovy / Kotlin DSL 语法、Task 自定义与增量构建、依赖版本目录(Versi

389

2026.05.09

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

40

2026.10.28

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

120

2026.10.28

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

140

2026.10.22

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

120

2026.10.22

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

80

2026.10.22

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

40

2026.10.22

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

80

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gradle 9 主版本升级指南
Gradle 9 主版本升级指南

共0课时 | 0人学习

Gradle 安全最佳实践
Gradle 安全最佳实践

共0课时 | 0人学习

Gradle 依赖校验手册
Gradle 依赖校验手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn