我們知道Android studio在發(fā)布之初就使用了gradle來(lái)構(gòu)建和管理Android項(xiàng)目乳怎,所以很多人在開(kāi)發(fā)Android應(yīng)用的過(guò)程中或多或少都和它打過(guò)交道,今天就給大家分享下我對(duì)gradle的一些理解铜秆,以及在Android開(kāi)發(fā)中使用gradle的一些經(jīng)驗(yàn)。
項(xiàng)目自動(dòng)化構(gòu)建工具的發(fā)展
最早在開(kāi)發(fā)的過(guò)程中是沒(méi)有項(xiàng)目自動(dòng)化構(gòu)建這個(gè)東西的,每次編譯項(xiàng)目的時(shí)候都是在命令行下對(duì)每個(gè)源文件執(zhí)行編譯命令,這種方式對(duì)于源文件不多的小項(xiàng)目還行踪蹬,但是當(dāng)項(xiàng)目比較大有成百上千個(gè)源文件需要編譯時(shí)就比較痛苦了,所以才有了一些自動(dòng)化構(gòu)建工具的誕生臣咖,其本質(zhì)是將一些繁瑣的無(wú)須人工干預(yù)的編譯流程交由機(jī)器來(lái)完成跃捣。
Makefile
最早出現(xiàn)的構(gòu)建工具是makefile,它主要用于C/C++項(xiàng)目夺蛇,大家會(huì)發(fā)現(xiàn)Android的源碼里面用的就是這一套構(gòu)建機(jī)制疚漆。makefile文件將程序編譯,鏈接,裝載(編譯原理上的東西娶聘,不熟悉的可以去翻閱相關(guān)書(shū)籍)的流程定義成一套統(tǒng)一的規(guī)則闻镶。其中就包括了:哪些源文件需要編譯,如何去編譯丸升,依賴(lài)的庫(kù)文件铆农,以及如何生成最終的可執(zhí)行文件等等。通過(guò)這些規(guī)則去實(shí)現(xiàn)我們的構(gòu)建需求狡耻,那么當(dāng)你在編譯整個(gè)工程的時(shí)候就只需要在命令行下執(zhí)行一個(gè)make命令就可以搞定了顿涣,極大的提高了項(xiàng)目的構(gòu)建效率。
Ant
ant也是一套構(gòu)建工具酝豪,主要應(yīng)用于Java項(xiàng)目(在eclipse上開(kāi)發(fā)Android項(xiàng)目的時(shí)候用的比較多)涛碑。它是一個(gè)將軟件編譯,測(cè)試孵淘,部署過(guò)程組織起來(lái)自動(dòng)化執(zhí)行的工具蒲障。ant構(gòu)建文件基于xml,每個(gè)文件對(duì)應(yīng)一個(gè)唯一的project瘫证,每個(gè)project下面可以有很多的target揉阎,這些target之間存在著一定的依賴(lài)關(guān)系,當(dāng)執(zhí)行某個(gè)target時(shí)需要先執(zhí)行該target的依賴(lài)背捌。每個(gè)target里面又包含了一些task毙籽,task就是最終需要執(zhí)行的命令。
Maven
ant雖然能大幅提高構(gòu)建的效率毡庆,但是也存在一些缺點(diǎn)坑赡,比方說(shuō)ant中的組件依賴(lài)(jar包)不能跨網(wǎng)絡(luò)使用,為了解決這個(gè)問(wèn)題么抗,于是maven出現(xiàn)了毅否,maven使用了強(qiáng)大的中央倉(cāng)庫(kù),使得項(xiàng)目中使用到的一些公共組件可以很方便的聯(lián)網(wǎng)依賴(lài)和更新蝇刀,這也極大的方便了一些開(kāi)源項(xiàng)目的使用螟加。
Gradle
由于maven的配置過(guò)于復(fù)雜和繁瑣,于是出現(xiàn)了我們今天的主角gradle吞琐,下面給大家看下兩者配置文件的對(duì)比捆探。
maven的配置:
<dependencies>
<dependency>
<groupId>com.crashlytics.sdk.android</groupId>
<artifactId>crashlytics</artifactId>
<version>2.5.5</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
</dependency>
</dependencies>
gradle的配置:
dependencies {
compile('com.crashlytics.sdk.android:crashlytics:2.5.5@aar')
testCompile('junit:junit:4.7')
}
Gradle
關(guān)于gradle的介紹和資料,網(wǎng)上有很多站粟,這里給出我覺(jué)得寫(xiě)的非常好的一篇文章:《深入理解Android之Gradle》黍图,該文章由《深入理解Android》的作者鄧平凡撰寫(xiě),質(zhì)量很高卒蘸。我大致總結(jié)一下我的理解:
- gradle基于groovy實(shí)現(xiàn)了一套編程框架雌隅,所以我們可以在gradle配置中通過(guò)編程的方式靈活的去配置我們的構(gòu)建過(guò)程翻默。
- gradle還是一種DSL領(lǐng)域相關(guān)語(yǔ)言,也就是行話恰起,比方說(shuō)sourceSets代表源文件集合等修械。基于這些行話我們可以很方便的建立一個(gè)模板检盼,通過(guò)這些模板可以更加方便的去配置我們的構(gòu)建過(guò)程肯污。
- gradle本質(zhì)上執(zhí)行一系列項(xiàng)目構(gòu)建過(guò)程,比方說(shuō)Android項(xiàng)目里的check,build,assemble,install等吨枉。所以要更好的使用gradle需要先熟悉你正在開(kāi)發(fā)項(xiàng)目的構(gòu)建流程蹦渣。
Gradle在Android中的實(shí)踐
android studio中g(shù)radle配置詳解
我們打開(kāi)AndroidStudio選擇Android視圖,可以很清楚的看到當(dāng)前項(xiàng)目下的gradle相關(guān)的配置文件貌亭,這里我們逐一介紹柬唯。
- build.gradle(Project:nim_demo)為root project(這里我們稱(chēng)項(xiàng)目的根目錄為root project)下的gradle配置文件,該配置文件一般用來(lái)做一些全局性的配置圃庭。
//全局配置構(gòu)建工具的classpath和遠(yuǎn)程倉(cāng)庫(kù)路徑锄奢,這里一般配置為gradle的,因?yàn)轫?xiàng)目在構(gòu)建過(guò)程中需要使用gradle去執(zhí)行剧腻,當(dāng)然如果你使用到了一些額外的插件拘央,比如注解處理器,也可以放在這里书在。
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.1.3'
}
}
//這里是對(duì)項(xiàng)目中的所有project進(jìn)行配置灰伟,以Android項(xiàng)目為例,這里的project包括項(xiàng)目下的各種module以及項(xiàng)目根目錄root project儒旬。
allprojects {
repositories {
jcenter()
}
}
//這里是對(duì)該project下的所有子project進(jìn)行配置栏账,以Android項(xiàng)目為例,一般我們可以把一些公用的操作放在一個(gè)gradle配置文件中义矛,然后import到各個(gè)子project的gradle中发笔,方便使用
subprojects {
//類(lèi)似于Java中的import功能,將該文件中定義的方法或變量導(dǎo)入后凉翻,其他gradle文件可以直接引用該gradle中的方法或變量
apply from: 'common.gradle'
}
//定義一些變量,該變量可以被其他gradle使用
ext {
compileSdkVersion=21
buildToolsVersion='23.0.2'
minSdkVersion=9
targetSdkVersion=19
versionCode=28
versionName='3.0.0'
targetCompatibility=1.7
sourceCompatibility=1.7
}
- build.gradle(Module:demo)為module下的gradle配置捻激,該配置只對(duì)該module生效制轰。
//聲明該模塊最終生成產(chǎn)物為apk
apply plugin: 'com.android.application'
android {
//編譯使用的sdk版本
compileSdkVersion 23
//使用的編譯工具版本,一般與sdk版本對(duì)應(yīng)胞谭,比如sdk version為23垃杖,則buildToolVersion應(yīng)選擇為23.x.x
buildToolsVersion rootProject.buildToolsVersion
//所有flavor的默認(rèn)配置
defaultConfig {
minSdkVersion 9
targetSdkVersion 23
}
//project的簽名配置
signingConfigs {
debug { storeFile file("debug.keystore") }
release {
storeFile file('release.keystore')
storePassword 'thisiskeystorepassword'
keyAlias 'nim_demo'
keyPassword 'thisiskeypassword'
}
}
//project的編譯類(lèi)型
buildTypes {
debug {
signingConfig signingConfigs.debug
}
release {
minifyEnabled true
zipAlignEnabled true
proguardFile('proguard.cfg')
signingConfig signingConfigs.release
}
}
//項(xiàng)目的目錄結(jié)構(gòu)
sourceSets {
main {
manifest.srcFile 'AndroidManifest.xml'
java.srcDirs = ['src']
aidl.srcDirs = ['src']
res.srcDirs = ['res']
assets.srcDirs = ['assets']
jniLibs.srcDirs = ['libs']
}
}
//lint檢查的選項(xiàng)
lintOptions {
checkReleaseBuilds false
abortOnError false
}
//生成dex的選項(xiàng)
dexOptions {
incremental true
preDexLibraries false
jumboMode true
javaMaxHeapSize "4g"
}
//打包選項(xiàng)
packagingOptions {
exclude 'META-INF/LICENSE.txt'
exclude 'META-INF/NOTICE.txt'
}
}
//該project的依賴(lài)
dependencies {
//依賴(lài)本地libs目錄下的jar包
compile fileTree(dir: 'libs', include: '*.jar')
//依賴(lài)uikit模塊
compile project(path: ':uikit')
}
這里的配置就是Android Gradle插件特有的配置,我們可以去官方網(wǎng)站上找到每個(gè)配置項(xiàng)的詳細(xì)說(shuō)明丈屹。
- build.gradle(Module:uikit)為uikit模塊下的配置调俘,該配置只對(duì)uikit生效伶棒。
//聲明該模塊編譯產(chǎn)物為aar
apply plugin: 'com.android.library'
//其余配置與dmeo模塊類(lèi)似,這里不再贅述
android {
useLibrary 'org.apache.http.legacy'
compileSdkVersion 23
buildToolsVersion buildToolsVer
sourceSets {
main {
manifest.srcFile 'AndroidManifest.xml'
java.srcDirs = ['src']
resources.srcDirs = ['src']
aidl.srcDirs = ['src']
renderscript.srcDirs = ['src']
res.srcDirs = ['res', 'res-ptr']
assets.srcDirs = ['assets']
jniLibs.srcDirs = ['libs']
}
}
}
dependencies {
compile 'com.android.support:appcompat-v7:23.3.0'
compile 'com.android.support:design:23.3.0'
compile fileTree(dir: 'libs', include: '*.jar')
}
- gradle-wrapper.properties(Gradle Version)為gradle的版本配置信息彩库。
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-2.14.1-all.zip
當(dāng)我們從github下載一個(gè)開(kāi)源項(xiàng)目導(dǎo)入到Android Studio中打開(kāi)時(shí)肤无,如果本地的gradle版本與該配置文件的版本不符就會(huì)去聯(lián)網(wǎng)下載對(duì)應(yīng)版本的gradle。由于gradle有時(shí)訪問(wèn)會(huì)比較慢骇钦,所以建議將網(wǎng)上的項(xiàng)目中該配置文件的版本改成本地已經(jīng)下載了的版本運(yùn)行宛渐,可以節(jié)省時(shí)間。有時(shí)修改版本信息后可能會(huì)出現(xiàn)一些語(yǔ)法錯(cuò)誤眯搭,這是本地的gradle版本不支持該語(yǔ)法窥翩,因此仍然需要重新下載對(duì)應(yīng)的gradle版本。
- gradle.properties(Project Properties)是與當(dāng)前項(xiàng)目相關(guān)的一個(gè)配置文件鳞仙,主要包括一些當(dāng)前項(xiàng)目中需要用到的鍵值對(duì)信息寇蚊。
#SDK下build工具的版本號(hào)
buildToolsVer=23.0.2
#app內(nèi)部版本號(hào)
verCode=16
#app外部版本號(hào)
verName=1.2
該屬性文件會(huì)被gradle插件自動(dòng)加載,所以在project的gradle文件中可以直接使用棍好。當(dāng)然你也可以自定義一個(gè)屬性文件me.properties幔荒,然后在build.gradle文件中讀取。
def getVer() {
Properties properties = new Properties()
File file = new File(rootDir.absolutePath + "/me.properties")
properties.load(file.newDataInputStream())
return properties.get("verName")//為了增加可讀性梳玫,添加return
}
- settings.gradle(Project Settins)為工程的設(shè)置文件爹梁,告訴gradle當(dāng)前工程的組成部分,比如有多少個(gè)子工程或者模塊提澎。
include ':uikit'
include ':demo'
該工程包含兩個(gè)模塊姚垃,一個(gè)是uikit,另一個(gè)是demo盼忌。
gradle中添加自定義task
前面我們說(shuō)的都是gradle的一些配置過(guò)程积糯,它們都是Android gradle插件已經(jīng)提供好了的配置選項(xiàng),我們只要參考官方文檔谦纱,合理的配置就能完成絕大部分的要求看成,但是有時(shí)候我們的項(xiàng)目可能需要在構(gòu)建過(guò)程中做一些特殊的處理,比方說(shuō)拷貝一些文件跨嘉,調(diào)試配置信息等川慌,這就需要我們?cè)趃radle的配置中添加一些自定義的task來(lái)完成。要找到合適的添加時(shí)機(jī)祠乃,我們就必須了解gradle的工作流程梦重。Gradle 工作流程主要包含三個(gè)階段:
- 首先是初始化階段,一般來(lái)說(shuō)就是執(zhí)行setting.gradle
- 然后是配置階段亮瓷,配置階段會(huì)解析每個(gè)project下的build.gradle琴拧,建立一個(gè)DAG有向圖來(lái)確定project中task之間的依賴(lài)關(guān)系。
-
最后是根據(jù)之前建立的task開(kāi)始執(zhí)行task嘱支。
image
通過(guò)以上流程蚓胸,我們發(fā)現(xiàn)gradle給我們提供了一些可以插入自己task的hook挣饥。
總結(jié)
gradle的東西暫時(shí)就講這么多,后續(xù)如果有進(jìn)一步的研究會(huì)再來(lái)分享沛膳。其實(shí)扔枫,對(duì)于我們來(lái)說(shuō)一般能掌握到一些基本的gradle配置就可以滿(mǎn)足大部分的項(xiàng)目需求,如果需要深入理解的話于置,就需要我們?nèi)パ芯縢roovy的語(yǔ)法和gradle的用戶(hù)參考手冊(cè)茧吊,來(lái)幫助我們實(shí)現(xiàn)更復(fù)雜的需求。