有关其他已翻译的章节请关注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 上的文档为准。如有发现翻译有误的地方,将首先在以上两个地方更新。因时间精力问题,博客中发表的译文基本不会同步修改。
第十三章 编写构建脚本
这一章着眼于一些编写构建脚本的详细信息。
在第 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
属性。
Project
对象提供了一些在构建脚本中可用的标准的属性。下表列出了常用的几个属性。
表 13.1. Project属性
名称 | 类型 | 默认值 |
project | Project | Project 实例 |
name | String | 项目目录的名称。 |
path | String | 项目的绝对路径。 |
description | String | 项目的描述。 |
projectDir | File | 包含生成脚本的目录。 |
buildDir | File |
|
group | Object | 未指定 |
version | Object | 未指定 |
ant | AntBuilder | AntBuilder 实例 |
当 Gradle 执行一个脚本时,它将脚本编译为一个实现了Script
接口的类。这意味着所有由该Script
接口声明的属性和方法在您的脚本中是可用的。
有两类可以在生成脚本中声明的变量: 局部变量和额外属性。
局部变量是用def
关键字声明的。它们只在定义它们的范围内可以被访问。局部变量是Groovy 语言底层的一个特征。
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
。
Groovy 提供了用于创建 DSL 的大量特点,并且 Gradle 构建语言利用了这些特点。了解构建语言是如何工作的,将有助于你编写构建脚本,特别是当你开始写自定义插件和任务的时候。
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/,了解更多详细信息。
Groovy 会自动地把一个属性的引用转换为对适当的 getter 或 setter 方法的调用。
调用方法时括号是可选的。
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)
Gradle DSL 在很多地方使用闭包。你可以在这里查看更多有关闭包的资料。当方法的最后一个参数是一个闭包时,你可以把闭包放在方法调用之后: