Gradle 构建语言参考

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

配置此项目已发布的 Artifact。

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

配置此项目的依赖配置。

配置此项目的依赖项。

配置此项目的仓库。

配置此项目的源集。

配置此项目的子项目。

配置由 publishing 插件添加的 PublishingExtension。

此接口是您用来从构建文件与 Gradle 交互的主要 API。从 Project，您可以以编程方式访问 Gradle 的所有功能。

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

表示 Gradle 的调用。

声明实例化和配置要参与构建的 Project 实例层次结构所需的配置。

包含在组合构建中的构建。

提供对项目几个重要位置的访问。

提供对 Gradle 构建重要位置的访问。

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

SourceSet 表示 Java 源代码和资源文件的逻辑组。用户手册的用户手册中更详细地介绍了它们。

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

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

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

一个 Configuration，可以通过发布和依赖项管理来使用。

一个 Configuration，它执行依赖项解析以构建依赖关系图并解析 Artifact。

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

定义围绕依赖项解析的策略。例如，强制某些依赖项版本、替换、冲突解决或快照超时。

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

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

表示组件选择规则的容器。规则可以作为配置的 resolutionStrategy 的一部分应用，并且可以通过规则显式接受或拒绝单个组件。既未接受也未拒绝的组件将受到默认版本匹配策略的约束。

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

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

Gradle 域对象的其他临时属性。

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

插件依赖项的可变规范。

配置如何解析插件。

用于创建 Provider 实例的工厂。

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

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

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

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

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

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

作为 IvyPublication 一部分发布的 Artifact。

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

任何 Ivy 发布版本的描述符。

Ivy 发布版本的作者。

Ivy 发布版本的许可证。

Ivy 发布版本的描述。

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

作为 MavenPublication 一部分发布的 Artifact。

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

Maven 发布版本的 POM。

Maven 发布版本的 CI 管理系统。

Maven 发布版本的贡献者。

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

Maven 发布版本的开发者。

允许向 Maven 发布版本添加开发者。

Maven 发布版本的发行管理配置。

Maven 发布版本的问题管理系统。

Maven 发布版本的许可证。

允许向 Maven 发布版本添加许可证。

Maven 发布版本的邮件列表。

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

Maven 发布版本的组织。

已移动到新组和/或 Artifact ID 的 Maven 发布版本的重定位信息。

Maven 发布版本的 SCM（源代码控制管理）。

TaskContainer 负责管理一组 Task 实例。

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

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

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

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

此类用于定义要发布的 Artifact 并将其添加到配置中。创建发布 Artifact 并不意味着创建归档文件。创建的是域对象，该对象表示要发布的文件以及有关应如何发布的信息（例如，名称）。

支持用户名/密码身份验证的 Artifact 仓库。

用于不同身份验证目的的凭据的基本接口。（例如，经过身份验证的 RepositoryHandler）

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

表示用于向 Amazon Web Services 进行身份验证的凭据。

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

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

传输身份验证方案的基本接口。

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

通过 HTTP 进行 HTTP 标头身份验证的身份验证方案。

通过 HTTP 进行摘要访问身份验证的身份验证方案。

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

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

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

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

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

运行时类路径规范化的配置。

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

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

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

生成一份报告，尝试回答如下问题

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

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

显示依赖组件。

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

一个任务，用于在命令行上报告项目的传出变体。这对于列出项目在变体方面生成的内容以及附加到每个变体的 Artifact 非常有用。在这种上下文中，变体必须理解为“项目生成的可由另一个项目安全使用的内容”。

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

一个任务，用于报告有关项目使用的 Artifact 转换（由 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 项目结构。

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

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

组装 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。

依赖项修饰符 API，可以在其他模块中查找 dependencies 块的测试装置。

依赖项修饰符 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）的任务。

构件转换操作的接口。

构件转换的输出。

构件转换注册的基础配置。

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 文件。