系列文章:
1. 前言
我們都知道利用Android Studio編寫(xiě)APP時(shí)徒蟆,會(huì)使用Gradle這個(gè)工具,那么Gradle到底是什么呢?它在APP編寫(xiě)中起到什么作用呢忆家?
Gradle是一個(gè)項(xiàng)目自動(dòng)化建構(gòu)工具犹菇。構(gòu)建就是根據(jù)輸入信息執(zhí)行一系列操作,最后得到幾個(gè)產(chǎn)出物(APK包)芽卿。
傳統(tǒng)的構(gòu)建工具有Ant和Maven揭芍,但他們有一些缺點(diǎn),例如Maven使用XML來(lái)制定構(gòu)建規(guī)則卸例。XML雖然通俗易懂沼沈,但是很難在xml中描述if{某條件成立,編譯某文件}/else{編譯其他文件}這樣有不同條件的任務(wù)币厕。針對(duì)這類(lèi)問(wèn)題自然需要編程來(lái)解決列另,所以,Gradle選擇了Groovy語(yǔ)言旦装。
Gradle的另一個(gè)特點(diǎn)是它是一種DSL(Domain-Specific-Language)页衙,即特定領(lǐng)域語(yǔ)言,就是針對(duì)某一領(lǐng)域而產(chǎn)生的語(yǔ)言阴绢。DSL的好處是一句話可以包含很多意思店乐,因?yàn)橹会槍?duì)特定領(lǐng)域解決問(wèn)題。
Gradle當(dāng)前其支持的語(yǔ)言限于Java呻袭、Groovy和Scala眨八,計(jì)劃未來(lái)將支持更多的語(yǔ)言。Gradle可以幫你管理項(xiàng)目中的差異左电,依賴廉侧,編譯,打包篓足,部署...段誊,你可以定義滿足自己需要的構(gòu)建邏輯,寫(xiě)入到build.gradle中供日后復(fù)用栈拖,通俗的說(shuō):gradle是打包用的连舍。
1.1 Groovy基礎(chǔ)
Groovy是個(gè)靈活的動(dòng)態(tài)腳本語(yǔ)言,基于JVM虛擬機(jī)涩哟,語(yǔ)法和Java很相似索赏,又兼容Java,且在此基礎(chǔ)上增加了很多動(dòng)態(tài)類(lèi)型和靈活的特性贴彼,如支持閉包和DSL潜腻。Groovy的開(kāi)發(fā)環(huán)境配置可以參考Groovy 環(huán)境配置,具體語(yǔ)言特性教程可以參考-Groovy教程锻弓。
Groovy基于Java砾赔,又?jǐn)U展了Java,運(yùn)行過(guò)程中首先會(huì)先將其編譯成Java類(lèi)字節(jié)碼,然后通過(guò)JVM來(lái)執(zhí)行這個(gè)Java類(lèi)暴心。
1.2 Gradle介紹
Gradle是一個(gè)工具妓盲,也是一個(gè)編程框架。要弄清楚Gradle专普,則必須知道其組成的基本組件悯衬,Gradle中每個(gè)待被編譯的工程叫Project,每個(gè)Project在構(gòu)建時(shí)都包含一系列Task檀夹,如Android Studio構(gòu)建過(guò)程中包括Java代碼編譯Task筋粗,資源編譯Task,Lint規(guī)則檢查T(mén)ask炸渡,簽名Task等等娜亿。
配置Gradle環(huán)境前,確保已經(jīng)安裝配置好Java環(huán)境蚌堵,下載Gradle后解壓并配置環(huán)境變量买决,具體可以參考-配置Gradle
下面是一個(gè)Gradle語(yǔ)言版的Hello word例子:
// Gradle版Hello word
// 新建build.gradle文件:
task hello{ // 定義一個(gè)任務(wù)Task名為hello
doLast{ // 添加一個(gè)動(dòng)作Action,表示在Task執(zhí)行完畢后回調(diào)doLast閉包中的代碼
println'Hello World'//輸出字符串吼畏,單雙號(hào)均可
}
}
// 命令行:
gradle hello // 執(zhí)行build.gradle中名為Hello的任務(wù)
// 輸出:
Hello World
總而言之督赤,學(xué)習(xí)Gradle我們需要掌握Groovy語(yǔ)言,以及Gradle在Android Studio中的工作方式泻蚊,工作流程躲舌,工作原理。
2. Android studio中的Gradle文件
Android Studio 會(huì)使用高級(jí)構(gòu)建工具包 Gradle 來(lái)自動(dòng)執(zhí)行和管理構(gòu)建流程性雄,同時(shí)也允許開(kāi)發(fā)者定義靈活的自定義版本配置没卸。每個(gè)版本配置均可定義自己的一組代碼和資源,同時(shí)重復(fù)利用應(yīng)用各個(gè)版本的共用部分毅贮。
Gradle提供了一種編譯办悟、構(gòu)建和打包 Android 應(yīng)用或庫(kù)的靈活方式。
一個(gè)Android Studio和Gradle的項(xiàng)目目錄如下:
我們先來(lái)看看Android Gradle項(xiàng)目中那些涉及到gradle的文件分別是什么意思滩褥。
一個(gè)Android項(xiàng)目中所有文件的具體含義可參考Android開(kāi)發(fā)者指南
2.1 Gradle wrapper(gradle包裝)
上圖中涉及到Gradle wrapper的部分如下所示,具體有上圖中的gradle文件夾炫加,gradlew文件和gradlew.bat批處理文件瑰煎。
|--gradle
| |--wrapper
| |--gradle-wrapper.jar
| |--gradle-wrapper.properties
|--gradlew
|--gradlew.bat
gradle文件夾中包含wrapper,wrapper顧名思義是對(duì)Gradle的一層包裝俗孝,便于在團(tuán)隊(duì)開(kāi)發(fā)過(guò)程中統(tǒng)一Gradle構(gòu)建的版本酒甸。
上面目錄中gradlew
和gradlew.bat
分別是Linux和Windows下的可執(zhí)行腳本,gradle-wrapper.jar
是具體業(yè)務(wù)邏輯實(shí)現(xiàn)的jar包赋铝,gradlew
可執(zhí)行腳本最終還是使用這個(gè)jar包來(lái)執(zhí)行相關(guān)Gradle
操作插勤,gradle-wrapper.properties
是配置文件,用于配置使用哪個(gè)版本的Gradle,配置文件中的具體內(nèi)容如下所示:
#Wed Jun 19 10:09:08 GMT+08:00 2019
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-all.zip
2.2 Settings.gradle (多工程配置)
此文件用于初始化以及工程樹(shù)的配置农尖,大多數(shù)用于配置子工程析恋,在Gradle中多個(gè)工程是通過(guò)工程樹(shù)來(lái)表示的,相當(dāng)于我們?cè)贏ndroid Studio看到的Project和Module概念一樣盛卡,根工程相當(dāng)于Project助隧,子工程相當(dāng)于Module,一個(gè)Project可以有很多Module滑沧,一個(gè)子工程只有在Setting.gradle
中配置了才會(huì)生效并村。
配置舉例:
// 添加:app和:common這兩個(gè)module參與構(gòu)建
include ':app'
project(':app').projectDir = new File('存放目錄')
include':common'
project(':common').projectDir = new File('存放目錄')
如果不指定上述存放目錄,則默認(rèn)為是Settings.gradle
其同級(jí)目錄滓技。
2.3 build.gradle文件(版本文件)
每個(gè)工程都會(huì)有build.gradle文件哩牍,該文件是該工程的構(gòu)建入口,在此文件中可以對(duì)該工程進(jìn)行配置令漂,如配置版本膝昆,插件,依賴庫(kù)等洗显。
既然每個(gè)工程都有一個(gè)build文件外潜,那么根工程也不例外,在根工程中可以對(duì)子Module進(jìn)行統(tǒng)一配置挠唆,全局管理版本號(hào)或依賴庫(kù)处窥。
build文件分為Project和Module兩種,如下圖所示:
- Project的build.gradle:整個(gè)Project的共有屬性玄组,包括配置版本滔驾、插件、依賴庫(kù)等信息
- Module的build.gradle:各個(gè)module私有的配置文件
2.3.1 Project中build.gradle文件(頂層版本文件)
buildscript {
// gradle腳本執(zhí)行所需依賴倉(cāng)庫(kù)
repositories {
google()
jcenter()
}
// gradle腳本執(zhí)行所需依賴
dependencies {
classpath 'com.android.tools.build:gradle:3.4.1'
}
}
allprojects {
// 項(xiàng)目本身需要的依賴倉(cāng)庫(kù)
repositories {
google()
jcenter()
}
}
那么buildscript中的repositories和allprojects的repositories的作用和區(qū)別是什么呢俄讹?
- buildscript里是gradle腳本執(zhí)行所需依賴哆致,分別是對(duì)應(yīng)的maven庫(kù)和插件;
- allprojects里是項(xiàng)目本身需要的依賴患膛,比如我現(xiàn)在要依賴maven庫(kù)的xx庫(kù)摊阀,那么我應(yīng)該將maven {url '庫(kù)鏈接'}寫(xiě)在這里,而不是buildscript中踪蹬,否則找不到所需要的庫(kù)胞此。
參考 作者:CalvinNing -原文鏈接
2.3.2 Module中build.gradle文件(模塊級(jí)版本文件)
此部分內(nèi)容參考下文中3.3.2節(jié)。
2.4 gradle.properties(屬性文件)
此文件主要在其中配置項(xiàng)目全局 Gradle 設(shè)置跃捣,如 Gradle 守護(hù)進(jìn)程的最大堆大小漱牵。如需了解詳情,請(qǐng)參閱構(gòu)建環(huán)境
3. Gradle插件
3.1 插件介紹
Gradle的設(shè)計(jì)非常好疚漆,本身提供一些基本的概念和整體核心的框架酣胀,其他用于描述真實(shí)使用場(chǎng)景邏輯的都以插件擴(kuò)展的方式來(lái)實(shí)現(xiàn)刁赦,比如構(gòu)建Java應(yīng)用,就通過(guò)Java插件來(lái)實(shí)現(xiàn)闻镶,那么自然構(gòu)建Android應(yīng)用甚脉,就通過(guò)Android Gradle插件來(lái)實(shí)現(xiàn)。
Gradle 提供了很多官方插件儒溉,用于支持Java宦焦、Groovy等工程的構(gòu)建和打包。同時(shí)也提供了自定義插件機(jī)制顿涣,讓每個(gè)人都可以通過(guò)插件來(lái)實(shí)現(xiàn)特定的構(gòu)建邏輯波闹,并可以把這些邏輯打包起來(lái),分享給其他人涛碑。
Android Gradle插件是基于內(nèi)置的Java插件實(shí)現(xiàn)的精堕。Gradle插件的作用如下:
- 可以添加任務(wù)到項(xiàng)目,比如測(cè)試蒲障、編譯歹篓、打包等
- 可以添加依賴配置到項(xiàng)目,幫助配置項(xiàng)目構(gòu)建過(guò)程中需要的依賴揉阎,比如第三方庫(kù)等
- 可以向項(xiàng)目中現(xiàn)有的對(duì)象類(lèi)型添加新的擴(kuò)展屬性和方法等庄撮,幫助配置和優(yōu)化構(gòu)建
- 可以對(duì)項(xiàng)目進(jìn)行一些約定,比如約定源代碼存放位置等
3.2 插件種類(lèi)及用法
3.2.1 插件種類(lèi)
- 二進(jìn)制插件:實(shí)現(xiàn)了org.gradle.api.Plugin接口的插件毙籽,擁有plugin id洞斯,這個(gè) id 是插件全局唯一的標(biāo)識(shí)或名稱
- 腳本插件:嚴(yán)格上只是一個(gè)腳本,即自定義的以 .gradle 為后綴的腳本文件坑赡,可以來(lái)自本地或網(wǎng)絡(luò)
3.2.2 插件用法
下面分別說(shuō)下二進(jìn)制插件和腳本插件的使用方法烙如,
- 二進(jìn)制插件:
id式:apply plugin:'plugin id'
類(lèi)型式:apply plugin:org.gradle.api.plugins.JavaPlugin
簡(jiǎn)寫(xiě)式:apply plugin:JavaPlugin
- 腳本插件:apply from:'version.gradle'
- 第三方發(fā)布插件:apply plugin:'com.android.application'
3.3 Android Gradle插件
從Gradle的角度看,Android其實(shí)就是Gradle的一個(gè)第三方插件毅否,它是由Google的Android團(tuán)隊(duì)開(kāi)發(fā)的亚铁,Android 開(kāi)發(fā) IDE Android Studio 就采用 Gradle 構(gòu)建項(xiàng)目。
3.3.1 Android Gradle插件分類(lèi)
- App應(yīng)用工程:生成可運(yùn)行apk應(yīng)用螟加;插件id: com.android.application
- Library庫(kù)工程:生成AAR包給其他的App工程公用徘溢,其使用方式和jar包一樣,里面有相關(guān)的 Android 資源文件捆探;插件id: com.android.library
- Test測(cè)試工程:對(duì)App應(yīng)用工程或Library庫(kù)工程進(jìn)行單元測(cè)試甸昏;插件id: com.android.test
3.3.2 Android Gradle插件的應(yīng)用
主要來(lái)看下Android Gradle的build.gradle配置文件:
// 插件id
apply plugin:'com.android.application'
// 自定義配置入口,后續(xù)詳解
android{
compileSdkVersion 23 // 編譯Android工程的SDK版本
buildToolsVersion "23.0.1" // 構(gòu)建Android工程所用的構(gòu)建工具版本
defaultConfig{
applicationId "com.example.myapplication" // 配置包名
minSdkVersion 14 // 最低支持的Android系統(tǒng)的Level
targetSdkVersion 23 // 表示基本哪個(gè)Android版本開(kāi)發(fā)
versionCode 1 // APP應(yīng)用內(nèi)部版本名稱
versionName "1.0" // APP應(yīng)用的版本名稱
}
buildTypes{
release{ // 構(gòu)建類(lèi)型
minifyEnabled false // 是否啟用混淆
proguardFiles getDefaultPraguardFile('proguard-andrcid.txt'), 'proguard-rules.pro' // 配置混淆文件
}
}
}
// 配置第三方依賴
dependencies{
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation 'androidx.appcompat:appcompat:1.0.2'
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
testImplementation 'junit:junit:4.12'
androidTestImplementation 'androidx.test:runner:1.2.0'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
}
android{}是Android Gradle插件提供的一個(gè)擴(kuò)展類(lèi)型徐许,可以讓我們自定義Android Gradle工程。defaultConfig{}是默認(rèn)的配置卒蘸,是一個(gè)ProductFlavor(構(gòu)建渠道)雌隅,ProductFlavor允許我們根據(jù)不同的情況同時(shí)生成不同的APK包翻默。buildTypes{}是一個(gè)NamedDomainObjectContainer類(lèi)型,是一個(gè)域?qū)ο笄∑穑梢栽赽uildTypes{}里新增任意多個(gè)我們需要構(gòu)建的類(lèi)型修械,比如debug類(lèi)型。
NamedDomainObjectContainer具體可以參考-NamedDomainObjectContainer詳解
3.3.3 多渠道構(gòu)建
由于發(fā)布或者推廣APP的渠道不同检盼,就造成了Android APP可能會(huì)有很多個(gè)肯污,所以需要針對(duì)不同的渠道做不同的處理。
在Android Gradle中吨枉,定義了一個(gè)叫Build Variant(構(gòu)建變體/構(gòu)建產(chǎn)物)的概念蹦渣,一個(gè)構(gòu)建變體(Build Variant)=構(gòu)建類(lèi)型(Build Type)+構(gòu)建渠道(Product Flavor),下面舉個(gè)例子:
- Build Type有release貌亭、debug兩種構(gòu)建類(lèi)型
- Product Flavor有baidu柬唯、google兩種構(gòu)建渠道
- Build Variant有baiduRelease、baiduDebug圃庭、googleRelease锄奢、googleDebug四種構(gòu)件產(chǎn)物
配置好發(fā)布渠道后,Android Gradle插件就會(huì)生成很多task剧腻,比如assembleBaidu拘央,assembleRelease,assembleBaiduRelease等
Gradle中一個(gè)原子性的操作叫做task书在,簡(jiǎn)單理解為task是Gradle腳本中的最小可執(zhí)行單元灰伟。
- assemble開(kāi)頭的Task負(fù)責(zé)生成構(gòu)件產(chǎn)物(Apk)
- assembleBaidu:運(yùn)行后會(huì)生成baidu渠道的release和debug包
- assembleRelease:運(yùn)行后會(huì)生成所有渠道的release包
- assembleBaiduRelease:運(yùn)行后只會(huì)生成baidu的release包
4. Android Studio Gradle插件構(gòu)建流程
4.1 Gradle生命周期
- Initialization(初始化階段):Gradle支持單項(xiàng)目和多項(xiàng)目構(gòu)建。在初始化階段蕊温,Gradle確定將要參與構(gòu)建的項(xiàng)目袱箱,并為每個(gè)項(xiàng)目創(chuàng)建一個(gè)Project對(duì)象。通俗的說(shuō)就是執(zhí)行上述settings.gradle文件义矛。
- Configuration(配置階段):在此階段发笔,解析每個(gè)Project中的build.gradle文件,并生成將要執(zhí)行的task凉翻。
- Execution(執(zhí)行階段):執(zhí)行 task了讨,進(jìn)行主要的構(gòu)建工作
4.2 APK構(gòu)建流程
構(gòu)建流程涉及許多將項(xiàng)目轉(zhuǎn)換成 Android 應(yīng)用軟件包 (APK)的工具和流程,具體如下圖所示:
Android 應(yīng)用模塊的構(gòu)建流程通常按照以下步驟執(zhí)行:
- 編譯器將您的源代碼轉(zhuǎn)換成 DEX 文件(Dalvik 可執(zhí)行文件制轰,其中包括在 Android 設(shè)備上運(yùn)行的字節(jié)碼)前计,并將其他所有內(nèi)容轉(zhuǎn)換成編譯后的資源;
- APK 打包器將 DEX 文件和編譯后的資源合并到一個(gè) APK 中垃杖。不過(guò)男杈,在將應(yīng)用安裝并部署到 Android 設(shè)備之前,必須先為 APK 簽名调俘。
- APK 打包器使用調(diào)試或發(fā)布密鑰庫(kù)為 APK 簽名:
- a. 如果構(gòu)建的是調(diào)試版應(yīng)用(即專用于測(cè)試和分析的應(yīng)用)伶棒,則打包器會(huì)使用調(diào)試密鑰庫(kù)為應(yīng)用簽名旺垒。Android Studio 會(huì)自動(dòng)使用調(diào)試密鑰庫(kù)配置新項(xiàng)目。
- b. 如果構(gòu)建的是打算對(duì)外發(fā)布的發(fā)布版應(yīng)用肤无,則打包器會(huì)使用發(fā)布密鑰庫(kù)為應(yīng)用簽名
- 在生成最終 APK 之前先蒋,打包器會(huì)使用 zipalign 工具對(duì)應(yīng)用進(jìn)行優(yōu)化,以減少其在設(shè)備上運(yùn)行時(shí)所占用的內(nèi)存宛渐。
構(gòu)建流程結(jié)束時(shí)竞漾,將獲得應(yīng)用的調(diào)試版 APK 或發(fā)布版 APK,以用于部署窥翩、測(cè)試或發(fā)布給外部用戶业岁。
行文至此,本文已大概理清Gradle的基本概念鳍烁,以及其在Android Studio中的工作流程叨襟,但Android Studio中Gradle的工作具體細(xì)節(jié)還未解釋,如點(diǎn)擊Run圖標(biāo)背后的Gradle的具體工作流程是什么幔荒?這些會(huì)在后續(xù)博客中繼續(xù)分析糊闽。