API 文档 | Wrapper |
---|
生成脚本(适用于 *nix 和 Windows),让您可以使用 Gradle 构建项目,而无需安装 Gradle。
当用户第一次执行 wrapper 脚本时,脚本会下载并安装相应的 Gradle 分发版,并使用此下载的分发版运行构建。使用 wrapper 脚本时,任何已安装的 Gradle 分发版都将被忽略。
此任务生成的脚本旨在提交到您的版本控制系统。此任务还会生成一个小的 gradle-wrapper.jar
引导 JAR 文件和属性文件,这些文件也应提交到您的 VCS。脚本会委托给此 JAR。
属性 | 描述 |
archiveBase | 存档基础指定解压后的 wrapper 分发版应存储在项目目录还是 Gradle 用户主目录中。 |
archivePath | Gradle 分发版存档应保存的路径(即父目录)。该路径是相对于存档基础目录的。 |
distributionBase | 分发基础指定解压后的 wrapper 分发版应存储在项目目录还是 Gradle 用户主目录中。 |
distributionPath | wrapper 所需的 Gradle 分发版解压到的路径。该路径是相对于分发基础目录的。 |
distributionType | wrapper 应使用的 Gradle 分发版类型。 |
distributionUrl | 下载 Gradle 分发版的 URL。 |
gradleVersion | wrapper 的 Gradle 版本。 |
jarFile | 写入 wrapper jar 文件的文件。 |
networkTimeout | 孵化中 网络超时指定 wrapper 执行网络操作(例如下载 wrapper jar)时等待的毫秒数。 |
propertiesFile | 写入 wrapper 属性的文件。 |
scriptFile | 写入 wrapper 脚本的文件。 |
validateDistributionUrl | 孵化中 指示此任务是否将验证已配置的分发 URL。 |
PathBase
distributionBase
分发基础指定解压后的 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"
)。