Gradle中的buildScript代碼塊

在編寫Gradle腳本的時候，在build.gradle文件中經常看到這樣的代碼：

build.gradle

1 2 3 4 5 6 7 8 9

buildScript { repositories { mavenCentral() } } repositories { mavenCentral() }

這樣子很容易讓人奇怪，為什么repositories要聲明兩次哪？buildscript代碼塊中的聲明與下半部分聲明有什么不同？

其實答案非常簡單。buildscript中的聲明是gradle腳本自身需要使用的資源。可以聲明的資源包括依賴項、第三方插件、maven倉庫地址等。而在build.gradle文件中直接聲明的依賴項、倉庫地址等信息是項目自身需要的資源。

gradle是由groovy語言編寫的，支持groovy語法，可以靈活的使用已有的各種ant插件、基於jvm的類庫，這也是它比maven、ant等構建腳本強大的原因。雖然gradle支持開箱即用，但是如果你想在腳本中使用一些第三方的插件、類庫等，就需要自己手動添加對這些插件、類庫的引用。而這些插件、類庫又不是直接服務於項目的，而是支持其它build腳本的運行。所以你應當將這部分的引用放置在buildscript代碼塊中。gradle在執行腳本時，會優先執行buildscript代碼塊中的內容，然后才會執行剩余的build腳本。

舉個例子，假設我們要編寫一個task，用於解析csv文件並輸出其內容。雖然我們可以使用gradle編寫解析csv文件的代碼，但其實apache有個庫已經實現了一個解析csv文件的庫供我們直接使用。我們如果想要使用這個庫，需要在gradle.build文件中加入對該庫的引用。

build.gradle

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

buildscript { repositories { mavenLocal() mavenCentral() } dependencies { classpath 'org.apache.commons:commons-csv:1.0' } } import org.apache.commons.csv.* task printCSV() { doLast { def records = CSVFormat.EXCEL.parse(new FileReader('config/sample.csv')) for (item in records) { print item.get(0) + ' ' println item.get(1) } } }

buildscript代碼塊中的repositories和dependencies的使用方式與直接在build.gradle文件中的使用方式幾乎完全一樣。唯一不同之處是在buildscript代碼塊中你可以對dependencies使用classpath聲明。該classpath聲明說明了在執行其余的build腳本時，class loader可以使用這些你提供的依賴項。這也正是我們使用buildscript代碼塊的目的。

而如果你的項目中需要使用該類庫的話，就需要定義在buildscript代碼塊之外的dependencies代碼塊中。所以有可能會看到在build.gradle中出現以下代碼：

build.gradle

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

repositories { mavenLocal() mavenCentral() } dependencies { compile 'org.springframework.ws:spring-ws-core:2.2.0.RELEASE', 'org.apache.commons:commons-csv:1.0' } buildscript { repositories { mavenLocal() mavenCentral() } dependencies { classpath 'org.apache.commons:commons-csv:1.0' } } import org.apache.commons.csv.* task printCSV() { doLast { def records = CSVFormat.EXCEL.parse(new FileReader('config/sample.csv')) for (item in records) { print item.get(0) + ' ' println item.get(1) } } }

官方具體解釋請參見：http://chimera.labs.oreilly.com/books/1234000001741/ch04.html#_buildscript_dependencies