Wrapper

API 文档Wrapper

生成脚本(适用于 *nix 和 windows),让您可以使用 Gradle 构建项目,而无需安装 Gradle。

用户首次执行 wrapper 脚本时,脚本会下载并安装相应的 Gradle 分发版,并使用此下载的分发版运行构建。使用 wrapper 脚本时,任何已安装的 Gradle 分发版都会被忽略。

此任务生成的脚本旨在提交到您的版本控制系统。此任务还会生成一个小的 gradle-wrapper.jar 引导 JAR 文件和 properties 文件,这些文件也应提交到您的 VCS。脚本委托给此 JAR 文件。

属性

属性描述
archiveBase

archive base 指定解压后的 wrapper 分发版应存储在项目目录还是 gradle 用户主目录中。

archivePath

应保存 gradle 分发版存档的路径(即父目录)。该路径是相对于 archive base 目录的。

distributionBase

distribution base 指定解压后的 wrapper 分发版应存储在项目目录还是 gradle 用户主目录中。

distributionPath

wrapper 所需的 gradle 分发版解压到的路径。该路径是相对于 distribution base 目录的

distributionType

wrapper 应使用的 Gradle 分发版类型。

distributionUrl

下载 gradle 分发版的 URL。

gradleVersion

wrapper 的 gradle 版本。

jarFile

写入 wrapper jar 文件的路径。

networkTimeout
孵化中

网络超时指定 wrapper 执行网络操作(如下载 wrapper jar)时等待的毫秒数。

propertiesFile

写入 wrapper properties 的路径。

scriptFile

写入 wrapper 脚本的路径。

validateDistributionUrl
孵化中

指示此任务是否会验证已配置的 distribution url。

方法

无方法

脚本块

无脚本块

属性详情

PathBase archiveBase

archive base 指定解压后的 wrapper 分发版应存储在项目目录还是 gradle 用户主目录中。

默认值
PathBase.GRADLE_USER_HOME

String archivePath

应保存 gradle 分发版存档的路径(即父目录)。该路径是相对于 archive base 目录的。

默认值
'wrapper/dists'

PathBase distributionBase

distribution base 指定解压后的 wrapper 分发版应存储在项目目录还是 gradle 用户主目录中。

默认值
PathBase.GRADLE_USER_HOME

String distributionPath

wrapper 所需的 gradle 分发版解压到的路径。该路径是相对于 distribution base 目录的

默认值
'wrapper/dists'

DistributionType distributionType

wrapper 应使用的 Gradle 分发版类型。

默认值
DistributionType.BIN

String distributionUrl

下载 gradle 分发版的 URL。

如果未设置,则下载 URL 是指定的 Wrapper.getGradleVersion() 的默认 URL。

如果未设置 Wrapper.getGradleVersion(),则返回 null。

wrapper 只下载一次某个分发版并对其进行缓存。如果您的 distribution base 是项目目录,您可以将该分发版提交到您的版本控制系统。这样就完全不需要下载了。如果您为 wrapper 提供一个自定义的 gradle 快照,这可能特别有用,因为那样您就不需要提供下载服务器了。

默认值
"http\://services.gradle.org/distributions/gradle-${gradleVersion}-bin.zip"(对于快照版本,则是 "http\://services.gradle.org/distributions-snapshots/gradle-${gradleVersion}-bin.zip")。

String gradleVersion

wrapper 的 gradle 版本。

默认值
gradle.gradleVersion

File jarFile

写入 wrapper jar 文件的路径。

默认值
${project.projectDir}/gradle/wrapper/gradle-wrapper.jar

Property<Integer> networkTimeout

注意:此属性处于孵化中,在未来版本的 Gradle 中可能会发生变化。

网络超时指定 wrapper 执行网络操作(如下载 wrapper jar)时等待的毫秒数。

默认值
10000毫秒

File propertiesFile (只读)

写入 wrapper properties 的路径。

默认值
jarFile,将 .jar 替换为 .properties

File scriptFile

写入 wrapper 脚本的路径。

默认值
${project.projectDir}/gradlew

Property<Boolean> validateDistributionUrl

注意:此属性处于孵化中,在未来版本的 Gradle 中可能会发生变化。

指示此任务是否会验证已配置的 distribution url。

默认值
true