项目

API 文档项目

此接口是您用于从构建文件与 Gradle 交互的主要 API。从 Project,您可以程序化地访问 Gradle 的所有功能。

生命周期

Projectbuild.gradle 文件之间存在一对一的关系。在构建初始化期间,Gradle 为每个将参与构建的项目组装一个 Project 对象,如下所示

  • 为构建创建一个 Settings 实例。
  • 如果存在,则针对 Settings 对象评估 settings.gradle 脚本以配置它。
  • 使用配置的 Settings 对象来创建 Project 实例的层次结构。
  • 最后,通过针对项目执行每个 Projectbuild.gradle 文件(如果存在)来评估每个项目。项目以广度优先的顺序进行评估,以便在评估其子项目之前评估父项目。可以通过调用 Project.evaluationDependsOnChildren() 或通过使用 Project.evaluationDependsOn(java.lang.String) 添加显式评估依赖项来覆盖此顺序。

任务

一个项目本质上是 Task 对象的集合。每个任务执行一些基本的工作,例如编译类、运行单元测试或压缩 WAR 文件。您可以使用 TaskContainer 上的 create() 方法之一将任务添加到项目中,例如 TaskContainer.create(java.lang.String)。您可以使用 TaskContainer 上的查找方法之一来定位现有任务,例如 TaskCollection.getByName(java.lang.String)

依赖

一个项目通常有许多执行其工作所需的依赖项。此外,一个项目通常会生成许多其他项目可以使用的产物。这些依赖项被分组在配置中,并且可以从仓库中检索和上传。您可以使用 ConfigurationContainer(由 Project.getConfigurations() 方法返回)来管理配置。使用 DependencyHandler(由 Project.getDependencies() 方法返回)来管理依赖项。使用 ArtifactHandler(由 Project.getArtifacts() 方法返回)来管理产物。使用 RepositoryHandler(由 Project.getRepositories() 方法返回)来管理仓库。

多项目构建

项目被安排成项目层次结构。一个项目有一个名称和一个完全限定路径,该路径在层次结构中唯一标识它。

插件

插件可用于模块化和重用项目配置。可以使用 PluginAware.apply(java.util.Map) 方法或通过使用 PluginDependenciesSpec plugins 脚本块来应用插件。

动态项目属性

Gradle 针对 Project 实例执行项目的构建文件以配置项目。您的脚本使用的任何属性或方法都将委托给关联的 Project 对象。这意味着,您可以在脚本中直接使用 Project 接口上的任何方法和属性。

例如

defaultTasks('some-task')  // Delegates to Project.defaultTasks()
reportsDir = file('reports') // Delegates to Project.file() and the Java Plugin

您还可以使用 project 属性访问 Project 实例。在某些情况下,这可以使脚本更清晰。例如,您可以使用 project.name 而不是 name 来访问项目的名称。

一个项目有 5 个属性“作用域”,它在其中搜索属性。您可以通过名称在构建文件中访问这些属性,或者通过调用项目的 Project.property(java.lang.String) 方法来访问。作用域包括

  • Project 对象本身。此作用域包括 Project 实现类声明的任何属性 getter 和 setter。例如,Project.getRootProject() 可以作为 rootProject 属性访问。此作用域的属性是可读或可写的,具体取决于是否存在相应的 getter 或 setter 方法。
  • 项目的 额外 属性。每个项目维护一个额外属性的映射,其中可以包含任何任意名称 -> 值对。定义后,此作用域的属性是可读写的。有关更多详细信息,请参阅 额外属性
  • 插件添加到项目的 扩展。每个扩展都作为只读属性提供,属性名称与扩展名相同。
  • 插件添加到项目的 约定 属性。插件可以通过项目的 Convention 对象向项目添加属性和方法。此作用域的属性可能是可读或可写的,具体取决于约定对象。
  • 项目的任务。可以使用任务的名称作为属性名称来访问任务。此作用域的属性是只读的。例如,名为 compile 的任务可以作为 compile 属性访问。
  • 额外属性和约定属性是从项目的父项继承的,递归到根项目。此作用域的属性是只读的。

读取属性时,项目按顺序搜索上述作用域,并从找到属性的第一个作用域返回该值。如果未找到,则会抛出异常。有关更多详细信息,请参阅 Project.property(java.lang.String)

写入属性时,项目按顺序搜索上述作用域,并在找到属性的第一个作用域中设置该属性。如果未找到,则会抛出异常。有关更多详细信息,请参阅 Project.setProperty(java.lang.String, java.lang.Object)

额外属性

所有额外属性都必须通过 “ext” 命名空间定义。一旦定义了额外属性,它就可以直接在所有者对象(在下面的示例中分别是 Project、Task 和子项目)上使用,并且可以读取和更新。只有需要通过命名空间完成的初始声明。

project.ext.prop1 = "foo"
task doStuff {
    ext.prop2 = "bar"
}
subprojects { ext.${prop3} = false }

读取额外属性通过 “ext” 或通过所有者对象完成。

ext.isSnapshot = version.endsWith("-SNAPSHOT")
if (isSnapshot) {
    // do snapshot stuff
}

动态方法

一个项目有 5 个方法“作用域”,它在其中搜索方法

  • Project 对象本身。
  • 构建文件。项目搜索在构建文件中声明的匹配方法。
  • 插件添加到项目的 扩展。每个扩展都作为一种方法提供,该方法接受闭包或 Action 作为参数。
  • 插件添加到项目的 约定 方法。插件可以通过项目的 Convention 对象向项目添加属性和方法。
  • 项目的任务。为每个任务添加一个方法,使用任务的名称作为方法名称,并接受单个闭包或 Action 参数。该方法使用提供的闭包为关联的任务调用 Task.configure(groovy.lang.Closure) 方法。例如,如果项目有一个名为 compile 的任务,则会添加一个具有以下签名的方法:void compile(Closure configureClosure)
  • 父项目的方法,递归到根项目。
  • 项目的一个属性,其值是一个闭包。闭包被视为一种方法,并使用提供的参数调用。该属性的位置如上所述。

属性

属性描述
allprojects

包含此项目及其子项目的集合。

ant

此项目的 AntBuilder。您可以在构建文件中使用它来执行 ant 任务。请参阅下面的示例。

artifacts

返回一个处理程序,用于将项目生成的产物分配给配置。

buildDir
已弃用

此项目的构建目录。构建目录是所有产物生成到的目录。构建目录的默认值为 projectDir/build

buildFile

此项目的构建脚本。

buildscript

此项目的构建脚本处理程序。您可以使用此处理程序查询有关此项目的构建脚本的详细信息,并管理用于编译和执行项目构建脚本的类路径。

childProjects

此项目的直接子项目。

configurations

此项目的配置。

convention
已弃用

此项目的 Convention

defaultTasks

此项目的默认任务的名称。当启动构建时未提供任务名称时,将使用这些任务。

dependencies

此项目的依赖处理程序。返回的依赖处理程序实例可用于添加新的依赖项。要访问已声明的依赖项,可以使用配置。

dependencyLocking

提供对配置依赖锁定功能的访问

description

此项目的描述(如果有)。

extensions

允许向项目添加 DSL 扩展。对插件作者很有用。

gradle

此项目所属的 Gradle 调用。

group

此项目的组。Gradle 始终使用组的 toString() 值。组默认为以点作为分隔符的路径。

layout

提供对此项目的各种重要目录的访问。

logger

此项目的记录器。您可以在构建文件中使用它来编写日志消息。

logging

