Gradle 1.12 翻译——第十三章编写构建脚本

时间：2014-11-10 10:00:42 阅读：217 评论：0 收藏：0 [点我收藏+]

有关其他已翻译的章节请关注Github上的项目：https://github.com/msdx/gradledoc/tree/1.12，或访问：http://gradledoc.qiniudn.com/1.12/userguide/userguide.html

本文原创，转载请注明出处：http://blog.csdn.net/maosidiaoxian/article/details/40976325

关于我对Gradle的翻译，以Github上的项目及http://gradledoc.qiniudn.com 上的文档为准。如有发现翻译有误的地方，将首先在以上两个地方更新。因时间精力问题，博客中发表的译文基本不会同步修改。

第十三章编写构建脚本

这一章着眼于一些编写构建脚本的详细信息。

13.1. Gradle 构建语言

Gradle 提供一种领域特定语言或者说是 DSL，来描述构建。这种构建语言基于 Groovy 中，并进行了一些补充，使其易于描述构建。

13.2. Project API

在第 7 章， Java 快速入门的教程中，我们使用了 apply ()方法。这方法从何而来？我们之前说在 Gradle 中构建脚本定义了一个项目（project）。在构建的每一个项目中，Gradle 创建了一个Project类型的实例，并在构建脚本中关联此Project对象。当构建脚本执行时，它会配置此Project对象：

获取有关编写构建脚本帮助

不要忘记您的构建脚本是简单的 Groovy 代码，并驱动着 Gradle API。并且Project接口是您在 Gradle API 中访问一切的入点。所以，如果你想知道什么 ‘标签（tag）‘ 在构建脚本中可用，您可以去看项目接口的文档。

在构建脚本中，你所调用的任何一个方法，如果在构建脚本中未定义，它将被委托给Project对象。
在构建脚本中，你所访问的任何一个属性，如果在构建脚本里未定义，它也会被委托给Project对象。

下面我们来试试这个，试试访问Project对象的name属性。

Example 13.1. 访问 Project 对象的属性

build.gradle

println name
println project.name

gradle -q check的输出结果

> gradle -q check
projectApi
projectApi

这两个println语句打印出相同的属性。在生成脚本中未定义的属性，第一次使用时自动委托到Project对象。其他语句使用了在任何构建脚本中可以访问的project属性，则返回关联的Project对象。只有当您定义的属性或方法Project对象的一个成员相同名字时，你才需要使用project属性。

13.2.1. 标准project属性

Project对象提供了一些在构建脚本中可用的标准的属性。下表列出了常用的几个属性。

表 13.1. Project属性

名称	类型	默认值
`project`	`Project`	`Project`实例
`name`	`String`	项目目录的名称。
`path`	`String`	项目的绝对路径。
`description`	`String`	项目的描述。
`projectDir`	`File`	包含生成脚本的目录。
`buildDir`	`File`	`projectDir/build`
`group`	`Object`	`未指定`
`version`	`Object`	`未指定`
`ant`	`AntBuilder`	`AntBuilder`实例

13.3. Script API

当 Gradle 执行一个脚本时，它将脚本编译为一个实现了Script接口的类。这意味着所有由该Script接口声明的属性和方法在您的脚本中是可用的。

13.4. 声明变量

有两类可以在生成脚本中声明的变量：局部变量和额外属性。

13.4.1. 局部变量局部

局部变量是用def关键字声明的。它们只在定义它们的范围内可以被访问。局部变量是Groovy 语言底层的一个特征。

示例 13.2. 使用局部变量

build.gradle

def dest = "dest"

task copy(type: Copy) {
    from "source"
    into dest
}

13.4.2. 额外属性

Gradle 的域模型中，所有增强的对象都可以容纳用户定义的额外的属性。这包括但并不限于项目（project）、任务（task）和源码集（source set）。额外的属性可以通过所属对象的ext属性进行添加，读取和设置。或者，可以使用ext块同时添加多个属性。

13.3 例子. 使用额外属性

build.gradle

apply plugin: "java"

ext {
    springVersion = "3.1.0.RELEASE"
    emailNotification = "build@master.org"
}

sourceSets.all { ext.purpose = null }

sourceSets {
    main {
        purpose = "production"
    }
    test {
        purpose = "test"
    }
    plugin {
        purpose = "production"
    }
}

task printProperties << {
    println springVersion
    println emailNotification
    sourceSets.matching { it.purpose == "production" }.each { println it.name }
}

gradle -q printProperties的输出结果

> gradle -q printProperties
3.1.0.RELEASE
build@master.org
main
plugin

在此示例中，一个ext代码块将两个额外属性添加到project对象中。此外，通过将ext.purpose设置为null（null是一个允许的值），一个名为purpose的属性被添加到每个源码集（source set）。一旦属性被添加，他们就可以像预定的属性一样被读取和设置。

