Project

所有额外属性都必须通过“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 个方法“作用域”，它会搜索这些作用域中的方法

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

此项目的 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 构建器在 Groovy 中表示的

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

返回一个处理程序，用于将项目生成的工件分配给配置。

示例：请参见 ArtifactHandler 的文档

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

此项目的构建脚本。

如果文件存在，则在配置此项目时，将根据此项目评估该文件。

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

此项目的直接子级。

此项目的配置。

示例：参见 ConfigurationContainer 的文档

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

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

示例：参见 DependencyHandler 的文档

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

此项目的描述（如果有）。

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

此项目所属的 Gradle 调用。

此项目的组。Gradle 总是使用组的 toString() 值。组默认为以点分隔的路径。

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

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

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

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

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

此项目的父项目（如果有）。

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

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

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

虽然没有弃用，但更倾向于使用此接口的方法或 PluginAware.getPluginManager()，而不是使用插件容器。

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

使用 PluginManager.hasPlugin(java.lang.String) 或类似方法查询插件的应用，而不是通过插件容器进行查询。

返回此项目。此方法在构建文件中显式访问项目属性和方法时非常有用。例如，使用 project.name 比使用 name 能更好地表达您的意图。此方法还允许您从属性可能被隐藏的范围（例如，从方法或闭包）访问项目属性。

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

此项目的属性。有关项目可用属性的详细信息，请参见此处。

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

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

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

此项目所属层次结构的根项目。对于单项目构建，此方法返回此项目。

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

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

项目状态仅在您上传带有模块描述符的库时才相关。此处指定的状态将成为此模块描述符的一部分。

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

此项目的任务。

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

application 插件添加的 JavaApplication。

checkstyle 插件添加的 CheckstyleExtension。

codenarc 插件添加的 CodeNarcExtension。

由 distribution 插件添加的 DistributionContainer。

由 eclipse 插件添加的 EclipseModel。

由 idea 插件添加的 IdeaModel。

由 jacoco 插件添加的 JacocoPluginExtension。

由 java 插件添加的 BasePluginExtension。

由 java 插件添加的 JavaPluginExtension。

由 java 插件添加的 ReportingExtension。

由 pmd 插件添加的 PmdExtension。

由 publishing 插件添加的 PublishingExtension。

由 signing 插件添加的 SigningExtension。

由 visual-studio 插件添加的 VisualStudioRootExtension。

由 xcode 插件添加的 XcodeRootExtension。

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

在此项目评估完成后立即添加一个要调用的闭包。

在此项目评估完成后立即添加一个要执行的操作。

将项目作为参数传递给操作。传递给此方法的动作按其传递的相同顺序执行。父项目可以向其子项目添加一个动作，以便在构建文件运行后根据其状态进一步配置这些项目。

如果项目已被评估，此方法将失败。

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

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

此方法对本项目及其所有子项目执行给定的 Action。

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

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

给定的闭包用于配置 ObjectConfigurationAction，它“构建”插件应用程序。

此方法与 PluginAware.apply(java.util.Map) 的区别在于它允许多次调用配置操作的方法。

应用插件或脚本，使用作为映射提供的给定选项。如果插件已应用，则不执行任何操作。

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

可用的选项如下

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

给定的闭包用于配置 ObjectConfigurationAction，它“构建”插件应用程序。

此方法与 PluginAware.apply(java.util.Map) 的区别在于它允许多次调用配置操作的方法。

配置此项目的已发布工件。

此方法对本项目的 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
}

在此项目评估之前立即添加一个要调用的闭包。

在此项目评估之前立即添加一个要执行的操作。

将项目作为参数传递给动作。传递给此方法的动作按其传递的相同顺序执行。

如果项目已被评估，则该动作永远不会执行。

如果您在 `beforeEvaluate` 动作中调用此方法，则传递的动作永远不会执行。

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

通过一个动作来配置一个对象集合。

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

替代方法

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

你可以这样做

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

被配置的对象也会作为参数传递给闭包，因此如果需要，您可以显式访问它

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

创建用于管理指定类型命名对象的容器。指定类型必须具有一个接受字符串参数作为名称的公共构造函数。

所有对象 必须 将其名称作为名为“name”的bean属性公开。在对象的生命周期内，名称必须保持不变。

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

所有对象 必须 将其名称作为名为“name”的bean属性公开。在对象的生命周期内，名称必须保持不变。

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

