Gradle中的buildScript程式碼塊

weixin_34177064發表於2014-08-27
GradleUI

在編寫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

相關文章