Gradle 构建语言参考

配置当前项目及其每个子项目。

配置当前项目的已发布制品。

配置当前项目的构建脚本 classpath。

配置当前项目的依赖配置。

配置当前项目的依赖项。

配置当前项目的仓库。

配置当前项目的源集。

配置当前项目的子项目。

配置由发布插件添加的 PublishingExtension。

该接口是用于在构建文件中与 Gradle 交互的主要 API。从一个 Project 对象，你可以通过编程方式访问 Gradle 的所有功能。

一个 Task 表示构建中的一个原子工作单元，例如编译类或生成 javadoc。

表示 Gradle 的一个调用实例。

声明了实例化和配置将参与构建的 Project 实例层级所需的配置。

组合构建中包含的一个构建。

提供了访问项目几个重要位置的途径。

提供了访问 Gradle 构建重要位置的途径。

所有 Gradle Groovy DSL 脚本都实现了该接口，以添加一些 Gradle 特有的方法。由于你编译后的脚本类将实现此接口，因此你可以在脚本中直接使用此接口声明的方法和属性。

一个 SourceSet 表示 Java 源代码和资源文件的逻辑分组。在用户手册中有更详细的介绍。

所有输出目录（编译后的类、处理后的资源等）的集合 - 注意 SourceSetOutput 扩展了 FileCollection。

一个 SourceDirectorySet 表示由一组源目录组成的源文件集合，以及相关的包含和排除模式。

一个 Configuration 表示一组制品及其依赖项。有关向配置声明依赖项或管理配置的更多信息，请参阅 ConfigurationContainer 的文档。

一个可以通过发布和依赖管理消费的 Configuration。

一个执行依赖解析以构建依赖图并解析制品的 Configuration。

一个收集依赖项、依赖约束和排除规则的 Configuration。

定义了围绕依赖解析的策略。例如，强制使用特定的依赖版本、替换、冲突解决或快照超时设置。

一个构建器，用于构造可以解析指定组件的选定软件制品的查询。

表示一个模块的组件选择器和在组件选择规则中评估的候选版本组成的元组。

表示组件选择规则的容器。规则可以作为配置的 resolutionStrategy 的一部分应用，单个组件可以根据规则明确接受或拒绝。既未接受也未拒绝的组件将遵循默认的版本匹配策略。

一个 DependencyCollector 在 DSL 中用作 dependencies 块的一部分。收集器实现单个依赖范围，并在 DependencyCollector.getDependencies() 上暴露声明的依赖项。

可以在运行时通过其他对象进行扩展的对象。

Gradle 领域对象的额外、即席属性。

用于在脚本中声明要使用的插件的 DSL。

插件依赖项的可变规范。

配置如何解析插件。

用于创建 Provider 实例的工厂。

提供了访问特定于资源的实用方法，例如创建各种资源的工厂方法。

创建由字符串、文件和归档条目等源支持的 TextResource。

提供了访问需要由增量工作操作处理的所有输入文件的途径。

发行版允许捆绑应用程序或库，包括依赖项、源代码等...

配置如何“发布”项目的不同组件。

一个 IvyPublication 是 Gradle 如何以 Ivy 格式发布内容到 Ivy 仓库的表示/配置。通过提供 IvyPublication 作为类型，你可以直接向项目的 publishing.publications 容器添加一个命名 Ivy 发布项。

作为 IvyPublication 的一部分发布的制品。

一组要包含在 IvyPublication 中的 IvyArtifact 集合。作为 DomainObjectSet，IvyArtifactSet 提供了便捷的方法来查询、过滤和对 IvyArtifact 集合应用操作。

任何 Ivy 发布项的描述符。

Ivy 发布项的作者。

Ivy 发布项的许可证。

Ivy 发布项的描述。

一个 MavenPublication 是 Gradle 如何以 Maven 格式发布内容的表示/配置。通过提供 MavenPublication 作为类型，你可以直接向项目的 publishing.publications 容器添加一个命名 Maven 发布项。

作为 MavenPublication 的一部分发布的制品。

一组要包含在 MavenPublication 中的 MavenArtifact 集合。作为 DomainObjectSet，MavenArtifactSet 提供了便捷的方法来查询、过滤和对 MavenArtifact 集合应用操作。

Maven 发布项的 POM。

Maven 发布项的 CI 管理系统。

Maven 发布项的贡献者。

允许添加 Maven 发布项的贡献者。

Maven 发布项的开发者。

允许向 Maven 发布项添加开发者。

Maven 发布项的分发管理配置。

Maven 发布项的问题管理系统。

Maven 发布项的许可证。