所有对象 必须 将其名称作为名为“name”的bean属性公开。在对象的生命周期内，名称必须保持不变。

复制指定文件。给定的闭包用于配置 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'
   }
}

复制指定文件。给定的动作用于配置 CopySpec，然后用于复制文件。

创建 CopySpec，以后可用于复制文件或创建存档。

创建一个 CopySpec，以后可用于复制文件或创建存档。在返回此方法之前，给定的闭包用于配置 CopySpec。

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

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

创建一个 CopySpec，以后可用于复制文件或创建存档。给定的操作用于配置 CopySpec，然后由本方法返回。

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

删除文件和目录。

这将不跟踪符号链接。如果您也需要跟踪符号链接，请使用 Project.delete(org.gradle.api.Action)。

删除指定文件。给定的动作用于配置一个 DeleteSpec，然后用于删除文件。

示例

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

配置依赖锁定

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

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

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

使用给定的基本目录创建一个新的 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。给定的 baseDir 路径根据 Project.file(java.lang.Object) 进行评估。闭包将用于配置新的文件树。文件树作为其委托传递给闭包。示例：

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

task copy(type: Copy) {
   from myTree
}

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

即使在同一台计算机上，FileTree 中文件的顺序也不稳定。

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

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

task copy(type: Copy) {
   from myTree
}

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

即使在同一台计算机上，FileTree 中文件的顺序也不稳定。

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

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

task copy(type: Copy) {
    from myTree
}

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

即使在同一台计算机上，FileTree 中文件的顺序也不稳定。

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

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

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

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

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

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

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

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

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

返回的文件集合维护生成文件的任务的详细信息，以便如果此文件集合用作某个任务的输入，则这些任务将执行。

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

按路径定位项目。如果路径是相对路径，则相对于此项目进行解释。

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

返回此项目（可选地，包括其子项目）中包含的任务的映射。

返回此项目（可选地，包括其子项目）中包含的具有给定名称的任务集合。注意：这是一项昂贵的操作，因为它需要配置所有项目。

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

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

配置输入标准化。

按路径定位项目。如果路径是相对路径，则相对于此项目进行解释。

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

通过路径定位项目，并使用给定动作进行配置。如果路径是相对路径，则相对于此项目进行解释。

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

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

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

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

如果未找到属性，则抛出 MissingPropertyException。

配置此项目的子项目

此方法对此项目的所有子项目执行给定的 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'
    }
}

创建一个包含给定 TAR 文件内容的新 FileTree。给定 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 并将其添加到此项目。调用此方法等同于使用空选项映射调用 Project.task(java.util.Map, java.lang.String)。

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

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

创建一个名为 Task 并将其添加到此项目。在返回任务之前，执行给定的闭包来配置任务。

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

创建一个名为 Task 并将其添加到此项目。在返回任务之前，执行给定操作以配置任务。

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

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

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

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

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

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

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

将文件路径解析为 URI，相对于此项目的项目目录。评估所提供的路径对象，如 Project.file(java.lang.Object) 所述，但支持任何 URI 方案，而不仅仅是“file:”URI。

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

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

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

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

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

配置此项目的已发布工件。

此方法针对此项目的 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
}

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

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

配置此项目的依赖配置。

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

示例：参见 ConfigurationContainer 的文档

配置此项目的依赖项。

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

示例：参见 DependencyHandler 的文档

配置此项目的仓库。

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

配置此项目的子项目。

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

配置 application 插件添加的 JavaApplication。

配置 checkstyle 插件添加的 CheckstyleExtension。

配置 codenarc 插件添加的 CodeNarcExtension。

配置由 distribution 插件添加的 DistributionContainer。

配置 eclipse 插件添加的 EclipseModel。

配置 idea 插件添加的 IdeaModel。

配置 jacoco 插件添加的 JacocoPluginExtension。

配置由 java 插件添加的 BasePluginExtension。

配置由 java 插件添加的 JavaPluginExtension。

配置由 java 插件添加的 ReportingExtension。

配置 pmd 插件添加的 PmdExtension。

配置由 publishing 插件添加的 PublishingExtension。

配置由 signing 插件添加的 SigningExtension。

配置由 visual-studio 插件添加的 VisualStudioRootExtension。

配置由 xcode 插件添加的 XcodeRootExtension。