可用于接收日志记录并控制此项目构建脚本的标准输出/错误捕获的 LoggingManager。默认情况下,System.out 在 QUIET 日志级别重定向到 Gradle 日志记录系统,而 System.err 在 ERROR 日志级别重定向。

name

此项目的名称。项目的名称在项目层次结构中不一定是唯一的。您应该使用 Project.getPath() 方法作为项目的唯一标识符。如果根项目未命名且位于文件系统根目录上,则它将具有随机生成的名称

normalization

提供对配置输入规范化功能的访问。

parent

此项目的父项目(如果有)。

path

此项目的路径。路径是项目的完全限定名称。

pluginManager

此插件感知对象的插件管理器。

plugins

已应用于此对象的插件的容器。

project

返回此项目。此方法在构建文件中很有用,可以显式访问项目属性和方法。例如,使用 project.name 可以比使用 name 更好地表达您的意图。此方法还允许您从属性可能隐藏的作用域访问项目属性,例如,从方法或闭包。

projectDir

包含项目构建文件的目录。

properties

此项目的属性。有关可用于项目的属性的详细信息,请参阅 此处

repositories

返回一个处理程序,用于创建用于检索依赖项和上传项目生成的产物的仓库。

resources

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

rootDir

此项目的根目录。根目录是根项目的项目目录。

rootProject

此项目所属层次结构的根项目。在单项目构建的情况下,此方法返回此项目。

state

此项目的评估状态。您可以使用它来访问有关此项目评估的信息,例如它是否失败。

status

此项目的状态。Gradle 始终使用状态的 toString() 值。状态默认为 release

subprojects

包含此项目的子项目的集合。

tasks

此项目的任务。

version

此项目的版本。Gradle 始终使用版本的 toString() 值。版本默认为 unspecified

application 插件添加的属性

属性描述
application

application 插件添加的 JavaApplication

applicationDefaultJvmArgs

运行应用程序时传递给 JVM 的字符串参数数组

applicationDistribution

分发内容的规范。

applicationName

应用程序的名称。

executableDir

用于放置可执行文件的目录

mainClassName

应用程序主类的完全限定名称。

checkstyle 插件添加的属性

属性描述
checkstyle

checkstyle 插件添加的 CheckstyleExtension

codenarc 插件添加的属性

属性描述
codenarc

codenarc 插件添加的 CodeNarcExtension

distribution 插件添加的属性

属性描述
distributions

distribution 插件添加的 DistributionContainer

ear 插件添加的属性

属性描述
appDirName

应用程序目录的名称,相对于项目目录。默认为 “src/main/application”。

deploymentDescriptor

自定义部署描述符配置。默认为具有合理默认值的 “application.xml”。

generateDeploymentDescriptor

指定如果部署描述符不存在是否应生成。默认为 true。

libDirName

EAR 文件中库目录的名称。默认为 “lib”。

eclipse 插件添加的属性

属性描述
eclipse

eclipse 插件添加的 EclipseModel

idea 插件添加的属性

属性描述
idea

idea 插件添加的 IdeaModel

jacoco 插件添加的属性

属性描述
jacoco

jacoco 插件添加的 JacocoPluginExtension

java 插件添加的属性

属性描述
archivesBaseName

用于归档文件的基本名称。

base

java 插件添加的 BasePluginExtension

distsDirName

分发目录的名称。这相对于项目的构建目录进行解释。

distsDirectory

用于生成 TAR 和 ZIP 归档文件的目录。

docsDir

返回一个指向根目录的文件,该根目录应供所有文档使用。

docsDirName

文档目录的名称。可以是相对于构建目录的名称或路径。

java

java 插件添加的 JavaPluginExtension

libsDirName

库目录的名称。这相对于项目的构建目录进行解释。

libsDirectory

用于生成 JAR 和 WAR 归档文件的目录。

reporting

java 插件添加的 ReportingExtension

sourceCompatibility

用于编译 Java 源的源兼容性。

sourceSets

源集容器。

targetCompatibility

用于编译 Java 源的目标兼容性。

testReportDir

返回一个指向要用于报告的根目录的文件。

testReportDirName

测试报告目录的名称。可以是相对于 ReportingExtension.getBaseDir() 的名称或路径。

testResultsDir

返回一个指向测试结果根目录的文件。

testResultsDirName

测试结果目录的名称。可以是相对于构建目录的名称或路径。

pmd 插件添加的属性

属性描述
pmd

pmd 插件添加的 PmdExtension

project-report 插件添加的属性

属性描述
projectReportDir

用于生成项目报告的目录。

projectReportDirName

用于生成项目报告的目录的名称,相对于项目的报告目录。

publishing 插件添加的属性

属性描述
publishing

publishing 插件添加的 PublishingExtension

signing 插件添加的属性

属性描述
signing

signing 插件添加的 SigningExtension

visual-studio 插件添加的属性

属性描述
visualStudio

visual-studio 插件添加的 VisualStudioRootExtension

war 插件添加的属性

属性描述
webAppDir

Web 应用程序目录。

webAppDirName

Web 应用程序目录的名称,相对于项目目录。

xcode 插件添加的属性

属性描述
xcode

xcode 插件添加的 XcodeRootExtension

方法

方法描述
absoluteProjectPath(path)

将名称转换为绝对项目路径,解析相对于此项目的名称。

afterEvaluate(closure)

添加一个闭包,以便在此项目评估后立即调用。

afterEvaluate(action)

添加一个操作,以便在此项目评估后立即调用。

allprojects(action)

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

ant(configureAction)

针对此项目的 AntBuilder 执行给定的操作。您可以在构建文件中使用它来执行 ant 任务。请参阅 Project.getAnt() 的 javadoc 中的示例

apply(closure)

应用零个或多个插件或脚本。

apply(options)

应用插件或脚本,使用以 map 形式提供的给定选项。如果插件已被应用,则不执行任何操作。

apply(action)

应用零个或多个插件或脚本。

artifacts(configureAction)

配置此项目发布的 artifacts。

beforeEvaluate(closure)

添加一个闭包,以便在此项目评估之前立即调用。

beforeEvaluate(action)

添加一个 action,以便在此项目评估之前立即调用。

configure(objects, configureClosure)

通过闭包配置对象集合。这等效于为给定的每个对象调用 Project.configure(java.lang.Object, groovy.lang.Closure)

configure(objects, configureAction)

通过 action 配置对象集合。

configure(object, configureClosure)

通过闭包配置对象,闭包的委托设置为提供的对象。这样您就不必多次指定配置语句的上下文。

container(type)

创建一个容器,用于管理指定类型的命名对象。指定的类型必须具有一个公共构造函数,该构造函数将名称作为 String 参数。

container(type, factoryClosure)

创建一个容器,用于管理指定类型的命名对象。给定的闭包用于创建对象实例。要创建的实例的名称作为参数传递给闭包。

container(type, factory)

创建一个容器,用于管理指定类型的命名对象。给定的工厂用于创建对象实例。

copy(closure)

复制指定的文件。给定的闭包用于配置 CopySpec,然后用于复制文件。示例

copy(action)

复制指定的文件。给定的 action 用于配置 CopySpec,然后用于复制文件。

copySpec()

创建一个 CopySpec,稍后可用于复制文件或创建归档文件。

copySpec(closure)

创建一个 CopySpec,稍后可用于复制文件或创建归档文件。给定的闭包用于在 CopySpec 返回之前对其进行配置。

copySpec(action)

创建一个 CopySpec,稍后可用于复制文件或创建归档文件。给定的 action 用于在 CopySpec 返回之前对其进行配置。

defaultTasks(defaultTasks)

