從 Gradle 角度看,Android 插件是由 Google 的 Android 團隊開發的一個第三方插件。 從 Android 的角度看,Android 插件是基於 Gradle 構建的,是和 Android studio 完美搭配的新一代構建系統。 ...
Android Gradle 簡介
從 Gradle 角度看,Android 插件是由 Google 的 Android 團隊開發的一個第三方插件。
從 Android 的角度看,Android 插件是基於 Gradle 構建的,是和 Android studio 完美搭配的新一代構建系統。
使用它可以很輕鬆的執行以下操作:
自定義,配置和擴展編譯流程。
使用相同的項目和模塊為你的應用創建多個具有不同功能的 APK。
在不同源集之間重覆使用代碼和資源。
利用 Gradle 的靈活性,可以在不修改應用核心源文件的情況下完成以上所有操作。
Android 插件能做的還有很多,更多的可以參閱 配置構建
插件分類
Android 插件的分類其實是根據 Android 工程的屬性分類的。
在 Android 中有很多種工程類型,常見的有
- App 應用工程,用於生成可運行的 APK 。
- Library 庫工程,用於生成 AAR 包給其他 APK 應用工程公用。
分別對應的插件 ID 是
- App 插件 :com.android.application
- Library 插件:com.android.library
在創建 Module 時就可以看到很多類型
通過應用以上不同的插件就可以配置不同的 Android 工程,然後配合 Android studio 就可以分別對它們進行編譯,測試,發佈等操作。
應用插件
在 Android studio 里創建 Module 的時候選擇不同的工程會自動應用對應的插件。
如果不配合 Android studio 應用,可以在配置腳本 build.gradle 里設置對應的插件ID 。
因為 Android 插件是托管在 jcenter 倉庫上的,所以必須在 repositories{} 添加 jcenter 倉庫。
這樣就能找到 Android 插件了,具體為什麼這麼做,看這裡。
然後是把構件依賴添加到 classpath 。
這一步一般是在根項目的配置文件里配置的,這樣就不用每一個子項目都配置了。
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.6.3'
}
}
最後就是在子項目里應用插件了。
apply plugin: 'com.android.application'
apply plugin: 'com.android.library'
任務
Android 插件是繼承自 Java 插件的,自然把 Java 的任務也繼承來了,例如
- assemble
- build
- clean
- check
除了繼承 Java 插件的,Android 插件本身也添加了自己的任務,例如
- connectCheck 在所有連接設備或者模擬器上運行 check 檢查。
- deviceCheck 通過 API 鏈接遠程設備運行 checks 。它被用於 CI 伺服器上。
- lint 在所有的 ProductFlabor 上運行 lint 檢查。
- install 在已連接的設備上安裝 應用。
- uninstall 在已連接的設備上卸載應用。
除此之外還有些不太常用的任務:
- signingReport 可以列印應用的簽名
- androidDependencies 可以列印 Android 的依賴。
一般我們常用的任務是 build、assemble、clean、check、lint等,通過這些任務可以對應用進行打包生成 APK,對現有的 Android 工程進行 lint 檢查等。
還有一些其他的任務,可以通過命令查看
gradle tasks
在 Android studio 的 Gradle 視窗也可以看到所有的任務
關於 Java 插件的介紹,移步 Java 插件
Android 工程詳細示例
Android 插件繼承自 Java 插件,具備 Java 插件所有的特性,其目錄結構也和 Java 差不多。
使用 Android studio 創建一個工程,可以得到以下目錄:
我們的重點放在項目的配置腳本文件上,大部分的配置是在這裡的。
這是一個標準的多項目的 Gradle 目錄。
- settings.gradle 配置參與構建的項目,會在初始化階段被執行。
- local.properties 是本地配置,配置 sdk和ndk 的位置。
- gradlew.bat Gradle 在 windows 系統下的執行腳本
- gradlew Gradle 在 unix 系統下的執行腳本
- gradle.properties Gradle屬性配置文件
- build.gradle Gradle 配置文件 這裡是根項目的配置文件。
- *.iml Android studio 自動生成的文件,每個項目都會生成一個。
- .gitignore Git 的忽略配置
- gradle/wrapper 目錄是 Gradle Wrapper 使用的目錄
- gradle-wrapper.jar 是執行 Gradle Wrapper 使用的
- gradle-wrapper.properties 是配置 Gradle Wrapper 屬性的
- app 目錄是預設創建的一個 App 應用工程。在 settings.gradle 里會預設導入此子項目。
關於更多 Gradle 介紹,移步 Gradle 系列,在持續更新中。
settings.gradle
//項目名稱,預設是目錄名字
rootProject.name='AndroidGradleExample'
//導入子項目 app
include ':app'
local.properties
# 配置 SDK 在本機的目錄,創建項目時,Android studio 會自動配置,如果需要自己單獨設置,可以更改
sdk.dir=/Users/skymxc/Library/Android/sdk
# ndk 在本機的目錄 需要時配置
##ndk.dir=/Users/skymxc/Library/Android/sdk/ndk-bundle
gradle.properties
# 使用 AndroidX 更多詳細可查看 https://developer.android.com/topic/libraries/support-library/androidx-rn
android.useAndroidX=true
# 自動轉換第三方庫使用 androidx ;Automatically convert third-party libraries to use AndroidX
android.enableJetifier=true
# 為 JVM 守護進程指定參數;Specifies the JVM arguments used for the daemon process.
# 調整記憶體設置的參數;The setting is particularly useful for tweaking memory settings.
org.gradle.jvmargs=-Xmx1536m
.gitignore
*.iml
.gradle
.idea
/local.properties
/.idea/caches
/.idea/libraries
/.idea/modules.xml
/.idea/workspace.xml
/.idea/navEditor.xml
/.idea/assetWizardSettings.xml
.DS_Store
/build
/captures
.externalNativeBuild
.cxx
build.gradle 根項目的配置腳本,可以在這裡配置所有項目都會用到的共性配置,例如配置所有子項目都會使用的倉庫。
// Top-level build file where you can add configuration options common to all sub-projects/modules.
//頂層配置文件,這裡添加的配置可選擇配置到所有子項目
//配置腳本,主要是配置 Gradle 腳本執行使用的依賴。
buildscript {
//使用的插件所在的倉庫,例如 Android 插件就放在了 jcenter 上
repositories {
google()
jcenter()
}
//使用的插件依賴
dependencies {
// Android 構建工具
classpath 'com.android.tools.build:gradle:3.6.3'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
//註意:不要子項目的依賴放在這裡,各自項目的依賴應該放在各自項目的 build.gralde 配置腳本里。
//這裡的配置會應用到所有項目。
}
}
//會遍歷所有子項目,這裡相當於給所有項目都配置了倉庫了。
allprojects {
//給所有項目配置倉庫
repositories {
google()
jcenter()
}
}
// 配置 clean 任務,刪除根目錄的 build 目錄。
task clean(type: Delete) {
delete rootProject.buildDir
}
應用工程目錄
- libs 放置第三方的 jar ,也可以放置 so 庫。
- src 源文件
- src/androidTest Android測試目錄,這裡可以寫測試代碼,執行測試
- src/main main源集,其中 java 目錄是 java 源代碼,res 目錄是資源目錄
- src/test 測試目錄,其中 java 目錄可以寫單元測試等測試代碼,執行測試
- .gitignore git 忽略文件
- build.gradle Gradle 配置腳本
- proguard-rules.pro 配置Proguard 混淆規則;
- AndroidManifest.xml Android 清單文件;常見的配置有四大組件,使用的許可權;
app/.gitignore
/build
app/build.gradle
//使用 Android 應用插件
apply plugin: 'com.android.application'
// android 是 Android插件提供的擴展類型。 Android 工程的配置都可以在這裡配置。
android {
//編譯的SDK 版本
compileSdkVersion 29
//構建工具版本
buildToolsVersion "29.0.2"
//預設配置,它是一個 ProductFlavor
defaultConfig {
//應用程式ID,創建時的包名,可以更改。
applicationId "cn.sintoon.androidgradleexample"
//最小支持的SDK 版本
minSdkVersion 19
//目標 SDK 版本
targetSdkVersion 29
//應用版本代碼,一般用於控制APP的升級。
versionCode 1
//應用版本名稱,用戶可以看到。
versionName "1.0"
//配置單元測試使用的 runner
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
//構建類型
buildTypes {
//發佈類型
release {
//是否啟用混淆
minifyEnabled false
//proguard 規則文件;
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
}
//使用的依賴
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation 'androidx.appcompat:appcompat:1.1.0'
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
testImplementation 'junit:junit:4.12'
androidTestImplementation 'androidx.test.ext:junit:1.1.1'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
}
Android 工程的配置都在 android{} 中。通過它,可以對 Android Gradle 工程進行自定義配置。
defaultConfig{} 里是預設的配置,它是一個 ProductFlavor 。
getDefaultProguardFile 是 Android 擴展的一個方法,它可以獲取你的 Android SDK 目錄下預設的 proguard 配置文件。 在 android-sdk/tools/proguard/ 目錄下,文件名就是傳入的參數 proguard-android-optimize.txt 。
我在 github 建了一個倉庫,是 Android 插件的配置示例,會持續把所有的配置和註釋都記錄在這裡以供查閱,AndroidGradleExample。