允许向 Maven 发布项添加许可证。

Maven 发布项的邮件列表。

允许向 Maven 发布项添加邮件列表。

Maven 发布项的组织。

已迁移到新 group 和/或 artifact ID 的 Maven 发布项的重定位信息。

Maven 发布项的 SCM (源代码管理)。

一个 TaskContainer 负责管理一组 Task 实例。

一个 ConfigurationContainer 负责声明和管理配置。另请参阅 Configuration。

一个 RepositoryHandler 管理一组仓库，允许定义和查询仓库。

一个 DependencyHandler 用于声明依赖项。依赖项被分组到配置中（参见 Configuration）。

允许构建提供修改被依赖软件组件元数据的规则。组件元数据规则应用于构建脚本的 dependencies 块 DependencyHandler 的 components 部分。规则可以通过两种不同的方式定义

这个类用于定义要发布的制品并将它们添加到配置中。创建发布的制品并不意味着创建归档文件。创建的是一个表示待发布文件及其如何发布的领域对象（例如名称）。

支持用户名/密码认证的制品仓库。

用于不同认证目的的凭据的基础接口。（例如认证的 RepositoryHandler）

用于登录受密码保护的远程仓库的用户名/密码凭据。

表示用于通过 Amazon Web Services 进行认证的凭据。

可用于通过 HTTP 头部登录受保护服务器（例如远程仓库）的凭据。从属性创建凭据使用的属性是 repoAuthHeaderName 和 repoAuthHeaderValue，其中 repo 是仓库的标识符。

用于配置 Authentication 类型仓库认证方案的容器。

传输认证方案的基础接口。

基于 HTTP 的基本访问认证方案。使用此方案时，凭据会主动发送。

基于 HTTP 的 HTTP 头部认证方案。

基于 HTTP 的摘要访问认证方案。

整个 Gradle 构建的构建缓存配置。

本地目录构建缓存的配置对象。

HTTP 构建缓存的配置对象。缓存条目通过 GET 请求加载，通过 PUT 请求存储。

用于配置输入规范化。目前，只能配置运行时 classpath 规范化。

输入规范化配置。当 Gradle 尝试确定两个任务输入是否不同时，会使用输入规范化。Gradle 会规范化两个输入，当且仅当规范化结果不同时，输入才被视为不同。

运行时 classpath 规范化配置。

显示项目中的任务列表。当你从命令行执行 tasks 任务时，会使用此类型的实例。

显示构建中的项目列表。当你从命令行执行 projects 任务时，会使用此类型的实例。

显示项目的依赖树。当你从命令行执行 dependencies 任务时，会使用此类型的实例。

生成一个报告，尝试回答以下问题，例如

显示项目的属性。当你从命令行执行 properties 任务时，会使用此类型的实例。

显示有关项目生成的软件组件的一些详细信息。

显示依赖组件。

显示项目配置模型的一些详细信息。当你从命令行执行 model 任务时，会使用此类型的实例。

一个在命令行上报告项目输出变体的任务。这对于列出项目在变体方面生成的内容以及每个变体附加的制品很有用。在此上下文中，变体必须理解为“项目生成的可安全地被其他项目消费的内容”。

一个在命令行上报告项目可解析配置的任务。这对于确定与用于解析项目依赖项的可解析配置关联的属性很有用。输出可以帮助预测每个依赖项的哪个变体将被解析。

一个报告项目使用的制品转换（由 TransformAction 实现）信息的任务。这对于调查模糊的转换场景很有用。输出可以帮助预测需要修改哪些转换以消除歧义。

从 Antlr 语法生成解析器。

提供与任务关联的项目构建环境信息。

对某些源文件运行 Checkstyle。

对某些源文件运行 CodeNarc。

将文件复制到目标目录。此任务在复制时还可以重命名和过滤文件。此任务实现了 CopySpec 用于指定要复制的内容。

为启动 JVM 应用程序创建启动脚本。

删除文件或目录。示例

组装 EAR 归档文件。

执行命令行进程。示例

生成 Ivy XML 模块描述符文件。

生成 Maven 模块描述符 (POM) 文件。

生成构建仪表板报告。

执行 Gradle 构建。

编译 Groovy 源文件，以及可选地，Java 源文件。

为 Groovy 源代码生成 HTML API 文档，以及可选地，Java 源代码。

生成 HTML 依赖项报告。此报告结合了 ASCII 依赖项报告和 ASCII 依赖项洞察报告的功能。对于给定项目，它会生成每个配置的依赖项树，并且可以单击每个依赖项以显示其洞察信息。