设置此项目的默认任务的名称。当启动构建时未提供任务名称时,将使用这些任务。

delete(paths)

删除文件和目录。

delete(action)

删除指定的文件。给定的 action 用于配置 DeleteSpec,然后用于删除文件。

dependencyLocking(configuration)

配置依赖锁定

evaluationDependsOn(path)

声明此项目对具有给定路径的项目具有评估依赖性。

exec(closure)
已弃用

执行外部命令。闭包配置 ExecSpec

exec(action)
已弃用

执行外部命令。

file(path)

解析相对于此项目项目目录的文件路径。此方法根据其类型转换提供的路径

file(path, validation)

解析相对于此项目项目目录的文件路径,并使用给定的方案对其进行验证。有关可能的验证列表,请参见 PathValidation

fileTree(baseDir)

使用给定的基本目录创建一个新的 ConfigurableFileTree。给定的 baseDir 路径按照 Project.file(java.lang.Object) 进行评估。

fileTree(baseDir, configureClosure)

使用给定的基本目录创建一个新的 ConfigurableFileTree。给定的 baseDir 路径按照 Project.file(java.lang.Object) 进行评估。闭包将用于配置新的文件树。文件树作为其委托传递给闭包。示例

fileTree(baseDir, configureAction)

使用给定的基本目录创建一个新的 ConfigurableFileTree。给定的 baseDir 路径按照 Project.file(java.lang.Object) 进行评估。action 将用于配置新的文件树。示例

fileTree(args)

使用提供的参数映射创建一个新的 ConfigurableFileTree。该映射将作为属性应用于新的文件树。示例

files(paths, configureClosure)

使用给定的路径创建一个新的 ConfigurableFileCollection。路径按照 Project.files(java.lang.Object[]) 进行评估。文件集合使用给定的闭包进行配置。文件集合作为其委托传递给闭包。示例

files(paths, configureAction)

使用给定的路径创建一个新的 ConfigurableFileCollection。路径按照 Project.files(java.lang.Object[]) 进行评估。文件集合使用给定的 action 进行配置。示例

files(paths)

返回一个 ConfigurableFileCollection,其中包含给定的文件。您可以将以下任何类型传递给此方法

findProject(path)

按路径查找项目。如果路径是相对路径,则相对于此项目进行解释。

findProperty(propertyName)

返回给定属性的值,如果未找到,则返回 null。此方法按以下方式查找属性

getAllTasks(recursive)

返回此项目中包含的任务映射,以及可选的子项目。

getTasksByName(name, recursive)

返回此项目中包含的具有给定名称的任务集,以及可选的子项目。注意: 这是一个昂贵的操作,因为它需要配置所有项目。

hasProperty(propertyName)

确定此项目是否具有给定的属性。有关项目中可用的属性的详细信息,请参见 此处

javaexec(closure)
已弃用

执行 Java main 类。闭包配置 JavaExecSpec

javaexec(action)
已弃用

执行外部 Java 进程。

mkdir(path)

创建目录并返回指向该目录的文件。

normalization(configuration)

配置输入规范化。

project(path)

按路径查找项目。如果路径是相对路径,则相对于此项目进行解释。

project(path, configureClosure)

按路径查找项目,并使用给定的闭包对其进行配置。如果路径是相对路径,则相对于此项目进行解释。目标项目作为闭包的委托传递给闭包。

project(path, configureAction)

按路径查找项目,并使用给定的 action 对其进行配置。如果路径是相对路径,则相对于此项目进行解释。

property(propertyName)

返回给定属性的值。此方法按以下方式查找属性

relativePath(path)

返回从项目目录到给定路径的相对路径。给定的路径对象(逻辑上)按照 Project.file(java.lang.Object) 所述进行解析,从中计算相对路径。

relativeProjectPath(path)

将名称转换为相对于此项目的项目路径。

setProperty(name, value)

设置此项目的属性。此方法在以下位置搜索具有给定名称的属性,并在找到属性的第一个位置设置属性。

subprojects(action)

配置此项目的子项目

sync(action)

将目标目录的内容与某些源目录和文件同步。给定的 action 用于配置 SyncSpec,然后用于同步文件。

tarTree(tarPath)

创建一个新的 FileTree,其中包含给定 TAR 文件的内容。给定的 tarPath 路径可以是

task(name)
已弃用

创建一个具有给定名称的 Task,并将其添加到此项目中。调用此方法等效于调用 Project.task(java.util.Map, java.lang.String),并使用空选项映射。

task(name, configureClosure)
已弃用

创建一个具有给定名称的 Task,并将其添加到此项目中。在返回任务之前,将执行给定的闭包以配置任务。

task(name, configureAction)
已弃用

创建一个具有给定名称的 Task,并将其添加到此项目中。在返回任务之前,将执行给定的 action 以配置任务。

task(args, name)
已弃用

创建一个具有给定名称的 Task,并将其添加到此项目中。可以将创建选项映射传递给此方法,以控制任务的创建方式。以下选项可用

task(args, name, configureClosure)
已弃用

创建一个具有给定名称的 Task,并将其添加到此项目中。在返回任务之前,将执行给定的闭包以配置任务。可以将创建选项映射传递给此方法,以控制任务的创建方式。有关可用选项,请参见 Project.task(java.util.Map, java.lang.String)

uri(path)

将文件路径解析为 URI,相对于此项目的项目目录。按照 Project.file(java.lang.Object) 所述评估提供的路径对象,但 'file:' URI 除外,支持任何 URI 方案。

zipTree(zipPath)

创建一个新的 FileTree,其中包含给定 ZIP 文件的内容。给定的 zipPath 路径按照 Project.file(java.lang.Object) 进行评估。您可以将此方法与 Project.copy(org.gradle.api.Action) 方法结合使用以解压缩 ZIP 文件。

ear 插件添加的方法

方法描述
appDirName(appDirName)

允许更改应用程序目录。默认为 "src/main/application"。

deploymentDescriptor(configureAction)

为此 EAR 归档文件配置部署描述符。

libDirName(libDirName)

允许更改 EAR 文件中的库目录。默认为 "lib"。

java 插件添加的方法

方法描述
manifest()

创建一个 Manifest 的新实例。

manifest(closure)

创建并配置 Manifest 的新实例。给定的闭包在返回之前配置新的 manifest 实例。

manifest(action)

创建并配置 Manifest 的新实例。

脚本块

Block描述
allprojects

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

ant

针对此项目的 AntBuilder 执行给定的闭包。您可以在构建文件中使用它来执行 ant 任务。AntBuild 作为闭包的委托传递给闭包。有关示例,请参见 Project.getAnt() 的 javadoc

artifacts

配置此项目发布的 artifacts。

buildscript

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

configurations

为此项目配置依赖关系配置。

dependencies

为此项目配置依赖关系。

repositories

为此项目配置仓库。

subprojects

配置此项目的子项目。

application 插件添加的脚本块

Block描述
application

配置 application 插件添加的 JavaApplication

checkstyle 插件添加的脚本块

Block描述
checkstyle

配置 checkstyle 插件添加的 CheckstyleExtension

codenarc 插件添加的脚本块

Block描述
codenarc

配置 codenarc 插件添加的 CodeNarcExtension

distribution 插件添加的脚本块

Block描述
distributions

配置 distribution 插件添加的 DistributionContainer

ear 插件添加的脚本块

Block描述
deploymentDescriptor

为此 EAR 归档文件配置部署描述符。

eclipse 插件添加的脚本块

Block描述
eclipse

配置 eclipse 插件添加的 EclipseModel

idea 插件添加的脚本块