通过添加属性所要求特殊的语法，Gradle 可以在你试图设置（预定义的或额外的）的属性，但该属性拼写错误或不存在时 fail fast。^[5]额外属性在任何能够访问它们所属的对象的地方都可以被访问，这使它们有着比局部变量更广泛的作用域。父项目上的额外属性，在子项目中也可以访问。

有关额外属性和它们的 API 的详细信息，请参阅ExtraPropertiesExtension。

13.5.一些 Groovy 的基础知识

Groovy 提供了用于创建 DSL 的大量特点，并且 Gradle 构建语言利用了这些特点。了解构建语言是如何工作的，将有助于你编写构建脚本，特别是当你开始写自定义插件和任务的时候。

13.5.1. Groovy JDK

Groovy 对 JVM 的类增加了很多有用的方法。例如， iterable 新增的each方法，会对iterable 的元素进行遍历：

示例 13.4. Groovy JDK 的方法

build.gradle

// Iterable gets an each() method
configurations.runtime.each { File f -> println f }

可以看看http://groovy.codehaus.org/groovy-jdk/，了解更多详细信息。

13.5.2. 属性访问器

Groovy 会自动地把一个属性的引用转换为对适当的 getter 或 setter 方法的调用。

例子 13.5. 属性访问器

build.gradle

// Using a getter method
println project.buildDir
println getProject().getBuildDir()

// Using a setter method
project.buildDir = ‘target‘
getProject().setBuildDir(‘target‘)

13.5.3 括号可选的方法调用

调用方法时括号是可选的。

示例 13.6. 不带括号的方法调用

build.gradle

test.systemProperty ‘some.prop‘, ‘value‘
test.systemProperty(‘some.prop‘, ‘value‘)

13.5.4. List 和 Map

Groovy 提供了一些定义List和Map实例的快捷写法。

Example 13.7. List and map

build.gradle

// List literal
test.includes = [‘org/gradle/api/**‘, ‘org/gradle/internal/**‘]

List<String> list = new ArrayList<String>()
list.add(‘org/gradle/api/**‘)
list.add(‘org/gradle/internal/**‘)
test.includes = list

// Map literal
apply plugin: ‘java‘

Map<String, String> map = new HashMap<String, String>()
map.put(‘plugin‘, ‘java‘)
apply(map)

13.5.5.作为方法最后一个参数的闭包

Gradle DSL 在很多地方使用闭包。你可以在这里查看更多有关闭包的资料。当方法的最后一个参数是一个闭包时，你可以把闭包放在方法调用之后：

Example 13.8. 作为方法参数的闭包

build.gradle

repositories {
    println "in a closure"
}
repositories() { println "in a closure" }
repositories({ println "in a closure" })

13.5.6. 闭包委托（delegate）

每个闭包都有一个委托对象，Groovy 使用它来查找变量和方法的引用，而不是作为闭包的局部变量或参数。Gradle 在配置闭包中使用到它，把委托对象设置为被配置的对象。

Example 13.9. 闭包委托

build.gradle

dependencies {
    assert delegate == project.dependencies
    compile(‘junit:junit:4.11‘)
    delegate.compile(‘junit:junit:4.11‘)
}

[5] 截至 Gradle 1.0-milestone-9版本，我们鼓励但不强制要求使用 ext 来添加额外属性因此，当未知的属性被设置时，Gradle不会构建失败。然而，它将打印一个警告。

Gradle 1.12 翻译——第十三章编写构建脚本

标签：gradle 编写构建脚本翻译

原文地址：http://blog.csdn.net/maosidiaoxian/article/details/40976325

踩

(0)

评论一句话评论（0）

分享档案

更多>

2021年07月29日 (22)
2021年07月28日 (40)
2021年07月27日 (32)
2021年07月26日 (79)
2021年07月23日 (29)
2021年07月22日 (30)
2021年07月21日 (42)
2021年07月20日 (16)
2021年07月19日 (90)
2021年07月16日 (35)

周排行

Gradle 1.12 翻译——第十三章 编写构建脚本

第十三章 编写构建脚本

13.1. Gradle 构建语言

13.2. Project API

获取有关编写构建脚本帮助

13.2.1. 标准project属性

13.3. Script API

13.4. 声明变量

13.4.1. 局部变量局部

13.4.2. 额外属性

13.5.一些 Groovy 的基础知识

13.5.1. Groovy JDK

13.5.2. 属性访问器

13.5.3 括号可选的方法调用

13.5.4. List 和 Map

13.5.5.作为方法最后一个参数的闭包

13.5.6. 闭包委托（delegate）

Gradle 1.12 翻译——第十三章编写构建脚本

第十三章编写构建脚本