Wrapper

API 文件Wrapper

產生腳本 (適用於 *nix 和 Windows),讓您可以使用 Gradle 建置專案,而無需安裝 Gradle。

當使用者第一次執行 wrapper 腳本時,該腳本會下載並安裝適當的 Gradle 發行版,並針對此下載的發行版執行建置。使用 wrapper 腳本時,任何已安裝的 Gradle 發行版都會被忽略。

此任務產生的腳本旨在提交到您的版本控制系統。此任務還會產生一個小的 gradle-wrapper.jar 啟動 JAR 檔案和屬性檔案,這些檔案也應提交到您的 VCS。這些腳本委派給此 JAR。

屬性

屬性描述
archiveBase

archiveBase 指定是否應將解壓縮後的 wrapper 發行版儲存在專案中,或 Gradle 使用者家目錄中。

archivePath

gradle 發行版封存檔應儲存的路徑 (即父目錄)。此路徑相對於 archive base 目錄。

distributionBase

distributionBase 指定是否應將解壓縮後的 wrapper 發行版儲存在專案中,或 Gradle 使用者家目錄中。

distributionPath

wrapper 所需的 gradle 發行版解壓縮的路徑。此路徑相對於 distribution base 目錄

distributionType

wrapper 要使用的 Gradle 發行版類型。

distributionUrl

從中下載 gradle 發行版的 URL。

gradleVersion

wrapper 的 gradle 版本。

jarFile

要將 wrapper jar 檔案寫入的檔案。

networkTimeout
孵化中

networkTimeout 指定當 wrapper 執行網路操作時 (例如下載 wrapper jar) 要等待多少毫秒。

propertiesFile

要將 wrapper 屬性寫入的檔案。

scriptFile

要將 wrapper 腳本寫入的檔案。

validateDistributionUrl
孵化中

指出此任務是否會驗證已設定的發行版 URL。

方法

無方法

腳本區塊

無腳本區塊

屬性詳細資訊

PathBase archiveBase

archiveBase 指定是否應將解壓縮後的 wrapper 發行版儲存在專案中,或 Gradle 使用者家目錄中。

預設
PathBase.GRADLE_USER_HOME

String archivePath

gradle 發行版封存檔應儲存的路徑 (即父目錄)。此路徑相對於 archive base 目錄。

預設
'wrapper/dists'

PathBase distributionBase

distributionBase 指定是否應將解壓縮後的 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() 的預設值。

如果未設定 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 的未來版本中變更。

networkTimeout 指定當 wrapper 執行網路操作時 (例如下載 wrapper jar) 要等待多少毫秒。

預設
10000ms

File propertiesFile (唯讀)

要將 wrapper 屬性寫入的檔案。

預設
jarFile,以 .properties 取代 .jar

File scriptFile

要將 wrapper 腳本寫入的檔案。

預設
${project.projectDir}/gradlew

Property<Boolean> validateDistributionUrl

注意:此屬性為孵化中,並且可能在 Gradle 的未來版本中變更。

指出此任務是否會驗證已設定的發行版 URL。

預設
true