Block描述
idea

配置 idea 插件添加的 IdeaModel

jacoco 插件添加的脚本块

Block描述
jacoco

配置 jacoco 插件添加的 JacocoPluginExtension

java 插件添加的脚本块

Block描述
base

配置 java 插件添加的 BasePluginExtension

java

配置 java 插件添加的 JavaPluginExtension

reporting

配置 java 插件添加的 ReportingExtension

sourceSets

配置此项目的源集。

pmd 插件添加的脚本块

Block描述
pmd

配置 pmd 插件添加的 PmdExtension

publishing 插件添加的脚本块

Block描述
publishing

配置 publishing 插件添加的 PublishingExtension

signing 插件添加的脚本块

Block描述
signing

配置 signing 插件添加的 SigningExtension

visual-studio 插件添加的脚本块

Block描述
visualStudio

配置 visual-studio 插件添加的 VisualStudioRootExtension

xcode 插件添加的脚本块

Block描述
xcode

配置 xcode 插件添加的 XcodeRootExtension

属性详细信息

Set<Project> allprojects (只读)

包含此项目及其子项目的集合。

AntBuilder ant (只读)

此项目的 AntBuilder。您可以在构建文件中使用它来执行 ant 任务。请参阅下面的示例。

task printChecksum {
  doLast {
    ant {
      //using ant checksum task to store the file checksum in the checksumOut ant property
      checksum(property: 'checksumOut', file: 'someFile.txt')

      //we can refer to the ant property created by checksum task:
      println "The checksum is: " + checksumOut
    }

    //we can refer to the ant property later as well:
    println "I just love to print checksums: " + ant.checksumOut
  }
}

考虑以下 ant 目标的示例

<target name='printChecksum'>
  <checksum property='checksumOut'>
    <fileset dir='.'>
      <include name='agile.txt'/>
    </fileset>
  </checksum>
  <echo>The checksum is: ${checksumOut}</echo>
</target>

这是它在 gradle 中的外观。观察 ant XML 如何通过 ant builder 在 groovy 中表示

task printChecksum {
  doLast {
    ant {
      checksum(property: 'checksumOut') {
        fileset(dir: '.') {
          include name: 'agile1.txt'
        }
      }
    }
    logger.lifecycle("The checksum is $ant.checksumOut")
  }
}

ArtifactHandler artifacts (只读)

返回一个处理程序,用于将项目生成的产物分配给配置。

示例:请参阅 ArtifactHandler 的文档

File buildDir

注意:此属性已弃用,将在 Gradle 的下一个主要版本中删除。

此项目的构建目录。构建目录是所有产物生成到的目录。构建目录的默认值为 projectDir/build

File buildFile (只读)

此项目的构建脚本。

如果文件存在,则在配置此项目时将针对此项目对其进行评估。

ScriptHandler buildscript (只读)

此项目的构建脚本处理程序。您可以使用此处理程序查询有关此项目的构建脚本的详细信息,并管理用于编译和执行项目构建脚本的类路径。

Map<String, Project> childProjects (只读)

此项目的直接子项目。

ConfigurationContainer configurations (只读)

此项目的配置。

示例:请参阅 ConfigurationContainer 的文档

Convention convention (只读)

注意:此属性已弃用,将在 Gradle 的下一个主要版本中删除。

此项目的 Convention

您可以在构建文件中使用 convention 访问此属性。您还可以访问 convention 对象的属性和方法,就像它们是此项目的属性和方法一样。有关更多详细信息,请参见此处

List<String> defaultTasks

此项目的默认任务的名称。当启动构建时未提供任务名称时,将使用这些任务。

DependencyHandler dependencies (只读)

此项目的依赖处理程序。返回的依赖处理程序实例可用于添加新的依赖项。要访问已声明的依赖项,可以使用配置。

示例:请参阅 DependencyHandler 的文档

DependencyLockingHandler dependencyLocking (只读)

提供对配置依赖锁定功能的访问

String description

此项目的描述(如果有)。

ExtensionContainer extensions (只读)

允许向项目添加 DSL 扩展。对插件作者很有用。

Gradle gradle (只读)

此项目所属的 Gradle 调用。

Object group

此项目的组。Gradle 始终使用组的 toString() 值。组默认为以点作为分隔符的路径。

ProjectLayout layout (只读)

提供对此项目的各种重要目录的访问。

Logger logger (只读)

此项目的记录器。您可以在构建文件中使用它来编写日志消息。

LoggingManager logging (只读)

可用于接收日志记录并控制此项目构建脚本的标准输出/错误捕获的 LoggingManager。默认情况下,System.out 在 QUIET 日志级别重定向到 Gradle 日志记录系统,而 System.err 在 ERROR 日志级别重定向。

String name (只读)

此项目的名称。项目的名称在项目层次结构中不一定是唯一的。您应该使用 Project.getPath() 方法作为项目的唯一标识符。如果根项目未命名且位于文件系统根目录上,则它将具有随机生成的名称

InputNormalizationHandler normalization (只读)

提供对配置输入规范化功能的访问。

Project parent (只读)

此项目的父项目(如果有)。

String path (只读)

此项目的路径。路径是项目的完全限定名称。

PluginManager pluginManager (只读)

此插件感知对象的插件管理器。

PluginContainer plugins (只读)

已应用于此对象的插件的容器。

虽然不推荐使用,但最好使用此接口或 PluginAware.getPluginManager() 的方法,而不是使用插件容器。

使用此接口或 PluginAware.getPluginManager() 上的 'apply' 方法之一来应用插件,而不是通过插件容器应用。

使用 PluginManager.hasPlugin(java.lang.String) 或类似方法来查询插件的应用,而不是通过插件容器来执行此操作。

Project project (只读)

返回此项目。此方法在构建文件中很有用,可以显式访问项目属性和方法。例如,使用 project.name 可以比使用 name 更好地表达您的意图。此方法还允许您从属性可能隐藏的作用域访问项目属性,例如,从方法或闭包。

File projectDir (只读)

包含项目构建文件的目录。

Map<String, ?> properties (只读)

此项目的属性。有关可用于项目的属性的详细信息,请参阅 此处

RepositoryHandler repositories (只读)

返回一个处理程序,用于创建用于检索依赖项和上传项目生成的产物的仓库。

ResourceHandler resources (只读)

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

File rootDir (只读)

此项目的根目录。根目录是根项目的项目目录。

Project rootProject (只读)

此项目所属层次结构的根项目。在单项目构建的情况下,此方法返回此项目。

ProjectState state (只读)

此项目的评估状态。您可以使用它来访问有关此项目评估的信息,例如它是否失败。

Object status

此项目的状态。Gradle 始终使用状态的 toString() 值。状态默认为 release

仅当您将库与模块描述符一起上传时,项目的状态才相关。此处指定的状态将是此模块描述符的一部分。

Set<Project> subprojects (只读)

包含此项目的子项目的集合。

TaskContainer tasks (只读)

此项目的任务。

Object version

此项目的版本。Gradle 始终使用版本的 toString() 值。版本默认为 unspecified

JavaApplication application (只读)

application 插件添加的 JavaApplication

Iterable<String> applicationDefaultJvmArgs

运行应用程序时传递给 JVM 的字符串参数数组

CopySpec applicationDistribution

分发内容的规范。

使用此 CopySpec 在应用程序分发中包含额外的文件/资源。

plugins {
    id 'application'
}

application {
    applicationDistribution.from("some/dir") {
      include "*.txt"
    }
}

