按需配置会尝试仅为请求的任务配置相关项目,即它只评估参与构建的项目的构建脚本文件。通过这种方式,可以减少大型多项目构建的配置时间。

按需配置功能是孵化中的,因此只有某些构建才能保证正常工作。该功能对于解耦的多项目构建效果良好。

在按需配置模式下,项目配置如下:

  • 根项目始终被配置。

  • 在构建执行目录中的项目也会被配置,但仅当 Gradle 在没有任何任务的情况下执行时。
    这样,当项目按需配置时,默认任务也能正常运行。

  • 标准项目依赖项受支持,并且会配置相关项目。
    如果项目 A 编译依赖于项目 B,那么构建 A 会导致两个项目都被配置。

  • 通过任务路径声明的任务依赖项受支持,并导致相关项目被配置。
    示例:someTask.dependsOn(":some-other-project:someOtherTask")

  • 从命令行(或工具 API)通过任务路径请求的任务会导致相关项目被配置。
    例如,构建 project-a:project-b:someTask 会导致 project-b 被配置。

启用 configuration-on-demand

您可以通过使用 --configure-on-demand 标志或将 org.gradle.configureondemand=true 添加到 gradle.properties 文件中来启用按需配置。

要每次构建都按需配置,请参阅Gradle 属性

要为给定构建按需配置,请参阅命令行性能优化选项

解耦项目

Gradle 允许项目在配置和执行阶段相互访问配置和任务。虽然这种灵活性赋予了构建作者能力,但它限制了 Gradle 执行优化(如并行项目构建按需配置)的能力。

当项目仅通过声明的依赖项和任务依赖项进行交互时,它们被认为是解耦的。任何直接修改或读取另一个项目的对象都会在项目之间创建耦合。配置期间的耦合在使用“按需配置”时可能导致构建结果错误,而执行期间的耦合会影响并行执行。

一个常见的耦合源是配置注入,例如在构建脚本中使用 allprojects{}subprojects{}

为避免耦合问题,建议:

  • 避免引用其他子项目的构建脚本,并优先从根项目进行跨项目配置

  • 避免在执行期间动态更改其他项目的配置。

随着 Gradle 的发展,它旨在提供利用解耦项目的功能,同时为常见的用例(如配置注入)提供解决方案,而不会引入耦合。

并行项目

Gradle 的并行执行功能通过并发执行来自不同项目的任务来优化 CPU 利用率以加速构建。

要启用并行执行,请使用 --parallel 命令行参数或配置您的构建环境。Gradle 会根据 CPU 核数自动确定最佳并行线程数。

在并行执行期间,每个工作进程专门处理一个特定的项目。任务依赖项得到尊重,工作进程会优先处理上游任务。但是,任务可能不会按字母顺序执行,就像在顺序模式下一样。正确声明任务依赖项和输入/输出对于避免顺序问题至关重要。