学习 Gradle 缓存系统的基础知识。

在本节中您将

  • 开启本地构建缓存

  • 理解缓存

  • 探索远程构建缓存

步骤 0. 开始之前

  1. 您已在第 1 部分中初始化了 Java 应用。

  2. 您已在第 2 部分中运行了几个任务。

  3. 您已在第 3 部分中学习了依赖管理。

  4. 您已在第 4 部分中为您的应用应用了插件。

  5. 您已在第 5 部分中学习了增量构建。

步骤 1. 理解缓存

增量构建是一项出色的优化,有助于避免重复完成已完成的工作。如果开发者持续修改单个文件,很可能无需重建项目中的所有其他文件。

然而,当同一开发者决定切换到上周创建的新分支时会发生什么?即使开发者正在构建之前已构建过的内容,文件仍会被重建。

这就是构建缓存的用武之地。缓存存储以前的构建结果,极大地减少了本地已构建内容再次重建的需要。

让我们首先为您的应用开启本地构建缓存。

步骤 2. 启用本地构建缓存

使用 ./gradlew :app:clean :app:build 命令运行 clean 任务,然后运行 build 任务

$ ./gradlew :app:clean :app:build
> Task :app:clean
> Task :app:compileJava
> Task :app:processResources NO-SOURCE
> Task :app:classes
> Task :app:jar
> Task :app:startScripts
> Task :app:distTar
> Task :app:distZip
> Task :app:assemble
> Task :app:compileTestJava
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses
> Task :app:test
> Task :app:check
> Task :app:build

BUILD SUCCESSFUL in 1s
8 actionable tasks: 8 executed

gradle.properties 文件中添加 org.gradle.caching=true

gradle.properties
org.gradle.console=verbose
org.gradle.caching=true

步骤 3. 使用本地构建缓存

运行 build 任务填充本地构建缓存

$ ./gradlew :app:build

> Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar UP-TO-DATE
> Task :app:startScripts UP-TO-DATE
> Task :app:distTar UP-TO-DATE
> Task :app:distZip UP-TO-DATE
> Task :app:assemble UP-TO-DATE
> Task :app:compileTestJava UP-TO-DATE
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses UP-TO-DATE
> Task :app:test UP-TO-DATE
> Task :app:check UP-TO-DATE
> Task :app:build UP-TO-DATE

BUILD SUCCESSFUL in 409ms
7 actionable tasks: 7 up-to-date

这并不意外,多亏了增量构建,Gradle 注意到没有任何变化。然而,在后台,本地构建缓存已经被填充。

让我们再次运行 clean 和 build

$ ./gradlew :app:clean :app:build

> Task :app:clean
> Task :app:compileJava FROM-CACHE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar
> Task :app:startScripts
> Task :app:distTar
> Task :app:distZip
> Task :app:assemble
> Task :app:compileTestJava FROM-CACHE
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses UP-TO-DATE
> Task :app:test FROM-CACHE
> Task :app:check UP-TO-DATE
> Task :app:build

BUILD SUCCESSFUL in 525ms
8 actionable tasks: 5 executed, 3 from cache

Gradle 在控制台输出中告诉我们每个任务的结果

  • FROM-CACHE - 任务已从本地构建缓存中获取。

  • UP-TO-DATE - 使用增量构建且未重新运行的任务。

总结

  1. 首先,我们使用 build 任务用任务输入和输出填充了本地缓存——我们可以想象这是在一周前完成的。

  2. 然后,我们使用 clean 任务来模拟切换分支——覆盖以前的输出。

  3. 最后,我们使用 build 任务——与增量构建不同,以前的输出存储在本地缓存中,可以重复使用。

Gradle 非常高效,尤其是在开启本地构建缓存后。Gradle 会查看您机器上的缓存目录,检查可能已存在的输出文件。如果存在,它会将其(输出)结果复制到您的项目 build 目录中,而不是运行该任务。

结果标签 FROM-CACHE 告知用户 Gradle 已从本地构建缓存中获取了任务结果。

本地 Gradle 构建缓存位于

  • 在 Windows 上: %USERPROFILE%\.gradle\caches

  • 在 OS X / UNIX 上: ~/.gradle/caches/

Gradle 会定期清理本地构建缓存目录,删除最近未使用的条目以节省磁盘空间。

步骤 4. 理解远程缓存

除了开发者机器上的本地构建缓存外,Gradle 还可以利用可供多个开发者使用的远程构建缓存。

远程缓存的理念是在远程构建之间共享常用构建任务的输出,以提高构建时间。

当远程和本地缓存都启用时,构建输出会首先在本地缓存中检查。如果本地缓存中不存在输出,它将从远程缓存下载,并也存储在本地缓存中。

要试用远程构建缓存,Gradle 提供了免费的Docker 镜像用于单个远程构建缓存节点。对于生产级部署,推荐使用Develocity

下一步: 使用参考资料 >>