请注意,application 插件预先配置此规范以;包括 "src/dist" 的内容,将应用程序启动脚本复制到 "bin" 目录,并将构建的 jar 及其依赖项复制到 "lib" 目录。

String applicationName

应用程序的名称。

String executableDir

用于放置可执行文件的目录

String mainClassName

应用程序主类的完全限定名称。

CheckstyleExtension checkstyle (read-only)

checkstyle 插件添加的 CheckstyleExtension

CodeNarcExtension codenarc (read-only)

codenarc 插件添加的 CodeNarcExtension

DistributionContainer distributions (read-only)

distribution 插件添加的 DistributionContainer

String appDirName

应用程序目录的名称,相对于项目目录。默认为 “src/main/application”。

DeploymentDescriptor deploymentDescriptor

自定义部署描述符配置。默认为具有合理默认值的 “application.xml”。

Property<Boolean> generateDeploymentDescriptor

指定如果部署描述符不存在是否应生成。默认为 true。

String libDirName

EAR 文件中库目录的名称。默认为 “lib”。

EclipseModel eclipse (read-only)

eclipse 插件添加的 EclipseModel

IdeaModel idea (read-only)

idea 插件添加的 IdeaModel

JacocoPluginExtension jacoco (read-only)

jacoco 插件添加的 JacocoPluginExtension

String archivesBaseName

用于归档文件的基本名称。

BasePluginExtension base (read-only)

java 插件添加的 BasePluginExtension

String distsDirName

分发目录的名称。这相对于项目的构建目录进行解释。

DirectoryProperty distsDirectory

用于生成 TAR 和 ZIP 归档文件的目录。

File docsDir (read-only)

返回一个指向根目录的文件,该根目录应供所有文档使用。

String docsDirName

文档目录的名称。可以是相对于构建目录的名称或路径。

JavaPluginExtension java (read-only)

java 插件添加的 JavaPluginExtension

String libsDirName

库目录的名称。这相对于项目的构建目录进行解释。

DirectoryProperty libsDirectory

用于生成 JAR 和 WAR 归档文件的目录。

ReportingExtension reporting (read-only)

java 插件添加的 ReportingExtension

JavaVersion sourceCompatibility

用于编译 Java 源的源兼容性。

SourceSetContainer sourceSets (read-only)

源集容器。

JavaVersion targetCompatibility

用于编译 Java 源的目标兼容性。

File testReportDir (read-only)

返回一个指向要用于报告的根目录的文件。

String testReportDirName

测试报告目录的名称。可以是相对于 ReportingExtension.getBaseDir() 的名称或路径。

File testResultsDir (read-only)

返回一个指向测试结果根目录的文件。

String testResultsDirName

测试结果目录的名称。可以是相对于构建目录的名称或路径。

PmdExtension pmd (read-only)

pmd 插件添加的 PmdExtension

File projectReportDir (read-only)

用于生成项目报告的目录。

String projectReportDirName

用于生成项目报告的目录的名称,相对于项目的报告目录。

PublishingExtension publishing (read-only)

publishing 插件添加的 PublishingExtension

SigningExtension signing (read-only)

signing 插件添加的 SigningExtension

VisualStudioRootExtension visualStudio (read-only)

visual-studio 插件添加的 VisualStudioRootExtension

File webAppDir (read-only)

Web 应用程序目录。

String webAppDirName

Web 应用程序目录的名称,相对于项目目录。

XcodeRootExtension xcode (read-only)

xcode 插件添加的 XcodeRootExtension

方法详情

String absoluteProjectPath(String path)

将名称转换为绝对项目路径,解析相对于此项目的名称。

void afterEvaluate(Closure closure)

添加一个闭包,以便在此项目评估后立即调用。

void afterEvaluate(Action<? super Project> action)

添加一个操作,以便在此项目评估后立即调用。

将项目作为参数传递给 action。传递给此方法的 Action 将按照传递的顺序执行。父项目可能会向其子项目添加 action,以便根据子项目在构建文件运行后的状态进一步配置这些子项目。

如果项目已经评估完成,则此方法将失败。

如果在 afterEvaluate action 中调用此方法,则传递的 action 将在所有先前添加的 afterEvaluate action 完成执行后执行。

void allprojects(Action<? super Project> action)

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

此方法针对此项目及其每个子项目执行给定的 Action

AntBuilder ant(Action<? super AntBuilder> configureAction)

针对此项目的 AntBuilder 执行给定的操作。您可以在构建文件中使用它来执行 ant 任务。请参阅 Project.getAnt() 的 javadoc 中的示例

void apply(Closure closure)

应用零个或多个插件或脚本。

给定的 closure 用于配置 ObjectConfigurationAction,它“构建”插件应用。

此方法与 PluginAware.apply(java.util.Map) 的不同之处在于,它允许多次调用配置 action 的方法。

void apply(Map<String, ?> options)

应用插件或脚本,使用以 map 形式提供的给定选项。如果插件已被应用,则不执行任何操作。

给定的 map 将作为一系列方法调用应用于新创建的 ObjectConfigurationAction。也就是说,map 中的每个键都应是 ObjectConfigurationAction 的方法名,并且值应是与该方法兼容的参数。

以下选项可用:

  • from: 要应用的脚本。接受 Project.uri(java.lang.Object) 支持的任何路径。
  • plugin: 要应用的插件的 ID 或实现类。
  • to: 目标委托对象或多个对象。默认为此插件感知对象。使用此选项来配置此对象以外的对象。

void apply(Action<? super ObjectConfigurationAction> action)

应用零个或多个插件或脚本。

给定的 closure 用于配置 ObjectConfigurationAction,它“构建”插件应用。

此方法与 PluginAware.apply(java.util.Map) 的不同之处在于,它允许多次调用配置 action 的方法。

void artifacts(Action<? super ArtifactHandler> configureAction)

配置此项目发布的 artifacts。

此方法针对此项目的 ArtifactHandler 执行给定的 action。

示例

configurations {
  //declaring new configuration that will be used to associate with artifacts
  schema
}

task schemaJar(type: Jar) {
  //some imaginary task that creates a jar artifact with the schema
}

//associating the task that produces the artifact with the configuration
artifacts {
  //configuration name and the task:
  schema schemaJar
}

void beforeEvaluate(Closure closure)

添加一个闭包,以便在此项目评估之前立即调用。

void beforeEvaluate(Action<? super Project> action)

添加一个 action,以便在此项目评估之前立即调用。

将项目作为参数传递给 action。传递给此方法的 Action 将按照传递的顺序执行。

如果项目已经评估完成,则 action 永远不会执行。

如果在 beforeEvaluate action 中调用此方法,则传递的 action 永远不会执行。

Iterable<?> configure(Iterable<?> objects, Closure configureClosure)

通过闭包配置对象集合。这等效于为给定的每个对象调用 Project.configure(java.lang.Object, groovy.lang.Closure)

Iterable<T> configure(Iterable<T> objects, Action<? super T> configureAction)

通过 action 配置对象集合。

Object configure(Object object, Closure configureClosure)

通过闭包配置对象,闭包的委托设置为提供的对象。这样您就不必多次指定配置语句的上下文。

代替:

MyType myType = new MyType()
myType.doThis()
myType.doThat()

你可以这样做:

MyType myType = configure(new MyType()) {
    doThis()
    doThat()
}

正在配置的对象也作为参数传递给 closure,因此如果需要,您可以显式访问它

configure(someObj) { obj -> obj.doThis() }

NamedDomainObjectContainer<T> container(Class<T> type)

创建一个容器,用于管理指定类型的命名对象。指定的类型必须具有一个公共构造函数,该构造函数将名称作为 String 参数。

