Gradle Wrapper 完全指南

Gradle 是一個功能強大的構建自動化工具，可以幫助我們自動化構建、測試、打包、部署等各種開發流程。它是一款基於 Jvm 平台的構建工具，相較於 Maven 和 Ant，具有更加靈活的構建腳本、更好的依賴管理和性能優化等優點。然而，Gradle 在其早期版本中存在一些問題，例如版本兼容性問題、構建速度較慢等問題。在這個時候，Gradle Wrapper 的出現給我們帶來了更加便利的構建方式。本文將詳細講解 Gradle Wrapper 的相關概念、使用方法和優勢，希望能幫助開發者更加高效地使用 Gradle 進行構建。

一、Gradle Wrapper 是什麼？

Gradle Wrapper 是 Gradle 構建工具的一個核心特性。它可以讓我們在項目中嵌入 Gradle 版本號，使得我們的項目不依賴於系統中是否安裝了 Gradle，即使在沒有安裝 Gradle 的環境下，我們也可以通過 Gradle Wrapper 進行構建。使用 Gradle Wrapper 進行構建，可以保證每個人都使用相同的 Gradle 版本，避免因版本不同造成的構建失敗等問題。Gradle Wrapper 可以自動下載和安裝指定版本的 Gradle，同時也提供了一些在構建時可用的屬性，以便於控制我們構建的過程。

二、Gradle Wrapper Main 和 Gradle Wrapper 文件在什麼位置？

Gradle Wrapper 主要包含兩個文件：gradlew 和 gradlew.bat，它們分別是 Unix 和 Windows 平台 Gradle Wrapper 的啟動腳本。這兩個腳本都會調用 Gradle Wrapper 根目錄下的 gradle-wrapper.jar 文件。gradle-wrapper.jar 文件是 Gradle Wrapper 的核心組件，它包含了所有的 Gradle Wrapper 相關邏輯和依賴。

Gradle Wrapper 的 main class 是 org.gradle.wrapper.GradleWrapperMain，它是 Gradle Wrapper 的主入口。Gradle Wrapper 啟動時，會通過 main class 來自動下載和安裝 Gradle 並設置相應的屬性。

默認情況下，Gradle Wrapper 文件會在項目的根目錄下自動生成，我們可以在項目的根目錄下執行以下命令生成 Gradle Wrapper 文件夾及相應文件：

 gradle wrapper 

該命令會生成 Gradle Wrapper 文件夾、gradlew 和 gradlew.bat 文件和一個 gradle/wrapper 目錄，該目錄包含 gradle-wrapper.properties 文件和 gradle-wrapper.jar 文件。gradle-wrapper.properties 文件定義了 Gradle Wrapper 的一些配置信息，例如要下載的 Gradle 版本和下載 Gradle 的地址。Gradle Wrapper 還允許我們修改這些屬性以滿足特定的需求。

三、Gradle Wrapper 的作用

使用 Gradle Wrapper 有以下幾個主要優點：

• 易於配置和使用：只需執行一條命令即可在項目中生成 Gradle Wrapper 相關文件，不需要手動下載和安裝 Gradle。
• 版本控制：Gradle Wrapper 會在項目中添加 gradle-wrapper.properties 文件，該文件包含了 Gradle 的版本號等信息，可以將其納入版本控制系統中，以實現團隊成員之間使用相同的 Gradle 版本。
• 開發環境隔離：Gradle Wrapper 可以在沒有安裝 Gradle 的環境下使用，相當於為每個項目創建了一個獨立的、隔離的 Gradle 環境。
• 自動更新：Gradle Wrapper 可以自動下載和安裝指定版本的 Gradle，當我們需要更換 Gradle 版本時，只需修改 gradle-wrapper.properties 文件中的版本號，再執行 gradlew 命令即可自動下載新版本。

四、Gradle Wrapper Properties 使用

Gradle Wrapper 提供了一些屬性可以用於配置我們的構建過程。我們可以創建或修改 gradle-wrapper.properties 文件，以實現對這些屬性進行設置。下面是一些常用的屬性：

• distributionUrl：指定要下載的 Gradle 版本，例如：distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-all.zip
• zipStoreBase：指定下載 Gradle 的存儲路徑，例如：zipStoreBase=gradle/wrapper/dists
• zipStorePath：指定下載 Gradle 的本地路徑，例如：zipStorePath=gradle/wrapper/dists/gradle-6.3-all.zip
• distributionSha256Sum：下載的 Gradle 文件的 sha256 校驗和，確保下載的文件是正確的。

修改 gradle-wrapper.properties 文件後，我們需要執行以下命令來下載和安裝指定版本的 Gradle：

./gradlew wrapper --gradle-version=6.3 

這條命令會從 distributionUrl 指定的地址下載 Gradle，然後更新 gradle-wrapper.properties 文件中的 distributionSha256Sum 屬性，最後將下載的 Gradle 解壓縮到 zipStoreBase 和 zipStorePath 所指定的位置。

五、Gradle Wrapper 使用示例

以下是一個使用 Gradle Wrapper 構建 Java 項目的示例：

1、創建項目

首先，我們創建一個 Java 項目。在項目根目錄下創建一個 HelloWorld.java 文件，並編寫以下代碼：

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
} 

2、初始化 Gradle Wrapper

接着，我們在項目根目錄下執行以下命令生成 Gradle Wrapper 相關文件：

gradle wrapper 

3、構建項目

完成初始化後，我們使用 Gradle Wrapper 進行項目構建，執行以下命令：

./gradlew build 

該命令會下載並安裝 Gradle，並編譯、測試和打包我們的 Java 項目。

結語

本文對 Gradle Wrapper 進行了詳細的闡述，包括其作用、在項目中的位置、關鍵特徵和使用技巧等。通過使用 Gradle Wrapper，我們可以避免 Gradle 版本不一致、構建時間長等問題，提高構建效率，同時也能夠更好地管理我們的項目。相信本文可以幫助讀者更好地理解和運用 Gradle Wrapper。