Gradle 管理的目录_Gradle中文网

Gradle 使用两个主要目录来执行和管理其工作：Gradle 用户主目录和项目根目录。

Gradle 用户主目录

默认情况下，Gradle 用户主页（~/.gradle或C:\Users\<USERNAME>\.gradle）存储全局配置属性、初始化脚本、缓存和日志文件。

可以通过环境变量来设置GRADLE_USER_HOME。

GRADLE_HOME不要与Gradle 的可选安装目录混淆。

其结构大致如下：

├── caches (1)
│   ├── 4.8 (2)
│   ├── 4.9 (2)
│   ├── ⋮
│   ├── jars-3 (3)
│   └── modules-2 (3)
├── daemon (4)
│   ├── ⋮
│   ├── 4.8
│   └── 4.9
├── init.d (5)
│   └── my-setup.gradle
├── jdks (6)
│   ├── ⋮
│   └── jdk-14.0.2+12
├── wrapper
│   └── dists (7)
│       ├── ⋮
│       ├── gradle-4.8-bin
│       ├── gradle-4.9-all
│       └── gradle-4.9-bin
└── gradle.properties (8)

1	全局缓存目录（用于所有非项目特定的内容）。
2	版本特定的缓存（例如，支持增量构建）。
3	共享缓存（例如，用于依赖项的工件）。
4	Gradle Daemon的注册表和日志。
5	全局初始化脚本。
6	通过工具链支持下载的 JDK 。
7	由Gradle Wrapper下载的发行版。
8	全局Gradle 配置属性。

清理缓存和分发

Gradle 会自动清理其用户主目录。

默认情况下，当 Gradle 守护程序停止或关闭时，清理工作在后台运行。

如果使用--no-daemon，它会在构建会话后在前台运行。

定期应用以下清理策略（默认情况下，每 24 小时一次）：

检查所有目录中特定于版本的缓存caches/<GRADLE_VERSION>/是否仍在使用。

否则，发布版本的目录将在 30 天不活动后被删除，快照版本的目录将在 7 天后被删除。
caches/检查(例如)中的共享缓存jars-*是否仍在使用。

如果没有 Gradle 版本仍在使用它们，它们将被删除。
检查当前 Gradle 版本caches/（例如jars-3或）中使用的共享缓存中的文件的上次访问时间。modules-2

根据文件是否可以在本地重新创建或从远程存储库下载，该文件将分别在 7 天或 30 天后删除。
检查Gradle 发行版wrapper/dists/是否仍在使用，即是否存在相应的特定于版本的缓存目录。

未使用的发行版将被删除。

配置缓存和分发的清理

可以配置各种缓存的保留期限。

缓存分为四类：

已发布的包装器发行版：与已发行版本相对应的发行版和相关版本特定缓存（例如，4.6.2或8.0）。

未使用版本的默认保留期为 30 天。
快照包装器发行版：与快照版本相对应的发行版和相关版本特定缓存（例如7.6-20221130141522+0000）。

未使用版本的默认保留期为 7 天。
下载的资源：从远程存储库下载的共享缓存（例如，缓存的依赖项）。

未使用资源的默认保留期为 30 天。
创建的资源： Gradle 在构建期间创建的共享缓存（例如，工件转换）。

未使用资源的默认保留期为 7 天。

每个类别的保留期可以通过 Gradle 用户主页中的 init 脚本独立配置：

gradleUserHome/init.d/cache-settings.gradle.kts

beforeSettings {
    caches {
        releasedWrappers.setRemoveUnusedEntriesAfterDays(45)
        snapshotWrappers.setRemoveUnusedEntriesAfterDays(10)
        downloadedResources.setRemoveUnusedEntriesAfterDays(45)
        createdResources.setRemoveUnusedEntriesAfterDays(10)
    }
}

gradleUserHome/init.d/cache-settings.gradle

beforeSettings { settings ->
    settings.caches {
        releasedWrappers.removeUnusedEntriesAfterDays = 45
        snapshotWrappers.removeUnusedEntriesAfterDays = 10
        downloadedResources.removeUnusedEntriesAfterDays = 45
        createdResources.removeUnusedEntriesAfterDays = 10
    }
}

调用缓存清理的频率也是可配置的。

有三种可能的设置：

默认：在后台定期执行清理（目前每 24 小时一次）。
禁用：切勿清理 Gradle 用户主页。

这在 Gradle User Home 是短暂的或者需要延迟清理直到明确的点的情况下非常有用。
始终：在每个构建会话结束时执行清理。

这在需要确保在继续之前进行清理的情况下非常有用。

但是，这会在构建期间（而不是在后台）执行缓存清理，这可能会很昂贵，因此仅应在必要时使用此选项。

要禁用缓存清理：

gradleUserHome/init.d/cache-settings.gradle.kts

beforeSettings {
    caches {
        cleanup = Cleanup.DISABLED
    }
}

gradleUserHome/init.d/cache-settings.gradle

beforeSettings { settings ->
    settings.caches {
        cleanup = Cleanup.DISABLED
    }
}

缓存清理设置只能通过 init 脚本进行配置，并且应放置init.d在 Gradle User Home 的目录下。这有效地将缓存清理的配置耦合到这些设置所应用的 Gradle 用户主页，并限制了将来自不同项目的不同冲突设置应用于同一目录的可能性。

多个版本的 Gradle 共享一个 Gradle 用户主页

在多个版本的 Gradle 之间共享一个 Gradle 用户主页是很常见的。

如上所述，Gradle User Home 中的缓存是特定于版本的。不同版本的 Gradle 将仅对与每个版本关联的特定于版本的缓存执行维护。

另一方面，一些缓存在版本之间共享（例如，依赖性工件缓存或工件变换缓存）。

