Gradle Wrapper 完全指南

发布时间：2023-05-20

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。

推荐文章