一、什么是Gradle
簡單的說两入,Gradle是一個構(gòu)建工具净宵,它是用來幫助我們構(gòu)建app的,構(gòu)建包括編譯裹纳、打包等過程择葡。我們可以為Gradle指定構(gòu)建規(guī)則,然后它就會根據(jù)我們的“命令”自動為我們構(gòu)建app剃氧。Android Studio中默認就使用Gradle來完成應(yīng)用的構(gòu)建敏储。有些同學(xué)可能會有疑問:”我用AS不記得給Gradle指定過什么構(gòu)建規(guī)則呀,最后不還是能搞出來個apk朋鞍∫烟恚“ 實際上,app的構(gòu)建過程是大同小異的滥酥,有一些過程是”通用“的更舞,也就是每個app的構(gòu)建都要經(jīng)歷一些公共步驟。因此坎吻,在我們在創(chuàng)建工程時缆蝉,Android Studio自動幫我們生成了一些通用構(gòu)建規(guī)則,很多時候我們甚至完全不用修改這些規(guī)則就能完成我們app的構(gòu)建瘦真。
有些時候刊头,我們會有一些個性化的構(gòu)建需求,比如我們引入了第三方庫诸尽,或者我們想要在通用構(gòu)建過程中做一些其他的事情原杂,這時我們就要自己在系統(tǒng)默認構(gòu)建規(guī)則上做一些修改。這時候我們就要自己向Gradle”下命令“了弦讽,這時候我們就需要用Gradle能聽懂的話了污尉,也就是Groovy。Groovy是一種基于JVM的動態(tài)語言往产,關(guān)于它的具體介紹被碗,感興趣的同學(xué)可以文末參考”延伸閱讀“部分給出的鏈接。
我們在開頭處提到“Gradle是一種構(gòu)建工具”仿村。實際上锐朴,當(dāng)我們想要更靈活的構(gòu)建過程時,Gradle就成為了一個編程框架——我們可以通過編程讓構(gòu)建過程按我們的意愿進行蔼囊。也就是說焚志,當(dāng)我們把Gradle作為構(gòu)建工具使用時,我們只需要掌握它的配置腳本的基本寫法就OK了畏鼓;而當(dāng)我們需要對構(gòu)建流程進行高度定制時酱酬,就務(wù)必要掌握Groovy等相關(guān)知識了。限于篇幅云矫,本文只從構(gòu)建工具使用者的角度來介紹Gradle的一些最佳實踐膳沽,在文末“延伸閱讀”部分給出了幾篇高質(zhì)量的深入介紹Gradle的文章,其中包含了Groovy等知識的介紹让禀。
二挑社、Gradle的基本組分
- Project與Task
在Gradle中,每一個待構(gòu)建的工程是一個Project巡揍,構(gòu)建一個Project需要執(zhí)行一系列Task痛阻,比如編譯、打包這些構(gòu)建過程的子過程都對應(yīng)著一個Task腮敌。具體來說阱当,一個apk文件的構(gòu)建包含以下Task:Java源碼編譯、資源文件編譯缀皱、Lint檢查斗这、打包以生成最終的apk文件等等。
- 插件
插件的核心工作有兩個:一是定義Task啤斗;而是執(zhí)行Task表箭。也就是說,我們想讓Gradle能正常工作钮莲,完成整個構(gòu)建流程中的一系列Task的執(zhí)行免钻,必須導(dǎo)入合適的插件,這些插件中定義了構(gòu)建Project中的一系列Task崔拥,并且負責(zé)執(zhí)行相應(yīng)的Task极舔。
在新建工程的app模塊的build.gradle文件的第一行,往往都是如下這句:
apply plugin: 'com.android.application'
這句話的意思就是應(yīng)用“com.android.application“這個插件來構(gòu)建app模塊链瓦,app模塊就是Gradle中的一個Project拆魏。也就是說盯桦,這個插件負責(zé)定義并執(zhí)行Java源碼編譯、資源文件編譯渤刃、打包等一系列Task拥峦。實際上"com.android.application"整個插件中定義了如下4個頂級任務(wù):
assemble: 構(gòu)建項目的輸出(apk)
check: 進行校驗工作
build: 執(zhí)行assemble任務(wù)與check任務(wù)
clean: 清除項目的輸出
當(dāng)我們執(zhí)行一個任務(wù)時,會自動執(zhí)行它所依賴的任務(wù)卖子。比如略号,執(zhí)行assemble任務(wù)會執(zhí)行assembleDebug任務(wù)和assembleRelease任務(wù),這是因為一個Android項目至少要有debug和release這兩個版本的輸出洋闽。
-
Gradle配置文件
我們在Android Studio中新建一個工程玄柠,可以得到如下的工程結(jié)構(gòu)圖:
image.png
上面我們說過,Android Studio中的一個Module即為Gradle中的一個Project诫舅。上圖的app目錄下羽利,存在一個build.gradle文件,代表了app Module的構(gòu)建腳本刊懈,它定義了應(yīng)用于本模塊的構(gòu)建規(guī)則铐伴。我們可以看到,工程根目錄下也存在一個build.gradle文件俏讹,它代表了整個工程的構(gòu)建当宴,其中定義了適用于這個工程中所有模塊的構(gòu)建規(guī)則。
接下來我們介紹一下上圖中其他幾個Gradle配置文件:
gradle.properties: 從它的名字可以看出泽疆,這個文件中定義了一系列“屬性”户矢。實際上,這個文件中定義了一系列供build.gradle使用的常量殉疼,比如keystore的存儲路徑梯浪、keyalias等等。
gradlew與gradlew.bat: gradlew為Linux下的shell腳本瓢娜,gradlew.bat是Windows下的批處理文件挂洛。gradlew是gradle wrapper的縮寫,也就是說它對gradle的命令進行了包裝眠砾,比如我們進入到指定Module目錄并執(zhí)行“gradlew.bat assemble”即可完成對當(dāng)前Module的構(gòu)建(Windows系統(tǒng)下)虏劲。
local.properties: 從名字就可以看出來,這個文件中定義了一些本地屬性褒颈,比如SDK的路徑柒巫。
settings.gradle: 假如我們的項目包含了不只一個Module時,我們想要一次性構(gòu)建所有Module以完成整個項目的構(gòu)建谷丸,這時我們需要用到這個文件堡掏。比如我們的項目包含了ModuleA和ModuleB這兩個模塊,則這個文件中會包含這樣的語句:include ':ModuleA', ':ModuleB'刨疼。
4. 構(gòu)建腳本
首先我們來看一下工程目錄下的build.gradle泉唁,它指定了整個項目的構(gòu)建規(guī)則鹅龄,它的內(nèi)容如下:
buildscript {
repositories {
jcenter() //構(gòu)建腳本中所依賴的庫都在jcenter倉庫下載
}
dependencies {
//指定了gradle插件的版本
classpath 'com.android.tools.build:gradle:1.5.0'
}
}
allprojects {
repositories {
//當(dāng)前項目所有模塊所依賴的庫都在jcenter倉庫下載
jcenter()
}
}
我們再來簡單介紹下app模塊的build.gradle的內(nèi)容
//加載用于構(gòu)建Android項目的插件
apply plugin: 'com.android.application'
android { //構(gòu)建Android項目使用的配置
compileSdkVersion 23 //指定編譯項目時使用的SDK版本
buildToolsVersion "23.0.1" //指定構(gòu)建工具的版本
defaultConfig {
applicationId "com.absfree.debugframwork" //包名
minSdkVersion 15 //指定支持的最小SDK版本
targetSdkVersion 23 //針對的目標SDK版本
versionCode 1
versionName "1.0"
}
buildTypes { //針對不同的構(gòu)建版本進行一些設(shè)置
release { //對release版本進行的設(shè)置
minifyEnabled false //是否開啟混淆
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' //指定混淆文件的位置
}
}
}
dependencies { //指定當(dāng)前模塊的依賴
compile fileTree(dir: 'libs', include: ['*.jar'])
testCompile 'junit:junit:4.12'
compile 'com.android.support:appcompat-v7:23.1.1'
compile 'com.android.support:design:23.1.1'
}
三、常見配置
整個工程的build.gradle通常不需我們改動亭畜,這里我們介紹下一些對模塊目錄下build.gradle文件的常見配置砾层。
1. 依賴第三方庫
當(dāng)我們的項目中用到了了一些第三方庫時,我們就需要進行一些配置贱案,以保證能正確導(dǎo)入相關(guān)依賴。
設(shè)置方法很簡單止吐,比如我們在app模塊中中用到了Fresco宝踪,只需要在build.gradle文件中的dependencies塊添加如下語句:
dependencies {
...
compile 'com.facebook.fresco:fresco:0.11.0'
}
這樣一來,Gradle會自動從jcenter倉庫下載我們所需的第三方庫并導(dǎo)入到項目中碍扔。
2. 導(dǎo)入本地jar包
在使用第三方庫時瘩燥,除了像上面那樣從jcenter倉庫下載,我們還可以導(dǎo)入本地的jar包不同。
配置方法也很簡單厉膀,只需要先把jar文件添加到app\libs目錄下,然后在相應(yīng)jar文件上單擊右鍵二拐,選擇“Ad As Library”服鹅。
然后在build.gradle的dependencies塊下添加如下語句:
compile files('libs/xxx.jar')
實際上我們可以看到,系統(tǒng)為我們創(chuàng)建的build.gradle中就已經(jīng)包含了如下語句:
compile fileTree(dir: 'libs', include: ['*.jar'])
這句話的意思是百新,將libs目錄下的所有jar包都導(dǎo)入企软。所以實際上我們只需要把jar包添加到libs目錄下并“Add As Library"即可。
3. 依賴其它模塊
假設(shè)我們的項目包含了多個模塊饭望,并且app模塊依賴other模塊仗哨,那么我們只需app\build.gradle的denpendencies塊下添加如下語句:
compile project(':other')
4. 構(gòu)建輸出為aar文件
通常我們構(gòu)建的輸出目標都是apk文件,但如果我們的當(dāng)前項目時Android Library铅辞,我們的目標輸出就是aar文件厌漂。
要想達到這個目的也很容易,只需要把build.gradle的第一句改為如下:
apply plugin:'com.android.library'
這話表示我們使用的插件不再是構(gòu)建Android應(yīng)用的插件斟珊,而是構(gòu)建Android Library的插件苇倡,這個插件定義并執(zhí)行用于構(gòu)建Android Library的一系列Task。
5. 自動移除不再使用的資源
只需進行如下配置:
android {
...
}
buildTypes {
release {
...
shrinkResources true
...
}
}
6. 忽略Lint錯誤
在我們構(gòu)建Android項目的過程中囤踩,有時候會由于Lint錯誤而終止雏节。
當(dāng)這些錯誤來自第三方庫中時,我們往往想要忽略這些錯誤從而繼續(xù)構(gòu)建進程高职。這時候钩乍,我們可以只需進行如下配置:
android {
...
lintOptions {
abortOnError false
}
}
7. 集成簽名配置
在構(gòu)建release版本的Android項目時,每次都手動導(dǎo)入簽名文件怔锌,鍵入密碼寥粹、keyalias等信息十分麻煩变过。
通過將簽名配置集成到構(gòu)建腳本中,我們就不必每次構(gòu)建發(fā)行版本時都手動設(shè)置了涝涤。具體配置如下:
signingConfigs {
myConfig { //將"xx"替換為自己的簽名文件信息
storeFile file("xx.jks")
storePassword "xx"
keyAlias "xx"
keyPassword "xx"
}
}
android {
buildTypes {
release {
signingConfig signingConfigs.myConfig //在release塊中加入這行
...
}
}
...
}
真實開發(fā)中媚狰,我們不應(yīng)該把密碼等信息直接寫到build.gradle中,更好的做法是放在gradle.properties中設(shè)置:
RELEASE_STOREFILE=xxx.jks
RELEASE_STORE_PASSWORD = xxx
RELEASE_KEY_ALIAS=xxx
RELEASE_KEY_PASSWORD=xxx</pre>
然后在build.gradle中直接引用即可:
signingConfigs {
myConfig {
storeFilefile(RELEASE_STOREFILE)
storePassword RELEASE_STORE_PASSWORD
keyAlias RELEASE_KEY_ALIAS
keyPassword RELEASE_KEY_PASSWORD
}
}
關(guān)于Gradle的其他配置方法可以參考“延伸閱讀”部分
四阔拳、延伸閱讀
- 深入理解Android之Gradle:http://blog.csdn.net/Innost/article/details/48228651