所有对象必须将其名称作为名为“name”的 bean 属性公开。名称在对象的生命周期内必须是常量。

NamedDomainObjectContainer<T> container(Class<T> type, Closure factoryClosure)

创建一个容器,用于管理指定类型的命名对象。给定的闭包用于创建对象实例。要创建的实例的名称作为参数传递给闭包。

所有对象必须将其名称作为名为“name”的 bean 属性公开。名称在对象的生命周期内必须是常量。

创建一个容器,用于管理指定类型的命名对象。给定的工厂用于创建对象实例。

所有对象必须将其名称作为名为“name”的 bean 属性公开。名称在对象的生命周期内必须是常量。

WorkResult copy(Closure closure)

复制指定的文件。给定的闭包用于配置 CopySpec,然后用于复制文件。示例

copy {
   from configurations.runtimeClasspath
   into 'build/deploy/lib'
}

请注意,CopySpec 可以嵌套

copy {
   into 'build/webroot'
   exclude '**/.svn/**'
   from('src/main/webapp') {
      include '**/*.jsp'
      filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])
   }
   from('src/main/js') {
      include '**/*.js'
   }
}

WorkResult copy(Action<? super CopySpec> action)

复制指定的文件。给定的 action 用于配置 CopySpec,然后用于复制文件。

CopySpec copySpec()

创建一个 CopySpec,稍后可用于复制文件或创建归档文件。

CopySpec copySpec(Closure closure)

创建一个 CopySpec,稍后可用于复制文件或创建归档文件。给定的闭包用于在 CopySpec 返回之前对其进行配置。

def baseSpec = copySpec {
   from "source"
   include "**/*.java"
}

task copy(type: Copy) {
   into "target"
   with baseSpec
}

CopySpec copySpec(Action<? super CopySpec> action)

创建一个 CopySpec,稍后可用于复制文件或创建归档文件。给定的 action 用于在 CopySpec 返回之前对其进行配置。

void defaultTasks(String... defaultTasks)

设置此项目的默认任务的名称。当启动构建时未提供任务名称时,将使用这些任务。

boolean delete(Object... paths)

删除文件和目录。

这将不会遵循符号链接。如果需要也遵循符号链接,请使用 Project.delete(org.gradle.api.Action)

WorkResult delete(Action<? super DeleteSpec> action)

删除指定的文件。给定的 action 用于配置 DeleteSpec,然后用于删除文件。

示例

project.delete {
    delete 'somefile'
    followSymlinks = true
}

void dependencyLocking(Action<? super DependencyLockingHandler> configuration)

配置依赖锁定

Project evaluationDependsOn(String path)

声明此项目对具有给定路径的项目具有评估依赖性。

ExecResult exec(Closure closure)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

执行外部命令。闭包配置 ExecSpec

ExecResult exec(Action<? super ExecSpec> action)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

执行外部命令。

给定的 action 配置一个 ExecSpec,它用于启动进程。此方法会阻塞直到进程终止,并返回其结果。

File file(Object path)

解析相对于此项目项目目录的文件路径。此方法根据其类型转换提供的路径

  • CharSequence,包括 StringGString。相对于项目目录解释。以 file: 开头的字符串被视为文件 URL。
  • File。如果文件是绝对文件,则按原样返回。否则,文件的路径将相对于项目目录解释。
  • Path。路径必须与默认提供程序关联,并且其处理方式与 File 的实例相同。
  • URIURL。URL 的路径被解释为文件路径。仅支持 file: URL。
  • DirectoryRegularFile
  • Provider,支持任何类型。提供程序的值被递归解析。
  • TextResource
  • Groovy Closure 或 Kotlin 函数,返回任何支持的类型。closure 的返回值被递归解析。
  • Callable,返回任何支持的类型。callable 的返回值被递归解析。

File file(Object path, PathValidation validation)

解析相对于此项目项目目录的文件路径,并使用给定的方案对其进行验证。有关可能的验证列表,请参见 PathValidation

ConfigurableFileTree fileTree(Object baseDir)

使用给定的基本目录创建一个新的 ConfigurableFileTree。给定的 baseDir 路径按照 Project.file(java.lang.Object) 进行评估。

返回的文件树是惰性的,因此它仅在查询文件树的内容时才扫描文件。文件树也是实时的,因此它在每次查询文件树的内容时都会扫描文件。

def myTree = fileTree("src")
myTree.include "**/*.java"
myTree.builtBy "someTask"

task copy(type: Copy) {
   from myTree
}

FileTree 中文件的顺序不稳定,即使在单台计算机上也是如此。

ConfigurableFileTree fileTree(Object baseDir, Closure configureClosure)

使用给定的基本目录创建一个新的 ConfigurableFileTree。给定的 baseDir 路径按照 Project.file(java.lang.Object) 进行评估。闭包将用于配置新的文件树。文件树作为其委托传递给闭包。示例

def myTree = fileTree('src') {
   exclude '**/.data/**'
   builtBy 'someTask'
}

task copy(type: Copy) {
   from myTree
}

返回的文件树是惰性的,因此它仅在查询文件树的内容时才扫描文件。文件树也是实时的,因此它在每次查询文件树的内容时都会扫描文件。

FileTree 中文件的顺序不稳定,即使在单台计算机上也是如此。

ConfigurableFileTree fileTree(Object baseDir, Action<? super ConfigurableFileTree> configureAction)

使用给定的基本目录创建一个新的 ConfigurableFileTree。给定的 baseDir 路径按照 Project.file(java.lang.Object) 进行评估。action 将用于配置新的文件树。示例

def myTree = fileTree('src') {
   exclude '**/.data/**'
   builtBy 'someTask'
}

task copy(type: Copy) {
   from myTree
}

返回的文件树是惰性的,因此它仅在查询文件树的内容时才扫描文件。文件树也是实时的,因此它在每次查询文件树的内容时都会扫描文件。

FileTree 中文件的顺序不稳定,即使在单台计算机上也是如此。

ConfigurableFileTree fileTree(Map<String, ?> args)

使用提供的参数映射创建一个新的 ConfigurableFileTree。该映射将作为属性应用于新的文件树。示例

def myTree = fileTree(dir:'src', excludes:['**/ignore/**', '**/.data/**'])

task copy(type: Copy) {
    from myTree
}

返回的文件树是惰性的,因此它仅在查询文件树的内容时才扫描文件。文件树也是实时的,因此它在每次查询文件树的内容时都会扫描文件。

FileTree 中文件的顺序不稳定,即使在单台计算机上也是如此。

ConfigurableFileCollection files(Object paths, Closure configureClosure)

使用给定的路径创建一个新的 ConfigurableFileCollection。路径按照 Project.files(java.lang.Object[]) 进行评估。文件集合使用给定的闭包进行配置。文件集合作为其委托传递给闭包。示例

files "$buildDir/classes" {
    builtBy 'compile'
}

返回的文件集合是惰性的,因此仅在查询文件集合的内容时才评估路径。文件集合也是实时的,因此它在每次查询集合的内容时都会评估上述内容。

使用给定的路径创建一个新的 ConfigurableFileCollection。路径按照 Project.files(java.lang.Object[]) 进行评估。文件集合使用给定的 action 进行配置。示例

files "$buildDir/classes" {
    builtBy 'compile'
}

返回的文件集合是惰性的,因此仅在查询文件集合的内容时才评估路径。文件集合也是实时的,因此它在每次查询集合的内容时都会评估上述内容。

