本章著眼于一些編寫構建腳本的詳細信息。
## [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#131-the-gradle-build-language-構建語言)13.1\. The Gradle build language 構建語言
Gradle 提供一種 domain specific language (領域特定語言)或者說是 DSL,來描述構建。這種構建語言基于 Groovy 中,并進行了一些補充,使其易于描述構建。
構建腳本可以包含任何 Groovy 語言的元素(除了聲明標簽任何語言元素)。Gradle 假定每個構建腳本使用 UTF-8 編碼。
## [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#132-the-project-api-項目-api)13.2\. The Project API 項目 API
在[Chapter 07\. Java Quickstart 快速開始 Java](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2007.%20Java%20Quickstart%20%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B%20Java.md)的教程中,我們使用了 apply() 方法。這方法從何而來?我們之前說在 Gradle 中構建腳本定義了一個 project 。在構建的每一個 project,Gradle 創建了一個?[Project](http://www.gradle.org/docs/current/dsl/org.gradle.api.Project.html)?類型的實例,并在構建腳本中關聯此 Project 對象。當構建腳本執行時,它會配置此Project 對象:
* 在構建腳本中,你所調用的任何一個方法,如果在構建腳本中未定義,它將被委托給 Project 對象。
* 在構建腳本中,你所訪問的任何一個屬性,如果在構建腳本里未定義,它也會被委托給 Project 對象。
下面我們來試試這個,試試訪問 Project 對象的 name 屬性。
Example 13.1\. Accessing property of the Project object
build.gradle
~~~
println name
println project.name
~~~
執行 gradle -q check
~~~
> gradle -q check
projectApi
projectApi
~~~
這兩個 println 語句打印出相同的屬性。在生成腳本中未定義的屬性,第一次使用時自動委托到P roject 對象。其他語句使用了在任何構建腳本中可以訪問的 project 屬性,則返回關聯的 Project 對象。只有當您定義的屬性或方法 Project 對象的一個成員相同名字時,你才需要使用project 屬性。
*獲取有關編寫構建腳本幫助*
*不要忘記您的構建腳本是簡單的 Groovy 代碼,并驅動著 Gradle API。并且 Project 接口是您在 Gradle API 中訪問一切 的入點。所以,如果你想知道什么 '標簽(tag)' 在構建腳本中可用,您可以去看項目接口的文檔。*
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1321-standard-project-properties-標準-project-屬性)13.2.1\. Standard project properties 標準 project 屬性
Project 對象提供了一些在構建腳本中可用的標準的屬性。下表列出了常用的幾個屬性。
| 名稱 | 類型 | 默認值 |
| --- | --- | --- |
| `project` | [`Project`](https://github.com/waylau/Gradle-2-User-Guide/blob/dsl/org.gradle.api.Project.html) | The?`Project實例` |
| `name` | `String` | 項目目錄的名稱 |
| `path` | `String` | 項目的絕對路徑 |
| `description` | `String` | 項目的描述 |
| `projectDir` | `File` | 包含生成腳本的目錄 |
| `buildDir` | `File` | `*`projectDir`*/build` |
| `group` | `Object` | `未指定` |
| `version` | `Object` | `未指定` |
| `ant` | [`AntBuilder`](https://github.com/waylau/Gradle-2-User-Guide/blob/javadoc/org/gradle/api/AntBuilder.html) | An?`AntBuilder實例` |
## [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#133-the-script-api-腳本-api)13.3\. The Script API 腳本 API
當 Gradle 執行一個腳本時,它將腳本編譯為一個實現了 Script 接口的類。這意味著所有由該 Script 接口聲明的屬性和方法在您的腳本中是可用的。
## [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#134-declaring-variables-聲明變量)13.4\. Declaring variables 聲明變量
有兩類可以在生成腳本中聲明的變量: 局部變量和額外屬性。
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1341-local-variables--局部變量)13.4.1\. Local variables 局部變量
局部變量是用 def 關鍵字聲明的。它們只在定義它們的范圍內可以被訪問。局部變量是 Groovy 語言底層的一個特征。
Example 13.2\. Using local variables
build.gradle
~~~
def dest = "dest"
task copy(type: Copy) {
from "source"
into dest
}
~~~
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1342-extra-properties-額外屬性)13.4.2\. Extra properties 額外屬性
Gradle 的域模型中,所有增強的對象都可以容納用戶定義的額外的屬性。這包括但并不限于 project、task 和源碼集。額外的屬性可以通過所屬對象的 ext 屬性進行添加,讀取和設置。或者,可以使用 ext塊同時添加多個屬性。
Example 13.3\. Using extra properties
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 的屬性被添加到每個源碼集。一旦屬性被添加,他們就可以像預定的屬性一樣被讀取和設置。
通過添加屬性所要求特殊的語法,Gradle 可以在你試圖設置 (預定義的或額外的) 的屬性,但該屬性拼寫錯誤或不存在時馬上失敗。額外屬性在任何能夠訪問它們所屬的對象的地方都可以被訪問,這使它們有著比局部變量更廣泛的作用域。父項目上的額外屬性,在子項目中也可以訪問。
有關額外屬性和它們的 API 的詳細信息,請參閱[ExtraPropertiesExtension](http://www.gradle.org/docs/current/dsl/org.gradle.api.plugins.ExtraPropertiesExtension.html)?類的 API。
## [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#135-some-groovy-basics-一些-groovy-的基礎)13.5\. Some Groovy basics 一些 Groovy 的基礎
Groovy 提供了用于創建 DSL 的大量特點,并且 Gradle 構建語言利用了這些特點。了解構建語言是如何工作的,將有助于你編寫構建腳本,特別是當你開始寫自定義插件和 task 的時候。
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1351-groovy-jdk)13.5.1\. Groovy JDK
Groovy 對 Java 的標準類增加了很多有用的方法。例如, Iterable 新增的each方法,會對Iterable 的元素進行遍歷:
Example 13.4\. Groovy JDK methods
build.gradle
~~~
// Iterable gets an each() method
configurations.runtime.each { File f -> println f }
~~~
在?[http://groovy.codehaus.org/groovy-jdk/](http://groovy.codehaus.org/groovy-jdk/)?查看詳情
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1352-property-accessors屬性訪問器)13.5.2\. Property accessors屬性訪問器
Groovy 會自動地把一個屬性的引用轉換為對適當的 getter 或 setter 方法的調用。
Example 13.5\. Property accessors
build.gradle
~~~
// Using a getter method
println project.buildDir
println getProject().getBuildDir()
// Using a setter method
project.buildDir = 'target'
getProject().setBuildDir('target')
~~~
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1353-optional-parentheses-on-method-calls-括號可選的方法調用)13.5.3\. Optional parentheses on method calls 括號可選的方法調用
調用方法時括號是可選的。
Example 13.6\. Method call without parentheses
build.gradle
~~~
test.systemProperty 'some.prop', 'value'
test.systemProperty('some.prop', 'value')
~~~
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1354-list-and-map-literals)13.5.4\. List and map literals
Groovy 提供了一些定義 List 和 Map 實例的快捷寫法。兩種類型都是簡單的 literal,但 map literal 有一些有趣的曲折。
例如,“apply” 方法(如你通常應用插件)需要 map 參數。然而,當你有一個像 “apply plugin:'java'”,你實際上并沒有使用 map literal ,你實際上使用“命名的參數”,這幾乎是和 map literal 相同的語法(不包包裝器)。命名參數列表將被轉換成一個 map 當方法被調用時,但它沒有在開始作為一個 map。
Example 13.7\. List and map literals
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.
Map<String, String> map = [key1:'value1', key2: 'value2']
// Groovy will coerce named arguments
// into a single map argument
apply plugin: 'java'
~~~
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1355-closures-as-the-last-parameter-in-a-method-作為方法最后一個參數的閉包)13.5.5\. Closures as the last parameter in a method 作為方法最后一個參數的閉包
Gradle DSL 在很多地方使用閉包。你可以在這里查看更多有關閉包的資料。當方法的最后一個參數是一個閉包時,你可以把閉包放在方法調用之后:
Example 13.8\. Closure as method parameter
build.gradle
~~~
repositories {
println "in a closure"
}
repositories() { println "in a closure" }
repositories({ println "in a closure" })
~~~
### [](https://github.com/waylau/Gradle-2-User-Guide/blob/master/Chapter%2013.%20Writing%20Build%20Scripts%20%E7%BC%96%E5%86%99%E6%9E%84%E5%BB%BA%E8%84%9A%E6%9C%AC.md#1356-closure-delegate--閉包委托)13.5.6\. Closure delegate 閉包委托
每個閉包都有一個委托對象,Groovy 使用它來查找變量和方法的引用,而不是作為閉包的局部變量或參數。Gradle 在配置閉包中使用到它,把委托對象設置為被配置的對象。
Example 13.9\. Closure delegates
build.gradle
~~~
dependencies {
assert delegate == project.dependencies
testCompile('junit:junit:4.11')
delegate.testCompile('junit:junit:4.11')
}
~~~
- 關于
- 第1章 Introduction 介紹
- 第2章 Overview 總覽
- 第3章 Tutorials 教程
- 第4章 Installing Gradle 安裝
- 第5章 Troubleshooting 問題解決
- 第6章 Build Script Basics 構建腳本的基礎識
- 第7章 Java Quickstart 快速開始 Java
- 第8章 Dependency Management Basics 依賴管理的基礎知識
- 第9章 Groovy Quickstart 快速開始 Groovy
- 第10章 Web Application Quickstart 快速開始 Web 應用
- 第11章 Using the Gradle Command-Line 使用 Gradle 命令行
- 第12章 Using the Gradle Graphical User Interface 使用 Gradle 圖形化用戶界面
- 第13章 Writing Build Scripts 編寫構建腳本
- 第14章 Tutorial - 'This and That' 教程-這個那個
- 第15章 More about Tasks 更多關于任務
- 第16章 Working With Files 跟文件工作
- 第17章 Using Ant from Gradle 從 Gradle 使用 Ant
- 第18章 Logging 日志.md
- 第19章 The Gradle Daemon 守護進程
- 第20章 The Build Environment 構建環境
- 第21章 Gradle Plugins 插件
- 第22章 Standard Gradle plugins 標準 Gradle 插件
- 附錄E Existing IDE Support and how to cope without it 支持的 IDE 以及如何應對沒有它