學習本系列前可以下載相關的github項目gradleLearnDemo。
地址:https://github.com/sososeen09/gradleLearnDemo
依賴管理是Gradle非常棒的一個功能,很多情況下,你只需要在構建文件中添加一行代碼,Gradle就會從遠程倉庫中下載依賴,在項目中就可以使用依賴中的類。如果你所依賴的這個庫本身也有它自己的依賴,Gradle會處理并解決這些問題,這些依賴中的依賴,被稱作傳遞性依賴。
Gradle使用 dependencies 這個DSL來定義構建所依賴的類庫,使用repositories 來告訴構建從哪里獲取依賴,當你配置好后,Gradle會自動下載依賴,并存儲在本地緩存中,在構建中使用它們,一個特定版本的依賴只會在你的機器上下載一次。
例如:
repositories {
mavenCentral()
}
dependencies {
compile 'org.jsoup:jsoup:1.9.2'
}
Gradle支持三種不同的依賴倉庫:Maven、Ivy和靜態文件或文件夾。一個依賴通常由三種元素定義的,可以稱呼它們為依賴屬性。
- group:通常標識一個組織、公司或者項目。如org.jsoup
- name:一個工件的名稱唯一的描述了依賴。如::jsoup
- version:一個類庫的版本號。如1.9.2
上面的dependencies,也可以使用map形式包含group、name、version屬性。例如:
dependencies {
compile group:'org.jsoup', name:'jsoup', version:'1.9.2'
}
對于依賴來說,唯一需要的字段是name。group和version都是可選的元素。盡管如此,為了表述清楚,建議添加group,而version可確保依賴庫不會自動更新。
1 使用和配置倉庫
為了方便,Gradle預定義了三個Maven倉庫:
- Jcenter
- Maven Central
- 本地Maven倉庫
Gradle使用Maven Central倉庫就是調用mavenCentral()方法,其它兩個倉庫的使用也類似。為了在構建腳本中包含它們,你需要這么做:
repositories {
jcenter()
mavenCentral()
mavenLocal()
}
Maven Central 和JCenter是兩個有名的遠程倉庫,一般不同時使用它們,通常推薦使用JCenter,它是Maven Central的超集,其也是Android Studio創建Android項目時的默認依賴倉庫,而且JCenter還支持HTTPS。
本地Maven倉庫是你已經使用了的所有依賴的本地緩存,你也可以自己添加依賴。默認情況下,依賴倉庫可以在一個名為.m2目錄文件夾的主目錄中找到。在Linux或Mac OS X上,該路徑是~/.m2,在Windows上路徑是%UserProfile%/.m2。
除了這些預定義的依賴倉庫,你也可以添加其它的公有或私有倉庫,可以指定一個任意的Maven或者Ivy倉庫的URL并且配置來使用身份驗證,或者可以使用簡單的文件系統倉庫來解決依賴關系。
在項目中定義倉庫的關鍵是RepositoryHandler接口,它提供了添加各種類型倉庫的方法。從項目上看,這些方法在repositories配置塊中被調用。
可以聲明多個倉庫,下載依賴的時候按照聲明的順序來檢查倉庫,倉庫提供了依賴優先原則,對于特定的依賴后續的倉庫聲明不會被進一步檢查。
repositories {
mavenLocal()
jcenter()
maven { url "https://jitpack.io" }
flatDir {
dirs 'libs'
}
}
Gradle API 支持兩種方式來配置一個自定義倉庫:maven()和mavenRepo()。
repositories {
maven {
name 'Custom Maven Repository'
url 'http://repo.acmp.com/release/'
}
}
也可以使用Ivy倉庫,
repositories {
ivy {
url 'http://repo.acmp.com/release/'
}
}
有些Maven倉庫的訪問需要憑證,那么可以這樣:
repositories {
maven {
url 'http://repo.acmp.com/release/'
credentials{
username 'user'
password 'secretPassword'
}
}
}
不建議在構建配置文件中存儲憑證,最好是在本地一個單獨的未納入版本控制系統的屬性文件存儲憑證
扁平的目錄倉庫
flat目錄是最簡單和最基本的倉庫形式。在文件系統中它是一個單獨的目錄,只包含jar文件或者Android 庫中的aar類型的文件,沒有maven元數據。
當聲明依賴時,你只能使用name和versin屬性,不能使用group屬性,因為它會導致產生不明確的依賴關系。
dependencies {
compile name: 'jsoup', version: '1.9.2'
}
repositories {
flatDir{
dirs 'flatlibs'
}
}
2 本地依賴
某些情況下,你可能仍然需要使用手動下載的jar文件或原生庫。
你可以使用Gradle提供的files方法來添加jar文件作為一個依賴,例如:
dependencies{
compile files('libs/jsoup.jar')
}
如果jar文件很多,我們一個一個的這樣依賴太繁瑣,就可以一次添加一個完成的文件夾:
dependencies{
compile fileTree('libs')
}
在Android Studio中創建Android項目的時候,新建的Android項目會有一個libs文件夾,其會被聲明為依賴的文件夾,并且通過過濾只依賴jar文件,而不是所有的文件:
dependencies{
compile fileTree(include: ['*.jar'], dir: 'libs')
}
原生依賴
如果想要使用C或C++編譯的原生依賴庫.so文件,需要指明jniLibs的目錄。假設.so文件也都放置在libs目錄下,如圖:
在腳本文件中就需要這么配置:
android {
sourceSets {
main {
jniLibs.srcDirs = ['libs']
}
}
}
依賴項目
如果在項目中創建了一個模塊作為依賴項目,那么需要在settings.gradle中添加該模塊,然后在應用模塊中使用它作為依賴。比如,在Android項目中,app模塊是我們的主模塊,library模塊是依賴模塊,也稱作依賴庫。
settings.gradle 中添加:
include ':app' ,' : library'
app模塊下的build.gradle中添加:
dependencies{
compile project(':library')
}
使用.aar文件
當你已經把aar文件放置在libs目錄下或者其他的扁平文件目錄下,添加aar文件作為依賴可以這么操作:
compile(name: 'libraryname', ext: 'aar')
這樣就告知Gradle查找具有特定名稱切擴展名為.aar的依賴庫
3 依賴配置
前面我們講了添加依賴庫的時候,前面都要有一個compile。其實這個compile就是一個配置Configuration。
Gradle根據配置對依賴進行分組,比如編譯Java時使用的是這組依賴,運行Java時又可以使用另一組依賴。每一組依賴稱為一個Configuration,在聲明依賴時,我們實際上是在設置不同的Configuration。
Java插件提供了6個現成的配置:compile、runtime、testCompile、testRuntime、archives、default。
而在Android中的插件也提供了幾個標準配置:compile、apk、provided、testCompile、androidTestCompile。
compile 是默認的配置,在編譯主應用時包含所有的依賴,不禁會將依賴添加至類路徑,還會生成對應的apk。
如果依賴使用apk配置,則該依賴只會被打包到apk,而不會被添加到編譯類路徑。
provided配置與apk配置相反,只在編譯的時候用到,其依賴不會被打包進apk。
testCompile、androidTestCompile配置會添加用于測試的額外依賴庫,在運行測試相關的任務時會被用到。比如添加JUnit或者Espresso測試框架。
要自定義一個配置Configuration,我們可以這樣:
configurations {
myConfiguration {
description = 'this is my configuration'
visible = false
}
}
我們在自定義配置的時候,同時定義了該配置的一些屬性,description表示的是該配置的描述信息,visiable表示該配置是否可以在該Project之外可見,默認是true。還可以定義其它的屬性,具體可參考Configuration這個類。當然,你也可以什么都不寫。configurations對應的Gradle的Api中ConfigurationContainer
這個類。
以上只是定義了一個名為myConfiguration的配置,我們并未向其中加入依賴。可以通過dependencies()方法向myConfiguration中加入實際的依賴項:
dependencies {
myConfiguration 'org.jsoup:jsoup:1.9.2'
}
repositories {
mavenCentral()
}
運行gradle dependencies
這個幫助task,會顯示當前的依賴樹。此時可以看到我們在myConfiguration這個配置中依賴的庫:
myConfiguration - this is my configuration
\--- org.jsoup:jsoup:1.9.2
由于我們只依賴了一個庫,所以依賴樹看著很簡潔。如果依賴很多庫,而這些依賴庫又都有傳遞性依賴,就有可能發生依賴沖突。如果存在依賴沖突,在默認情況下,Gradle會選擇最新版本,這和Maven是不同的,Maven會選擇離依賴樹最近的版本。如果你需要更改默認的沖突解決策略,可以自行搜索相關內容,本文就不多做介紹了。
使用Gradle API可以找到Gradle依賴的緩存文件放置的位置。
task printDependencies << {
configurations.getByName('myConfiguration').each { dependency ->
println dependency
}
}
執行gradle printDependencies
命令,可以看到打印結果:
> Task :printDependencies
/Users/jason/.gradle/caches/modules-2/files-2.1/org.jsoup/jsoup/1.9.2/5e3bda828a80c7a21dfbe2308d1755759c2fd7b4/jsoup-1.9.2.jar
4 動態版本聲明
如果想使用最新版本的依賴,可以使用占位符 latest.integration 。例如 :
org.jsoup:jsoup:latest-integration
或者,聲明版本屬性,通過使用一個加號(+) 標定它來動態改變:
org.jsoup:jsoup:1.+
當然了,我們最好是少用或者不用動態版本聲明。
下一篇,我們開始學習Gradle中的多項目構建。