Android Gradle 插件

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。

微信掃一掃，關注個人公衆號