每个人都必须从某个地方开始,如果您是Gradle的新手,那么这就是开始的地方.

Before you start

为了有效地使用Gradle,您需要了解Gradle是什么并了解其一些基本概念. 因此,在您开始认真使用Gradle之前,我们强烈建议您阅读什么是Gradle? .

即使您有使用Gradle的经验,我们还是建议您阅读有关Gradle的第5部分要了解的知识,因为它可以消除一些常见的误解.

Installation

如果您要做的只是运行现有的Gradle构建,那么如果构建中有Gradle Wrapper ,则可以通过构建的根目录中的gradlew和/或gradlew.bat文件进行识别,而无需安装Gradle. 您只需要确保您的系统满足Gradle的前提条件即可 .

Android Studio随附了有效的Gradle安装,因此在这种情况下,您无需单独安装Gradle.

为了创建一个新的构建或将一个包装器添加到一个现有的构建,您将需要按照以下说明安装Gradle. 请注意,除了该页面上所述的方法以外,还有其他安装Gradle的方法,因为几乎不可能跟踪那里的所有软件包管理器.

Try Gradle

积极使用Gradle是了解它的一种好方法,因此,一旦安装了Gradle,请尝试以下入门实践教程之一:

There are also many other tutorials and guides available, which you can filter by category — for example Fundamentals.

Command line vs IDEs

有些人是核心命令行用户,而另一些人则更喜欢永远不要离开他们的IDE. 许多人愉快地使用两者,并且Gradle努力不歧视. 几个主要的IDE支持Gradle,并且可以通过Tooling API命令行中可以完成的所有操作提供给IDE.

Android Studio和IntelliJ IDEA用户在编辑它们时应考虑使用Kotlin DSL构建脚本来获得高级IDE支持.

Executing Gradle builds

如果您遵循上面链接的任何教程,您将执行Gradle构建. 但是,如果没有任何说明就获得了Gradle构建,该怎么办?

以下是一些有用的步骤:

  1. 确定项目是否有Gradle包装器, 如果有 ,请使用它 -主IDE在可用时默认使用包装器.

  2. 发现项目结构.

    可以使用IDE导入构建,也可以gradle projects运行gradle projects . 如果仅列出了根项目,则它是单项目构建. 否则,它是一个多项目构建 .

  3. 找出可以运行的任务.

    如果已将内部版本导入到IDE,则应该有权访问显示所有可用任务的视图. 从命令行运行gradle tasks .

  4. 通过gradle help --task <taskname>了解有关任务的更多信息.

    help任务可以显示有关任务的其他信息,包括哪些项目包含该任务以及该任务支持哪些选项.

  5. 运行您感兴趣的任务.

    许多基于约定的构建都与Gradle的生命周期任务集成在一起,因此,当您没有更具体的内容要使用该构建时,可以使用它们. 例如,大多数构建都有cleancheckassemblebuild任务.

    在命令行中,只需运行gradle <taskname>即可执行特定任务. 您可以在相应的用户手册章节中了解有关命令行执行的更多信息. 如果您使用的是IDE,请查看其文档以了解如何运行任务.

Gradle构建通常会在项目结构和任务上遵循标准约定,因此,如果您熟悉相同类型的其他构建(例如Java,Android或本机构建),那么构建的文件和目录结构也应熟悉以及许多任务和项目属性.

对于更专业的构建或具有重大定制的构建,理想情况下,您应该可以访问有关如何运行构建以及可以配置哪些构建属性的文档.

Authoring Gradle builds

学习创建和维护Gradle构建是一个过程,需要花费一些时间. 我们建议您从适用于您项目的适当核心插件及其约定开始,然后在您进一步了解该工具时逐渐合并自定义项.

以下是掌握Gradle的一些有用的第一步:

  1. 尝试一两个基本教程,以了解Gradle构建的外观,特别是与您使用的项目类型(Java,本机,Android等)相匹配的构建.

  2. 确保您已阅读有关Gradle的5件事

  3. 了解Gradle构建的基本元素: 项目任务文件API .

  4. 如果要为JVM构建软件,请确保在" 构建Java和JVM项目"以及" 在Java和JVM项目中测试"中阅读有关这些类型项目的详细信息 .

  5. 熟悉Gradle随附的核心插件 ,因为它们提供了许多开箱即用的有用功能.

  6. 了解如何编写可维护的构建脚本以及如何最好地组织Gradle项目 .

该用户手册包含许多其他有用的信息,并且您可以在Gradle Guides中找到有关Gradle各种功能的更多教程.

Integrating 3rd-party tools with Gradle

Gradle的灵活性意味着它可以轻松地与其他工具配合使用,例如在" Gradle和第三方工具"页面上列出的工具 .

集成有两种主要模式:

  • 工具通过Tooling API驱动Gradle(使用它来提取有关构建的信息并运行它)

  • Gradle通过第三方工具的API调用或生成工具信息-这通常是通过插件和自定义任务类型完成的

具有现有的基于Java的API的工具通常易于集成. 您可以在Gradle的插件门户上找到许多此类集成.