API 文档 | Wrapper (Wrapper) |
---|
生成脚本(用于 *nix 和 Windows),允许您在不安装 Gradle 的情况下构建项目。
当用户首次执行 wrapper 脚本时,脚本会下载并安装适当的 Gradle 发行版,并针对此下载的发行版运行构建。使用 wrapper 脚本时,将忽略任何已安装的 Gradle 发行版。
此任务生成的脚本旨在提交到您的版本控制系统。此任务还会生成一个小的 gradle-wrapper.jar
引导 JAR 文件和属性文件,也应将其提交到您的 VCS。脚本委托给此 JAR。
属性 | 描述 |
archiveBase (归档库基准) | archive base 指定是否应将解压缩的 wrapper 发行版存储在项目或 gradle 用户主目录中。 |
archivePath (归档库路径) | gradle 发行版归档应保存的路径(即父目录)。该路径相对于归档库基准目录。 |
distributionBase (发行版基准) | distribution base 指定是否应将解压缩的 wrapper 发行版存储在项目或 gradle 用户主目录中。 |
distributionPath (发行版路径) | wrapper 需要的 gradle 发行版解压缩到的路径。该路径相对于发行版基准目录 |
distributionType (发行版类型) | wrapper 要使用的 Gradle 发行版的类型。 |
distributionUrl (发行版 URL) | 从中下载 gradle 发行版的 URL。 |
gradleVersion (Gradle 版本) | wrapper 的 gradle 版本。 |
jarFile (Jar 文件) | 用于写入 wrapper jar 文件的文件。 |
networkTimeout (网络超时) | 孵化中 network timeout 指定 wrapper 执行网络操作(例如下载 wrapper jar)时等待多少毫秒。 |
propertiesFile (属性文件) | 用于写入 wrapper 属性的文件。 |
scriptFile (脚本文件) | 用于写入 wrapper 脚本的文件。 |
validateDistributionUrl (验证发行版 URL) | 孵化中 指示此任务是否将验证已配置的发行版 URL。 |
PathBase
archiveBase
archive base 指定是否应将解压缩的 wrapper 发行版存储在项目或 gradle 用户主目录中。
- 默认值
PathBase.GRADLE_USER_HOME
PathBase
distributionBase
distribution base 指定是否应将解压缩的 wrapper 发行版存储在项目或 gradle 用户主目录中。
- 默认值
PathBase.GRADLE_USER_HOME
String
distributionUrl
从中下载 gradle 发行版的 URL。
如果未设置,则下载 URL 是指定 Wrapper.getGradleVersion()
的默认值。
如果未设置 Wrapper.getGradleVersion()
,将返回 null。
wrapper 仅下载一次特定发行版并缓存它。如果您的发行版基准是项目,则您可以将发行版提交到您的版本控制系统。这样就完全不需要下载。如果您向 wrapper 提供自定义 gradle 快照,这可能尤其有趣,因为您无需提供下载服务器。
- 默认值
"http\://services.gradle.org/distributions/gradle-${gradleVersion}-bin.zip"
(或快照版本的"http\://services.gradle.org/distributions-snapshots/gradle-${gradleVersion}-bin.zip"
)。
注意:此属性处于孵化中状态,并且可能在 Gradle 的未来版本中更改。
network timeout 指定 wrapper 执行网络操作(例如下载 wrapper jar)时等待多少毫秒。
- 默认值
10000
ms