从 Gradle 版本 8.0 开始，可以将缓存清理设置配置为自定义保留期。但是，旧版本有固定的保留期（7 或 30 天，具体取决于缓存）。这些共享缓存可以通过具有不同设置的 Gradle 版本来访问，以保留缓存工件。

这意味着：

如果未自定义保留期，则所有执行清理的版本将具有相同的保留期。多个版本共享一个 Gradle User Home 不会有任何影响。
如果为大于或等于版本 8.0 的 Gradle 版本自定义保留期以使用比之前固定期限更短的保留期，也不会产生任何影响。

了解这些设置的 Gradle 版本将比之前固定的保留期更早地清理工件，而旧版本实际上不会参与共享缓存的清理。
如果为大于或等于版本 8.0 的 Gradle 版本自定义保留期以使用比之前固定期限更长的保留期，则旧版本的 Gradle 可能会比配置的更早清理共享缓存。

在这种情况下，如果需要为新版本维护这些共享缓存条目更长的保留期，它们将无法与旧版本共享 Gradle 用户主页。他们将需要使用单独的目录。

与 8.0 之前的 Gradle 版本共享 Gradle 用户主页时的另一个考虑因素是，用于配置缓存保留设置的 DSL 元素在早期版本中不可用，因此必须在版本之间共享的任何初始化脚本中考虑到这一点。这可以通过有条件地应用版本兼容的脚本来轻松处理。

版本兼容的脚本应该驻留在init.d目录之外的其他位置（例如子目录），因此不会自动应用它。

要以版本安全的方式配置缓存清理：

gradleUserHome/init.d/cache-settings.gradle.kts

if (GradleVersion.current() >= GradleVersion.version("8.0")) {
    apply(from = "gradle8/cache-settings.gradle.kts")
}

gradleUserHome/init.d/cache-settings.gradle

if (GradleVersion.current() >= GradleVersion.version('8.0')) {
    apply from: "gradle8/cache-settings.gradle"
}

版本兼容的缓存配置脚本：

gradleUserHome/init.d/gradle8/cache-settings.gradle.kts

beforeSettings {
    caches {
        releasedWrappers { setRemoveUnusedEntriesAfterDays(45) }
        snapshotWrappers { setRemoveUnusedEntriesAfterDays(10) }
        downloadedResources { setRemoveUnusedEntriesAfterDays(45) }
        createdResources { setRemoveUnusedEntriesAfterDays(10) }
    }
}

gradleUserHome/init.d/gradle8/cache-settings.gradle

beforeSettings { settings ->
    settings.caches {
        releasedWrappers.removeUnusedEntriesAfterDays = 45
        snapshotWrappers.removeUnusedEntriesAfterDays = 10
        downloadedResources.removeUnusedEntriesAfterDays = 45
        createdResources.removeUnusedEntriesAfterDays = 10
    }
}

缓存标记

从 Gradle 版本 8.1 开始，Gradle 支持使用CACHEDIR.TAG文件标记缓存。

它遵循缓存目录标记规范中描述的格式。该文件的目的是让工具能够识别不需要搜索或备份的目录。

默认情况下， Gradle 用户主页中的目录caches、wrapper/dists、daemon、和都标有此文件。jdks

配置缓存标记

缓存标记功能可以通过 Gradle 用户主页中的 init 脚本进行配置：

gradleUserHome/init.d/cache-settings.gradle.kts

beforeSettings {
    caches {
        // Disable cache marking for all caches
        markingStrategy = MarkingStrategy.NONE
    }
}

gradleUserHome/init.d/cache-settings.gradle

beforeSettings { settings ->
    settings.caches {
        // Disable cache marking for all caches
        markingStrategy = MarkingStrategy.NONE
    }
}

缓存标记设置只能通过 init 脚本进行配置，并且应放置init.d在 Gradle User Home 的目录下。这有效地将缓存标记的配置耦合到应用这些设置的 Gradle 用户主页，并限制将来自不同项目的不同冲突设置应用于同一目录的可能性。

项目根目录

项目根目录包含项目中的所有源文件。

它还包含 Gradle 生成的文件和目录，例如.gradle和build。

虽然前者通常会签入源代码管理，但后者是 Gradle 用于支持增量构建等功能的临时文件。

典型项目根目录的剖析如下：

├── .gradle                 (1)
│   ├── 4.8                 (2)
│   ├── 4.9                 (2)
│   └── ⋮
├── build                   (3)
├── gradle
│   └── wrapper             (4)
├── gradle.properties       (5)
├── gradlew                 (6)
├── gradlew.bat             (6)
├── settings.gradle.kts     (7)
├── subproject-one          (8)
|   └── build.gradle.kts    (9)
├── subproject-two          (8)
|   └── build.gradle.kts    (9)
└── ⋮

1	Gradle 生成的项目特定的缓存目录。
2	版本特定的缓存（例如，支持增量构建）。
3	该项目的构建目录，Gradle 在其中生成所有构建工件。
4	包含Gradle Wrapper的 JAR 文件和配置。
5	项目特定的Gradle 配置属性。
6	使用Gradle Wrapper执行构建的脚本。
7	定义子项目列表的项目设置文件。
8	通常，一个项目被组织成一个或多个子项目。
9	每个子项目都有自己的 Gradle 构建脚本。

项目缓存清理

从版本 4.10 开始，Gradle 会自动清理项目特定的缓存目录。

构建项目后，.gradle/8.7/会定期（最多每 24 小时）检查中特定于版本的缓存目录，以确定它们是否仍在使用。如果 7 天未使用，它们将被删除。

下一步： 了解 Gradle 构建生命周期>>

此页面是否有帮助？