生成 Jacoco 覆盖率数据的 HTML、Xml 和 CSV 报告的任务。

验证代码覆盖率指标的任务。如果根据指定的规则检测到违规，则任务失败。

组装 JAR 归档文件。

编译 Java 源文件。

为 Java 类生成 HTML API 文档。

在子进程中执行 Java 应用程序。

对 Java 源代码文件运行一组静态代码分析规则，并生成发现问题的报告。

将资源从其源目录复制到目标目录，并可能进行处理。确保目标目录中没有残留的陈旧资源。

将 IvyPublication 发布到 IvyArtifactRepository。

将 MavenPublication 发布到 MavenArtifactRepository。

编译 Scala 源文件，以及可选地，Java 源文件。

为 Scala 源文件生成 HTML API 文档。

生成或更新 Gradle Daemon 的 JVM 标准。这控制了运行 Gradle Daemon 所需的 JVM 版本。

生成 Gradle 项目结构。

一个用于为一个或多个任务、文件、可发布制品或配置创建数字签名文件的任务。

将目标目录的内容与一些源目录和文件同步。

组装 TAR 归档文件。

所有测试任务的抽象类。

执行 JUnit (3.8.x, 4.x 或 5.x) 或 TestNG 测试。测试始终在（一个或多个）单独的 JVM 中运行。

根据一个或多个 Test 任务的结果生成 HTML 测试报告。

组装 WAR 归档文件。

生成脚本（适用于 *nix 和 Windows），它们允许你使用 Gradle 构建项目，而无需安装 Gradle。

以结果可重复的方式写入 Properties。

组装 ZIP 归档文件。默认是压缩 zip 的内容。

此 DSL 元素用于包含一个 TestSuite 集合。

基础测试套件组件。测试套件是测试的集合。

测试套件是基于 JVM 的测试集合。

基础测试套件目标。测试套件目标是在特定上下文（操作系统、Java 运行时等）中运行的测试集合。

定义了 JvmTestSuite 将在其上运行的目标环境。

执行 JUnit (3.8.x, 4.x 或 5.x) 或 TestNG 测试。测试始终在（一个或多个）单独的 JVM 中运行。

对所有 dependencies 块可用的通用 API。

对可以构建依赖于 Gradle API 的软件的 dependencies 块可用的依赖项 API。

可以在其他模块中查找 test fixtures 的依赖项修饰符 API，适用于 dependencies 块。

可以在其他模块中查找 platform 和 enforced platforms 的依赖项修饰符 API，适用于 dependencies 块。

此 DSL 元素用于向组件添加依赖项，例如一个 TestSuite

一种可以通过 XSLT 样式表定制生成的 HTML 报告。

一个单个文件的报告。

一个基于目录的待创建报告。

一个基于文件的待创建报告。

提供报告选项的对象。

一个包含 Report 对象的容器，它们代表潜在的报告。

一个名为“reporting”的项目扩展，它提供了基本的报告设置和实用功能。

聚合测试报告输入的容器。

聚合 JaCoCo 代码覆盖率报告输入的容器。

Eclipse 项目信息的 DSL 友好模型。自定义 Eclipse 项目生成的第一个入口点。

允许微调 Eclipse 插件的项目详情 (.project 文件)

生成的 Eclipse 项目的构建路径设置。由 GenerateEclipseClasspath 任务使用，生成 Eclipse .classpath 文件。

允许微调 Eclipse 插件的 jdt 详情

允许微调 Eclipse 插件的 wtp/wst 详情

允许微调 Eclipse 插件的 wtp 组件详情

允许微调 Eclipse 插件的 wtp facet 详情

IDEA 项目信息的 DSL 友好模型。自定义 IDEA 生成的第一个入口点。

允许微调 IDEA 插件的项目详情 (*.ipr 文件)。

允许微调 IDEA 插件的模块详情 (*.iml 文件)。

允许微调 IDEA 插件的工作空间详情 (*.iws 文件)。

建模生成/解析/合并能力。添加与 XML 相关的钩子。

建模生成/解析/合并能力。

生成 Eclipse .project 文件。如果要微调 eclipse 配置

生成 Eclipse .classpath 文件。如果要微调 eclipse 配置

生成 Eclipse JDT 配置文件。如果要微调 eclipse 配置

为 Eclipse WTP 生成 org.eclipse.wst.common.component 设置文件。如果要微调 eclipse 配置

为 Eclipse WTP 生成 org.eclipse.wst.common.project.facet.core 设置文件。如果要微调 eclipse 配置

生成 IDEA 模块文件。如果要微调 idea 配置