返回一个 ConfigurableFileCollection,其中包含给定的文件。您可以将以下任何类型传递给此方法

  • CharSequence,包括 StringGString。相对于项目目录解释,如 Project.file(java.lang.Object) 中所述。以 file: 开头的字符串被视为文件 URL。
  • File。相对于项目目录解释,如 Project.file(java.lang.Object) 中所述。
  • Path,如 Project.file(java.lang.Object) 中所述。
  • URIURL。URL 的路径被解释为文件路径。仅支持 file: URL。
  • DirectoryRegularFile
  • CollectionIterable 或一个包含任何支持类型的对象的数组。集合的元素被递归转换为文件。
  • FileCollection。集合的内容包含在返回的集合中。
  • 一个 FileTreeDirectoryTree。树的内容包含在返回的集合中。
  • 任何受支持类型的 Provider。提供者的值将被递归转换为文件。如果提供者表示任务的输出,则当文件集合用作另一个任务的输入时,将执行该任务。
  • 一个 Callable,它返回任何受支持的类型。call() 方法的返回值将被递归转换为文件。null 返回值被视为空集合。
  • 一个 Groovy Closure 或 Kotlin 函数,它返回此处列出的任何类型。闭包的返回值将被递归转换为文件。null 返回值被视为空集合。
  • 一个 Task。转换为任务的输出文件。如果文件集合用作另一个任务的输入,则将执行该任务。
  • 一个 TaskOutputs。转换为相关任务的输出文件。如果文件集合用作另一个任务的输入,则将执行该任务。
  • 任何其他内容都将被视为错误。

返回的文件集合是惰性的,因此仅在查询文件集合的内容时才评估路径。文件集合也是实时的,因此它在每次查询集合的内容时都会评估上述内容。

返回的文件集合保持所提供路径的迭代顺序。

返回的文件集合维护生成文件的任务的详细信息,以便在将此文件集合用作某些任务的输入时执行这些任务。

此方法还可以用于创建空集合,该集合稍后可以被修改以添加元素。

Project findProject(String path)

按路径查找项目。如果路径是相对路径,则相对于此项目进行解释。

Object findProperty(String propertyName)

返回给定属性的值,如果未找到,则返回 null。此方法按以下方式查找属性

  1. 如果此项目对象具有给定名称的属性,则返回该属性的值。
  2. 如果此项目具有给定名称的扩展,则返回该扩展。
  3. 如果此项目的约定对象具有给定名称的属性,则返回该属性的值。
  4. 如果此项目具有给定名称的额外属性,则返回该属性的值。
  5. 如果此项目具有给定名称的任务,则返回该任务。
  6. 在此项目的祖先项目中向上搜索具有给定名称的约定属性或额外属性。
  7. 如果未找到,则返回 null 值。

Map<Project, Set<Task>> getAllTasks(boolean recursive)

返回此项目中包含的任务映射,以及可选的子项目。

Set<Task> getTasksByName(String name, boolean recursive)

返回此项目中包含的具有给定名称的任务集,以及可选的子项目。注意: 这是一个昂贵的操作,因为它需要配置所有项目。

boolean hasProperty(String propertyName)

确定此项目是否具有给定的属性。有关项目中可用的属性的详细信息,请参见 此处

ExecResult javaexec(Closure closure)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

执行 Java main 类。闭包配置 JavaExecSpec

ExecResult javaexec(Action<? super JavaExecSpec> action)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

执行外部 Java 进程。

给定的 action 配置一个 JavaExecSpec,它用于启动进程。此方法会阻塞直到进程终止,并返回其结果。

File mkdir(Object path)

创建目录并返回指向该目录的文件。

void normalization(Action<? super InputNormalizationHandler> configuration)

配置输入规范化。

Project project(String path)

按路径查找项目。如果路径是相对路径,则相对于此项目进行解释。

Project project(String path, Closure configureClosure)

按路径查找项目,并使用给定的闭包对其进行配置。如果路径是相对路径,则相对于此项目进行解释。目标项目作为闭包的委托传递给闭包。

Project project(String path, Action<? super Project> configureAction)

按路径查找项目,并使用给定的 action 对其进行配置。如果路径是相对路径,则相对于此项目进行解释。

Object property(String propertyName)

返回给定属性的值。此方法按以下方式查找属性

  1. 如果此项目对象具有给定名称的属性,则返回该属性的值。
  2. 如果此项目具有给定名称的扩展,则返回该扩展。
  3. 如果此项目的约定对象具有给定名称的属性,则返回该属性的值。
  4. 如果此项目具有给定名称的额外属性,则返回该属性的值。
  5. 如果此项目具有给定名称的任务,则返回该任务。
  6. 在此项目的祖先项目中向上搜索具有给定名称的约定属性或额外属性。
  7. 如果未找到,则会抛出 MissingPropertyException 异常。

String relativePath(Object path)

返回从项目目录到给定路径的相对路径。给定的路径对象(逻辑上)按照 Project.file(java.lang.Object) 所述进行解析,从中计算相对路径。

String relativeProjectPath(String path)

将名称转换为相对于此项目的项目路径。

void setProperty(String name, Object value)

设置此项目的属性。此方法在以下位置搜索具有给定名称的属性,并在找到属性的第一个位置设置属性。

  1. 项目对象本身。例如,rootDir 项目属性。
  2. 项目的 Convention 对象。例如,srcRootName java 插件属性。
  3. 项目的额外属性。

如果未找到该属性,则会抛出 MissingPropertyException 异常。

void subprojects(Action<? super Project> action)

配置此项目的子项目

此方法针对此项目的子项目执行给定的 Action

WorkResult sync(Action<? super SyncSpec> action)

将目标目录的内容与某些源目录和文件同步。给定的 action 用于配置 SyncSpec,然后用于同步文件。

此方法类似于 Project.copy(org.gradle.api.Action) 任务,不同之处在于目标目录将仅包含复制的文件。目标目录中存在的所有文件将在复制文件之前被删除,除非指定了保留选项。

示例

project.sync {
   from 'my/shared/dependencyDir'
   into 'build/deps/compile'
}

请注意,您可以保留目标目录中已存在的输出

project.sync {
    from 'source'
    into 'dest'
    preserve {
        include 'extraDir/**'
        include 'dir1/**'
        exclude 'dir1/extra.txt'
    }
}

FileTree tarTree(Object tarPath)

创建一个新的 FileTree,其中包含给定 TAR 文件的内容。给定的 tarPath 路径可以是

返回的文件树是惰性的,因此它仅在查询文件树的内容时才扫描文件。文件树也是实时的,因此它在每次查询文件树的内容时都会扫描文件。

除非传递了资源的自定义实现,否则 tar 树会尝试根据文件扩展名猜测压缩格式。

您可以将此方法与 Project.copy(org.gradle.api.Action) 方法结合使用来解压 TAR 文件

task untar(type: Copy) {
  from tarTree('someCompressedTar.gzip')

  //tar tree attempts to guess the compression based on the file extension
  //however if you must specify the compression explicitly you can:
  from tarTree(resources.gzip('someTar.ext'))

  //in case you work with unconventionally compressed tars
  //you can provide your own implementation of a ReadableResource:
  //from tarTree(yourOwnResource as ReadableResource)

  into 'dest'
}

Task task(String name)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

创建一个具有给定名称的 Task,并将其添加到此项目中。调用此方法等效于调用 Project.task(java.util.Map, java.lang.String),并使用空选项映射。

将任务添加到项目后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。有关更多详细信息,请参见 属性

如果项目中已存在具有给定名称的任务,则会抛出异常。

Task task(String name, Closure configureClosure)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

