Gradle 构建语言参考

配置此项目及其每个子项目。

配置此项目的发布制品。

配置此项目的构建脚本类路径。

配置此项目的依赖项配置。

配置此项目的依赖项。

配置此项目的存储库。

配置此项目的子项目。

配置由发布插件添加的 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` 的一部分应用，并且可以通过规则明确接受或拒绝单个组件。既未被接受也未被拒绝的组件将受默认版本匹配策略的约束。

在 DSL 中，DependencyCollector 用作依赖块的一部分。收集器实现单个依赖作用域，并在 DependencyCollector.getDependencies() 上公开声明的依赖项。

可以在运行时用其他对象扩展的对象。

Gradle 领域对象的额外、临时属性。

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

对插件依赖的可变规范。

配置插件如何解析。

用于创建 Provider 实例的工厂。

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

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

提供对需要由增量工作操作处理的任何输入文件的访问。

分发允许捆绑应用程序或库，包括依赖项、源...

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

IvyPublication 表示/配置 Gradle 应如何以 Ivy 格式发布内容到 Ivy 存储库。您可以通过提供 IvyPublication 作为类型，直接将命名 Ivy 发布添加到项目的 publishing.publications 容器中。

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

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

任何 Ivy 出版的描述符。

Ivy 出版的作者。

Ivy 出版的许可证。

Ivy 出版的描述。

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

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

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

Maven 出版的 POM。

Maven 出版的 CI 管理系统。

Maven 出版的贡献者。

允许添加 Maven 出版的贡献者。

Maven 出版的开发者。

允许向 Maven 出版添加开发者。

Maven 出版的分发管理配置。

Maven 出版的 Issue 管理系统。

Maven 出版的许可证。

允许向 Maven 出版添加许可证。

Maven 出版的邮件列表。

允许向 Maven 出版添加邮件列表。

Maven 出版的组织。

已移至新组和/或制品 ID 的 Maven 出版的重定位信息。

Maven 出版的 SCM（源代码控制管理）。

TaskContainer 负责管理一组 Task 实例。

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

RepositoryHandler 管理一组存储库，允许定义和查询存储库。

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

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

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

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

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

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

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

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

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

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

通过 HTTP 进行基本访问认证的认证方案。使用此方案时，凭据会预先发送。

通过 HTTP 进行 HTTP 头部认证的认证方案。

通过 HTTP 进行摘要式访问认证的认证方案。

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

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

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

用于配置输入标准化。目前，只能配置运行时类路径标准化。

输入标准化配置。当 Gradle 尝试确定两个任务输入是否不同时，使用输入标准化。Gradle 对两个输入进行标准化，并且当且仅当标准化不同时，输入才被视为不同。

运行时类路径标准化的配置。

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

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

显示项目的依赖关系树。当您从命令行执行 dependencies 任务时，将使用此类型的一个实例。

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

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

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

显示依赖组件。

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

一个任务，用于在命令行上报告项目的输出变体。这对于列出项目在变体方面产生的内容以及每个变体附加的制品非常有用。在这种情况下，变体必须理解为“项目产生的可以安全地被另一个项目消费的东西”。

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

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

从 Antlr 语法生成解析器。

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

对某些源文件运行 Checkstyle。

对某些源文件运行 CodeNarc。

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

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

删除文件或目录。示例

组装 EAR 存档。

执行命令行进程。示例

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

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

生成构建仪表板报告。

执行 Gradle 构建。

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

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

生成 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。

可在其他模块中查找测试夹具的 dependencies 块的依赖项修饰符 API。

可在其他模块中查找平台和强制平台的 dependencies 块的依赖项修饰符 API。

此 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 方案文件（例如 Foo.xcodeproj/xcshareddata/xcschemes/Foo.xcscheme）的任务。Xcode 方案定义了要构建的目标集合、构建时要使用的配置以及要执行的测试集合。

用于生成 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）的任务。

制品转换操作的接口。

制品转换的输出。

制品转换注册的基本配置。

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 库的配置，定义构成库的源文件以及其他设置。

用 Swift 实现的 XCTest 套件。

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

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

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

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

从目标文件组装静态库。

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

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

创建带有运行脚本的 XCTest 包，以便可以轻松执行。

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

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

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

将汇编语言源文件转换为目标文件。

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

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

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