在上一篇文章中 Gradle 之語言基礎 Groovy 主要介紹了 Groovy 的基礎語法(如果沒有 Groovy 的基礎，建議先看看上篇文章，如果可以動手敲一下里面的示例代碼就更好不過了)，也是為本篇文章打基礎的。
本篇文章主要介紹 Gradle 在 Android 中的應用(Android DSL 和 Gradle DSL)，也是通過一些示例來介紹和理解，主要分為以下一些內容，示例代碼都在 GradleForAndroid
一. Gradle 構建生命周期
一個 Gradle 的構建通常有如下三個階段
初始化：項目 Project 實例會在該階段被創建。如果一個項目中包含有多個模塊，并且每一個模塊都有其對應的 build.gradle 文件，就會為每一個模塊都創建一個對應的 Project 實例
配置：執行各個模塊下的 build.gradle 腳本，為 Project實例創建和配置 Task，構造 Task 任務依賴關系圖以便在執行階段按照依賴關系執行 Task
執行：在這個階段將會決定執行哪個 Task，哪個 Task 被執行取決于開始該次構建的參數配置和該 Gradle 文件的當前目錄
在創建完成一個新的 Android 應用項目之后，一般情況下， .gradle 文件的目錄結構如下所示：
GradleForAndroid
|---- build.gradle
|---- setting.gradle
\---- app
\---- build.gradle
其中，兩個文件 build.gradle 和 setting.gradle 位于項目的根目錄下，還有一個 build.gradle 位于 \app\ 目錄下。\build.gradle 是頂層構建文件，\app\build.gradle 是模塊構建文件。
我們以上面這個新創建的項目來學習 Gradle 的構建生命周期
1.1 初始化
在初始化階段，會創建一個 Setting 對象，對應著 setting.gradle 文件，
Setting 對象的一個主要作用就是聲明哪些模塊將會參與到構建中去，Setting 文檔(Gradle API 5.0)
在新建的項目中，setting.gradle 文件一般會默認包含一行內容，如下所示
include ':app'
上面這一行，其實是一行 groovy 代碼的簡寫，對應的是 Setting#include(String[] projectPaths) 方法，表示 :app 模塊將會參與到構建中去。
如果我們創建一個 library 庫，setting.gradle 將會變為如下所示，表示 :app 和 :library 兩個模塊將會參與到構建中
include ':app', ':library'
setting.gradle 腳本文件可以中讀取一些只可讀的配置信息，這些配置信息的來源可以有如下三個：
可以在本工程的 gradle.properties 文件中定義配置信息
也可以在系統的 gradle.properties 文件中定義配置信息，系統的 gradle.properties 位于 user's .gradle 目錄下
還可以通過 -P 命令參數指定配置信息，比如 ./gradlew clean -P cmd='Hello from commandLine' 便在執行 clean task 的時候，指定了 cmd='Hello from commandLine' 配置信息
上面講到，一個 setting.gradle 文件對應著一個 Setting 對象，Setting 對象包含的方法如下圖所示
Setting.png
例如有如下代碼
include ':app', ':library'
println propertiesFile
println DEFAULT_SETTINGS_FILE
println getRootProject().name
println getRootProject().path
getGradle().addBuildListener(new BuildListener() {
@Override
void buildStarted(Gradle gradle) {
println 'buildStarted'
}
@Override
void settingsEvaluated(Settings settings) {
println "settingsEvaluated"
}
@Override
void projectsLoaded(Gradle gradle) {
println 'projectsLoaded'
}
@Override
void projectsEvaluated(Gradle gradle) {
println 'projectsEvaluated'
}
@Override
void buildFinished(BuildResult result) {
println 'buildFinished'
}
})
其輸出是：
Hello from gradle.properties
settings.gradle
GradleForAndroid
:
settingsEvaluated
projectsLoaded
projectsEvaluated
BUILD SUCCESSFUL in 0s
3 actionable tasks: 3 executed
buildFinished
1.2 配置
在配置階段，會執行所有的 build.gradle，包括項目根目錄下的 build.gradle 和各個 module 下的 build.gradle
在執行 build.gradle 的時候，會為每個 build.gradle 創建一個對應的 Project 對象，Project 文檔(Gradle API 5.0)
配置階段會執行 build.gradle 里面的所有代碼和 Task 里面的配置代碼，比如下面的 printProperties Task，只執行了 doLast{} 之外的代碼，doLast{} 之外的代碼是 Task 的配置代碼
配置執行完成之后，會根據各個 Task 的依賴關系生成一個有向無環圖，可以通過Gradle對象的getTaskGraph方法訪問，對應的類為TaskExecutionGraph
在執行所有的 Gradle Task 之前，都會執行 初始化階段 和 配置階段 的代碼
比如有如下代碼
// Top-level build file where you can add configuration options common to all sub-projects/modules.
println "/build.gradle 開始配置"
buildscript {
println "/build.gradle buildscript 開始配置"
ext.kotlin_version = '1.2.71'
repositories {
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.0.1'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
println "/build.gradle buildscript 結束配置"
}
allprojects {
println "/build.gradle allprojects 開始配置"
repositories {
google()
jcenter()
}
println "/build.gradle allprojects 結束配置"
}
task clean(type: Delete) {
delete rootProject.buildDir
}
ext {
local = 'Hello from build.gradle'
}
task printProperties {
println "/build.gradle task printProperties 開始配置"
println '/build.gradle task printProperties'
println "/build.gradle task printProperties 結束配置"
doLast {
println local
println propertiesFile
if (project.hasProperty('cmd')) {
println cmd
}
}
}
println "/build.gradle 結束配置"
在 Terminal 里面執行 ./gradlew clean 會有如下輸出
Hello from gradle.properties
settings.gradle
GradleForAndroid
:
settingsEvaluated
projectsLoaded
// 配置階段，執行 /build.gradle 里面的代碼
> Configure project :
/build.gradle buildscript 開始配置
/build.gradle buildscript 結束配置
/build.gradle 開始配置
/build.gradle allprojects 開始配置
/build.gradle allprojects 結束配置
/build.gradle allprojects 開始配置
/build.gradle allprojects 結束配置
/build.gradle allprojects 開始配置
/build.gradle allprojects 結束配置
/build.gradle task printProperties 開始配置
/build.gradle task printProperties
/build.gradle task printProperties 結束配置
/build.gradle 結束配置
projectsEvaluated
BUILD SUCCESSFUL in 0s
3 actionable tasks: 3 executed
buildFinished
1.3 執行
執行階段就是指執行某個具體的任務 Task。說道 Task，我想大家應該比較熟悉，在 Android 項目中依賴了 Android Gradle 插件以后，會有許多自帶的 Task，比如常用的 clean、assemble 等，而且大家更應該掌握的是如何自定義 Task，關于 Task 會單獨抽一節來講述。
二. 自定義 Task
任務 Task 代表了在構建過程中的一個單原子性的動作，比如：編程生成 .class 文件或者生成 javadoc 等.
每一個 task 都是屬于某一個 Project 對象的，每一個 task 都有自己的名字，在 project 中 task 的名字是唯一的，如果在整個項目 projects 范圍內需要指定某個 task 的話，也需要指定 project 的名字，project 和 task 的名字中間使用 : 相連接，比如：./gradlew :app:clean
創建 Task 對象的方法有以下幾種
// 通過 TaskContainer.create(String) 創建 `Task`
getTasks().create('helloTask') {
doLast {
println 'create Task by TaskContainer'
}
}
task helloTask1 {
doLast {
println 'create Task by task(String name)'
}
}
class HelloTask extends DefaultTask {
def message = 'create Task by extends DefaultTask'
@TaskAction
def hello() {
println message
}
}
// 通過 type 參數可以指定該 task 的父類，默認的父類是 DefaultTask
task helloTask2(type: HelloTask)
一個 Task 是由一系列的 Action 組成的，當一個 Task 執行的時候就是按照一定的順序執行這些 Action，可以有以下兩種方式向 Task 中添加 Action
通過閉包 Closure 的方式添加 Action
class HelloTask extends DefaultTask {
def message = 'create Task by extends DefaultTask'
@TaskAction
def hello() {
println message
}
}
task helloTask2(type: HelloTask) {
doFirst {
println 'helloTask2 doFirst'
}
doLast {
println 'helloTask2 doLast'
}
}
直接添加 Action 實例對象
def taskDef = task helloTask3(type: HelloTask)
taskDef.doFirst(new Action() {
@Override
void execute(Task task) {
println 'helloTask3 Action execute doFirst'
}
})
taskDef.doLast(new Action() {
@Override
void execute(Task task) {
println 'helloTask3 Action execute doLast'
}
})
Task 依賴關系 & Task 執行順序
在 Task 中有兩個很重要的概念 dependsOn 和 mustRunAfter。dependsOn 用于聲明兩個 Task 對象之間的依賴關系，mustRunAfter 用于聲明一個 Task 必須在另一個 Task 之后運行，雖然感覺差不多，但是實際上還是有區別的
helloTaskB.dependsOn(helloTaskA) 中，可以單獨運行 helloTaskA，但是運行 helloTaskB 的時候會觸發 helloTaskA 的執行
helloTaskC.mustRunAfter(helloTaskA)中，helloTaskA 和 helloTaskC 都是可以單獨運行的，但是當 helloTaskC 和 helloTaskA 同時運行時，helloTaskC 一定會在 helloTaskA 之后運行
task helloTaskA {
doFirst {
println 'helloTaskA doFirst'
}
}
task helloTaskB {
doFirst {
println 'helloTaskB doFirst'
}
}
helloTaskB.dependsOn(helloTaskA)
task helloTaskC {
doFirst {
println 'helloTaskC doFirst'
}
}
helloTaskC.mustRunAfter(helloTaskA)
Android 中使用自定義 Task
在 Gradle 構建的時候，需要將自定義的 Task 添加到構建過程中時，需要把握好添加自定義 Task 的時機與位置
下面一幅圖清晰地展示了 Gradle 構建過程中一些關鍵的回調，可以在下面一些回調中添加自定義 Task
在 project 對象中，可以通過 gradle 對象得到 TaskExecutionGraph 的實例對象，也可以通過 TaskExecutionGraph 實例對象一些關鍵回調添加自定義的 Task。比如下面這個例子，就是在 TaskExecutionGraph 實例對象準備好之后，彈出一個 dialog 用于輸入 storePass 和 keyPass，然后將 storePass 和 keyPass 設置到 android.signingConfigs 中
apply plugin: 'com.android.application'
import groovy.swing.SwingBuilder
//......
gradle.taskGraph.whenReady { taskGraph ->
if (taskGraph.hasTask(':app:assembleRelease')) {
def storePass = ''
def keyPass = ''
if (System.console() == null) {
System.setProperty('java.awt.headless', 'false')
new SwingBuilder().edt {
dialog(modal: true, title: 'Enter password', alwaysOnTop: true, resizable: false, locationRelativeTo: null, pack: true, show: true) {
vbox { // Put everything below each other
label(text: "Please enter store passphrase:")
def input1 = passwordField()
label(text: "Please enter key passphrase:")
def input2 = passwordField()
button(defaultButton: true, text: 'OK', actionPerformed: {
storePass = input1.password;
keyPass = input2.password;
dispose();
})
}
}
}
} else {
storePass = System.console().readPassword("\nPlease enter store passphrase: ")
keyPass = System.console().readPassword("\nPlease enter key passphrase: ")
}
if (storePass.size() <= 0 || keyPass.size() <= 0) {
throw new InvalidUserDataException("You must enter the passwords to proceed.")
}
storePass = new String(storePass)
keyPass = new String(keyPass)
android.signingConfigs.release.storePassword = storePass
android.signingConfigs.release.keyPassword = keyPass
}
}
如下圖所示 TaskExecutionGraph 的方法結構如下圖所示，都是非常實用方便的方法
TaskExecutionGraph.png
三. Android DSL & Gradle DSL
3.1 Android DSL
Android DSL 是 Gradle 的一個 Android 插件，其實在使用 Android Studio 開發的時候經常會和 Android DSL 打交道，比如下面 android{ } 閉包 里面的內容都是 Android DSL
apply plugin: 'com.android.application'
import groovy.swing.SwingBuilder
android {
compileSdkVersion 27
defaultConfig {
applicationId "com.lijiankun24.gradleforandroid"
minSdkVersion 15
targetSdkVersion 27
// ......
}
buildTypes {
// ......
}
signingConfigs {
// ......
}
}
至于里面都有哪些 API，可以去 Android DSL 文檔 查看，也可以去 GitHub 上面搜 android-gradle-dsl
3.2 Gradle DSL
Gradle DSL 在上面介紹 Gradle 生命周期和自定義 Task 的時候已經介紹過了，比如上面介紹的 Setting 和 TaskExecutionGraph 都是 Gradle DSL 中的類，其他的類和方法等 API 可以去 Gradle DSL 文檔 查看，或者可以在 Android Studio 中像查看 Android SDK 源碼一樣去查看 Gradle DSL 的源碼