创建一个具有给定名称的 Task,并将其添加到此项目中。在返回任务之前,将执行给定的闭包以配置任务。

将任务添加到项目后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。有关更多详细信息,请参见 此处

Task task(String name, Action<? super Task> configureAction)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

创建一个具有给定名称的 Task,并将其添加到此项目中。在返回任务之前,将执行给定的 action 以配置任务。

将任务添加到项目后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。有关更多详细信息,请参见 此处

Task task(Map<String, ?> args, String name)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

创建一个具有给定名称的 Task,并将其添加到此项目中。可以将创建选项映射传递给此方法,以控制任务的创建方式。以下选项可用

<caption>允许的 Map 键</caption>
选项描述默认值
type要创建的任务的类。DefaultTask
overwrite替换现有任务?false
dependsOn此任务依赖的任务名称或任务名称集合[]
action要添加到任务的闭包或 Actionnull
description任务的描述。null
group此任务所属的任务组。null

将任务添加到项目后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。有关更多详细信息,请参见 此处

如果项目中已存在具有给定名称的任务,并且未将 override 选项设置为 true,则会抛出异常。

Task task(Map<String, ?> args, String name, Closure configureClosure)

注意:此方法已弃用,将在 Gradle 的下一个主要版本中删除。

创建一个具有给定名称的 Task,并将其添加到此项目中。在返回任务之前,将执行给定的闭包以配置任务。可以将创建选项映射传递给此方法,以控制任务的创建方式。有关可用选项,请参见 Project.task(java.util.Map, java.lang.String)

将任务添加到项目后,它将作为项目的属性提供,以便您可以在构建文件中按名称引用该任务。有关更多详细信息,请参见 此处

如果项目中已存在具有给定名称的任务,并且未将 override 选项设置为 true,则会抛出异常。

URI uri(Object path)

将文件路径解析为 URI,相对于此项目的项目目录。按照 Project.file(java.lang.Object) 所述评估提供的路径对象,但 'file:' URI 除外,支持任何 URI 方案。

FileTree zipTree(Object zipPath)

创建一个新的 FileTree,其中包含给定 ZIP 文件的内容。给定的 zipPath 路径按照 Project.file(java.lang.Object) 进行评估。您可以将此方法与 Project.copy(org.gradle.api.Action) 方法结合使用以解压缩 ZIP 文件。

返回的文件树是惰性的,因此它仅在查询文件树的内容时才扫描文件。文件树也是实时的,因此它在每次查询文件树的内容时都会扫描文件。

void appDirName(String appDirName)

允许更改应用程序目录。默认为 "src/main/application"。

EarPluginConvention deploymentDescriptor(Action<? super DeploymentDescriptor> configureAction)

为此 EAR 归档文件配置部署描述符。

给定的 action 将被执行以配置部署描述符。

void libDirName(String libDirName)

允许更改 EAR 文件中的库目录。默认为 "lib"。

Manifest manifest()

创建一个 Manifest 的新实例。

Manifest manifest(Closure closure)

创建并配置 Manifest 的新实例。给定的闭包在返回之前配置新的 manifest 实例。

Manifest manifest(Action<? super Manifest> action)

创建并配置 Manifest 的新实例。

脚本块详细信息

allprojects { }

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

此方法针对此项目及其子项目执行给定的闭包。目标 Project 作为闭包的委托传递给闭包。

委托给
allprojects 中的每个 Project

ant { }

针对此项目的 AntBuilder 执行给定的闭包。您可以在构建文件中使用它来执行 ant 任务。AntBuild 作为闭包的委托传递给闭包。有关示例,请参见 Project.getAnt() 的 javadoc

委托给
来自 antAntBuilder

artifacts { }

配置此项目发布的 artifacts。

此方法针对此项目的 ArtifactHandler 执行给定的闭包。ArtifactHandler 作为闭包的委托传递给闭包。

示例

configurations {
  //declaring new configuration that will be used to associate with artifacts
  schema
}

task schemaJar(type: Jar) {
  //some imaginary task that creates a jar artifact with the schema
}

//associating the task that produces the artifact with the configuration
artifacts {
  //configuration name and the task:
  schema schemaJar
}
委托给
来自 artifactsArtifactHandler

buildscript { }

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

给定的闭包针对此项目的 ScriptHandler 执行。ScriptHandler 作为闭包的委托传递给闭包。

委托给
来自 buildscriptScriptHandler

configurations { }

为此项目配置依赖关系配置。

此方法针对此项目的 ConfigurationContainer 执行给定的闭包。ConfigurationContainer 作为闭包的委托传递给闭包。

示例:请参阅 ConfigurationContainer 的文档

dependencies { }

为此项目配置依赖关系。

此方法针对此项目的 DependencyHandler 执行给定的闭包。DependencyHandler 作为闭包的委托传递给闭包。

示例:请参阅 DependencyHandler 的文档

委托给
来自 dependenciesDependencyHandler

repositories { }

为此项目配置仓库。

此方法针对此项目的 RepositoryHandler 执行给定的闭包。RepositoryHandler 作为闭包的委托传递给闭包。

委托给
来自 repositoriesRepositoryHandler

subprojects { }

配置此项目的子项目。

此方法针对此项目的每个子项目执行给定的闭包。目标 Project 作为闭包的委托传递给闭包。

委托给
subprojects 中的每个 Project

application { }

配置 application 插件添加的 JavaApplication

委托给
来自 applicationJavaApplication

checkstyle { }

配置 checkstyle 插件添加的 CheckstyleExtension

委托给
来自 checkstyleCheckstyleExtension

codenarc { }

配置 codenarc 插件添加的 CodeNarcExtension

委托给
来自 codenarcCodeNarcExtension

distributions { }

配置 distribution 插件添加的 DistributionContainer

deploymentDescriptor { }

为此 EAR 归档文件配置部署描述符。

给定的闭包将被执行以配置部署描述符。DeploymentDescriptor 作为其委托传递给闭包。

eclipse { }

配置 eclipse 插件添加的 EclipseModel

委托给
来自 eclipseEclipseModel

idea { }

配置 idea 插件添加的 IdeaModel

委托给
来自 ideaIdeaModel

jacoco { }

配置 jacoco 插件添加的 JacocoPluginExtension

委托给
来自 jacocoJacocoPluginExtension

base { }

配置 java 插件添加的 BasePluginExtension

委托给
来自 baseBasePluginExtension

java { }

配置 java 插件添加的 JavaPluginExtension

委托给
来自 javaJavaPluginExtension

reporting { }

配置 java 插件添加的 ReportingExtension

委托给
来自 reportingReportingExtension

sourceSets { }

配置此项目的源集。

给定的闭包将被执行以配置 SourceSetContainerSourceSetContainer 作为其委托传递给闭包。

请参阅以下示例,了解如何访问 SourceSet 'main' 以及如何配置 SourceDirectorySet 'java' 以排除某些包的编译。

plugins {
    id 'java'
}

sourceSets {
  main {
    java {
      exclude 'some/unwanted/package/**'
    }
  }
}
委托给
来自 sourceSetsSourceSetContainer

pmd { }

配置 pmd 插件添加的 PmdExtension

委托给
来自 pmdPmdExtension

publishing { }

配置 publishing 插件添加的 PublishingExtension

委托给
来自 publishingPublishingExtension

signing { }

配置 signing 插件添加的 SigningExtension

委托给
来自 signingSigningExtension

visualStudio { }

配置 visual-studio 插件添加的 VisualStudioRootExtension

xcode { }

配置 xcode 插件添加的 XcodeRootExtension

委托给
来自 xcodeXcodeRootExtension