仅为根项目生成 IDEA 项目文件 *。如果要微调 idea 配置

仅为根项目生成 IDEA 工作空间文件 *。目前几乎无法配置工作空间生成。

生成 Xcode Scheme 文件（例如 Foo.xcodeproj/xcshareddata/xcschemes/Foo.xcscheme）的任务。一个 Xcode Scheme 定义了要构建的目标集合、构建时使用的配置以及要执行的测试集合。

生成 Xcode 工作区设置文件（例如 Foo.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings）的任务。

生成 Xcode 项目文件（例如 Foo.xcodeproj/project.pbxproj）的任务。一个项目包含用于构建产品的所有元素，并维护这些元素之间的关系。它包含一个或多个目标，这些目标指定如何构建产品。一个项目定义了项目中所有目标的默认构建设置（每个目标也可以指定自己的构建设置，这些设置会覆盖项目的构建设置）。

生成 Xcode 工作区文件（例如 Foo.xcworkspace/contents.xcworkspacedata）的任务。一个工作区可以包含任意数量的 Xcode 项目。

生成 Visual Studio 解决方案文件（例如 foo.sln）的任务。

生成 Visual Studio 项目文件（例如 foo.vcxproj）的任务。

生成 Visual Studio 筛选器文件（例如 foo.vcxproj.filters）的任务。

Artifact 转换操作的接口。

Artifact 转换的输出。

Artifact 转换注册的基本配置。

用于 GNU GCC 的工具链。

用于 Clang 的工具链。

Visual C++ 工具链。

用于 Swift 编译器 的工具链。

一个不是由 Gradle 构建的库组件。

一个存在于文件系统上已知位置的共享库。

一个存在于文件系统上已知位置的静态库。

将由 Gradle 构建并在 JVM 平台上运行的软件组件的定义。

将由 Gradle 构建的原生可执行组件的定义。

将由 Gradle 构建的原生库组件的定义。

表示一组将一起执行的测试的组件。

CUnit 测试的测试套件。

Google Test 测试的测试套件。

表示构建原生组件所产生的二进制工件。

Gradle 为原生应用程序构建的二进制文件。

表示构建原生库组件所产生的二进制工件。

Gradle 为原生库构建的共享库二进制文件。

Gradle 为原生库构建的静态库二进制文件。

运行一套测试的可执行文件。

运行 CUnit 测试套件的可执行文件。

运行 Google Test 测试套件的可执行文件。

构建原生二进制文件的目标平台。每个目标平台都被赋予一个名称，并且可以选择指定特定的 Architecture 和/或 OperatingSystem 作为目标。

指定原生二进制文件的构建类型。常见的构建类型有“debug”和“release”，但也可以定义其他类型。

定义一个自定义变体，用于区分 NativeBinary。

一组汇编语言源文件。

一组 C 源文件。

一组 C++ 源文件。

一组 Objective-C 源文件。

一组 Objective-C++ 源文件。

一组 Windows 资源定义文件。

一个 Visual Studio 项目，从一个或多个原生二进制文件创建。

一个 Visual Studio 解决方案，表示构建中的一个或多个原生二进制文件。

由 Gradle 构建的可执行原生组件。

由 Gradle 项目构建的库组件。

表示一个特定的二进制工件。

NativeExecutable 的二进制工件，针对具有特定配置的特定平台。

已被编译并链接为共享库的 NativeLibrary。

已被编译并打包成静态库的 NativeLibrary。

C++ 应用程序的配置，定义构成应用程序的源文件加上其他设置。

C++ 库的配置，定义构成库的源文件和头文件目录加上其他设置。

一个 C++ 测试套件。

Swift 应用程序的配置，定义构成应用程序的源文件加上其他设置。

Swift 库的配置，定义构成库的源文件加上其他设置。

一个 XCTest 测试套件，使用 Swift 实现。

将 C++ 源文件编译成目标文件。

将 Swift 源文件编译成目标文件。

从目标文件和库链接二进制可执行文件。

从目标文件和导入库链接二进制共享库。

从目标文件打包静态库。

从目标文件和导入库链接二进制包。

安装可执行文件及其依赖库，以便于执行。

创建一个带有运行脚本的 XCTest 包，以便于执行。

运行已编译和安装的测试可执行文件。

执行 XCTest 测试。测试始终在单次执行中运行。

将 C 源文件编译成目标文件。

将汇编语言源文件翻译成目标文件。

将 Objective-C 源文件编译成目标文件。

将 Objective-C++ 源文件编译成目标文件。

将 Windows 资源脚本编译成 .res 文件。