Android Gradle進階配置指南

TheShy_發表於2019-03-04

簡單的總結一下gradle:

1.Gradle是一種構建工具,它可以幫你管理專案中的差異,依賴,編譯,打包,部署……你可以定義滿足自己需要的構建邏輯,寫入到build.gradle中供日後複用.

2.Gradle不是一種程式語言,它不能幫你實現軟體中的任何實際功能

Gradle 基本

如果你用Android Studio新建一個專案的時候，預設生成一大堆關於gradle的東西，其中最重要的是一個build.gradle的檔案，內容如下：

apply plugin: `com.android.application`

android {
    compileSdkVersion 26
    buildToolsVersion "26.0.0"

    defaultConfig {
        minSdkVersion 19
        targetSdkVersion 26
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            runProguard false
            proguardFiles getDefaultProguardFile(`proguard-android.txt`), `proguard-rules.txt`
        }
    }
}

dependencies {
    compile `com.android.support:support-v4:26.0.+`
}
複製程式碼

解讀:

apply plugin::指定用的是哪個外掛，開發中常見的值有:
    `com.android.application`：Android APP外掛（打包得到的是.apk檔案）
    `com.android.library`:Android庫外掛（打包得到的是.aar檔案）
    `java`:普通的java外掛（打包得到的是.jar檔案）
我目前用到的還有:
    kotlin-android : kotlin
    bugly.gradle : 騰訊bugly
    walle.gradle : 美團walle打包
複製程式碼

android{}用來指定Android打包外掛的相關屬性，包含如下節點:
compileSdkVersion(apiLevel)：設定編譯時用的Android版本
buildToolsVersion(buildToolsVersionName)：設定編譯時使用的構建工具的版本
defaultConfig：設定一些預設屬性，其可用屬性是buildTypes(debug,release,其他+)和productFlavors(谷歌商店,豌豆莢,小米應用商店)之和。
              最終可以打出的APK的數量就是buildTypes乘以productFlavors。構建的變數名稱是productFlavors+buildTypes。
複製程式碼

dependencies 配置依賴:
各種外部依賴直接一行程式碼搞定，不用手動下依賴包了。
其中compile fileTree(dir: `libs`, include: [`*.jar`])的意思是依賴libs目錄下全部的jar檔案。
複製程式碼

buildscript {
    repositories {
        google()
        jcenter()
        mavenCentral()
    }
    dependencies {
        classpath `com.android.tools.build:gradle:3.2.1`
    }
}
複製程式碼

buildscript節點，大概意思就是支援maven,google，宣告Gradle的版本.如果用到一些其他外掛也需要在此申明.

signingConfigs {
    myConfig {
        storeFile file("xxx.keystore")
        storePassword "123123"
        keyAlias "xxx"
        keyPassword "123123"
        v2SigningEnabled true
    }
}
    
buildTypes{
    release {
        //應用myConfig
        signingConfig  signingConfigs.myConfig
        minifyEnabled true
        proguardFiles getDefaultProguardFile(`proguard-android.txt`), `proguard-rules.txt`
    } 
}
複製程式碼

簽名配置:
storeFile : keystore檔案
storePassword : 密碼
keyAlias : 別名
keyPassword : 別名密碼
v2SigningEnabled : 啟用V2簽名方案
minifyEnabled : 是否開啟混淆
shrinkResources : 是否移除無用資原始檔，shrinkResources依賴於minifyEnabled，必須和minifyEnabled一起用
複製程式碼

以上只是最簡單的gradle配置,實際專案中我們的app會很複雜，比如不僅引用到一些jar檔案，也可能會引用一些Android Library專案以及一些.so檔案，而且實際釋出的時候我們可能不僅需要釋出到一個平臺上，目前Android大大小小可能得十幾個平臺，Gradle通過一些其他的配置都可以解決。順便說下Gradle是Google大力支援的。

進階配置

配置manifest變數

很多第三方SDK需要在AndroidManifest.xml中配置你的一些key資訊，以融云為例,測試包和正式包的key是不同的，那麼就可以這麼寫：：

<meta-data
    android:name="RONG_CLOUD_APP_KEY"
    android:value="${rongKey}" />
複製程式碼

然後在productFlavors中的各個版本中加上不同的資訊，這樣你打出的不同包採用的appkey也會不一樣。

manifestPlaceholders = [rongKey: "8luwapkv8jrrl"]
複製程式碼

程式碼中讀取變數

有時候我們想根據不同的版本，設定相同變數不同的值，最常見的使用場景就是 Log 工具類，通過設定 isDubug 不同值判斷是否列印日誌.其他還包括獲取包名,獲取渠道名

buildConfigField "String", "PlatformSource", ""Google""
buildConfigField "String", "showProjName", ""TestProj""
複製程式碼

最後呼叫 : BuildConfig.PlatformSource

public final class BuildConfig {
  public static final boolean DEBUG = Boolean.parseBoolean("true");
  public static final String APPLICATION_ID = "com.xxx.xxxx";
  public static final String BUILD_TYPE = "debug";
  public static final String PlatformSource = "Google";
  public static final String showProjName = "TestProj";
複製程式碼

上面的是加在defaultConfig 中的，而加在buildTypes或productFlavors中就會在不同構建版本出現不同的值。如果再配置上不同的applicationId，那麼就可以在同一個手機上同時安裝不同構建版本的應用。

productFlavors {
    //國內版本
    china{
        applicationId "com.shy.china"
        versionCode "2.0.0"
        versionName "30"
   }
   //韓國版本
    korea{
        applicationId "com.shy.korea"
        versionCode "1.0.0"
        versionName "1"
   }
}
複製程式碼

到這裡你會發現buildTypes和productFlavors定義很相似，不過他們的差別在:

buildType 不會改變應用程式的程式碼，它們只是處理的東西不同，你可以通過 buildType 來獲取更多的技術細節（例如：build optimization,log level minifyEnabled等等），但是app的內容不會改變.
productFlavor 配置可以改變app的內容(可以設想成 package 理解，buildType 沒法改 applicationId).

BuildVariants變體

buildTypes+productFlavors相結合，組成構建變體，buildTypes構建型別，主要就是debug(測試),pre(預釋出) ,release(線上)的分別。productFlavors產品口味，主要就是各種渠道版本。兩個合體就會構建出不同的版本apk （總apk個數=構建型別個數*渠道個數）.看圖:

buildTypes構建型別

    buildTypes {
        release {
            multiDexKeepProguard file(`multidex-config.pro`)
            minifyEnabled true//是否開啟混淆(上線)
            shrinkResources true
            proguardFiles getDefaultProguardFile(`proguard-android.txt`), `proguard-rules.pro`
        }
        debug {
            multiDexKeepProguard file(`multidex-config.pro`)
            minifyEnabled false//是否開啟混淆(上線)
            proguardFiles getDefaultProguardFile(`proguard-android.txt`), `proguard-rules.pro`
        }
    }
複製程式碼

productFlavors多維度

當需要從多個維度區分app版本，比如是否付費和渠道時，就需要使用flavorDimensions來區分

    flavorDimensions "channel", "env"

    productFlavors {
        china {
            dimension "channel"
            applicationId "com.shy.china"
            versionCode project.CHINA_VERSION_CODE as int
            versionName project.CHINA_VERSION_NAME
            signingConfig signingConfigs.china

            buildConfigField "String", "PlatformSource", ""china""
            buildConfigField "String", "showProjName", ""projName_china""

            manifestPlaceholders = [
                    package_name : applicationId,
                    JPUSH_PKGNAME: applicationId,
                    JPUSH_APPKEY : "xxxxxxxxxxxx", //JPush上註冊的包名對應的appkey.
                    JPUSH_CHANNEL: "developer-default", //暫時填寫預設值即可.
            ]
        }
        
        korea {
            dimension "channel"
            applicationId "com.shy.korea"

            versionCode project.KOREA_VERSION_CODE as int
            versionName project.KOREA_VERSION_NAME
            signingConfig signingConfigs.korea

            manifestPlaceholders = [
                    package_name : applicationId,
                    JPUSH_PKGNAME: applicationId,
                    JPUSH_APPKEY : "xxxxxxx", //JPush上註冊的包名對應的appkey.
                    JPUSH_CHANNEL: "developer-default", //暫時填寫預設值即可.
            ]

            buildConfigField "String", "PlatformSource", ""korea""
            buildConfigField "String", "showProjName", ""projName_korea""
        }
 
        dev {
            dimension "env"
        }
        pre {
            dimension "env"
        }
        produce {
            dimension "env"
        }
    }

複製程式碼

此時在build一下 , BuildVariants中會生成12種變體（總apk個數=構建型別個數渠道個數維度個數） :

chinaDevDebug(常用)
chinaDevRelease
chinaPreDebug
chinaPreRelease(常用)
chinaProduceDebug
chinaProduceRelease(常用)
koreaDevDebug(常用)
koreaDevRelease
koreaPreDebug
koreaPreRelease(常用)
koreaProduceDebug
koreaProduceRelease(常用)

注意!warning:

1.當新增了flavorDimensions，必須為每個productFlavors新增dimension，否則會提示錯誤

2.在gradle:3.0.0以上，在build.gradle裡必須要有flavorDimensions欄位，哪怕只有一個維度也要宣告，否則報錯

打包

一次生成所有渠道包
開啟命令列視窗，進入到工程的根目錄下，輸入

gradle assembleChinaProduceRelease

其他技巧

1.Gradle task

Gradle task適合用來完成一些既繁瑣又容易出錯的重複性手工作，比如批量修改，複製，重新命名檔案。
比如applicationVariants.all這個task可以針對每個構建版本設定各種屬性，比如修改每個構建版本生成的apk名字:

applicationVariants.all { variant ->
        variant.outputs.each { output ->
            output.outputFile = new File(
                    new File("${project.rootDir.absolutePath}/apk/",
                   //最後在專案下的apk資料夾下打出來的包名:chinaDev-GooglePlay-1.0.0-20181126-193438.apk
                    ("${flavorName}-${channel}-${buildType}-v${versionName}-${buildTime}.apk)
        }
    }
複製程式碼

2.Moudle動態依賴

在元件化app裡面，我們可能在測試包和正式包需要依賴不同元件。比如測試環境需要除錯模組，但正式環境不需要。假如productFlavors如下，除錯模組名字為module-test

productFlavors {
    test{
    }
    publish{
    }
}
複製程式碼

那麼在dependencies裡面就可以這麼依賴test模組：

ceshiCompile project(`:module-test`)

同樣buildTypes也是適用的，兩者可以一起或單獨使用：

debugCompile project(`:module-test`)
ceshidebugCompile project(`:module-test`)
複製程式碼

3.定義全域性變數

先在 project 根目錄下建立ext_settings.gradle檔案:

ext {
    CHINA_VERSION_NAME = `2.0.0`
    KOREA_VERSION_NAME = `1.0.0`

    CHINA_VERSION_CODE = 20
    KOREA_VERSION_CODE = 1

    androidToolsVersion = `28.0.3`
    supportLibraryVersion = `27.1.1`

    fireBaseVersion = `12.0.1`
    minSdkVersion = 19
    androidSdkVersion = 27
    kotlin_version = `1.3.0`
    gradlePlugin = `3.2.1`
    sourceCompatibilityVersion = JavaVersion.VERSION_1_8
    targetCompatibilityVersion = JavaVersion.VERSION_1_8
}
複製程式碼

然後在各 module 的 build.gradle 中可以通過rootProject.ext來引用：

defaultConfig {
    minSdkVersion rootProject.ext.minSdkVersion
    targetSdkVersion rootProject.ext.androidSdkVersion
}
複製程式碼

依賴也可以挪過來:

ext.deps = [
junit                : `junit:junit:4.12`,
truth                : `com.google.truth:truth:0.28`,
recyclerview         : "com.android.support:recyclerview-v7:$supportLibraryVersion",
]         
複製程式碼

呼叫:

dependencies {
    implementation deps.recyclerview
}
複製程式碼

4.配置獨立的簽名資訊 & 將密碼等檔案統一配置

密碼和簽名這類的敏感資訊可以統一進行存放，不進行硬編碼。在gradle.properies中，我們可以隨意的定義key-value。

STORE_FILE_PATH=../china.keystore
STORE_PASSWORD=123456
KEY_ALIAS=china
KEY_PASSWORD=test123
複製程式碼

    signingConfigs {
        china {
            //使用gradle.properies的配置
            file(STORE_FILE_PATH)
            storePassword STORE_PASSWORD
            keyAlias KEY_ALIAS
            keyPassword KEY_PASSWORD
            v2SigningEnabled true
        }

        korea {
            //日常
            storeFile file(`korea.keystore`)
            storePassword "123456"
            keyAlias "kkk"
            keyPassword "123456"
            v2SigningEnabled true
        }
    }
複製程式碼

5.減少編譯錯誤和忽略 lint 檢查

    packagingOptions {
        //Espresso excludes
        exclude `META-INF/DEPENDENCIES.txt`
        exclude `META-INF/LICENSE.txt`
        exclude `META-INF/NOTICE.txt`
        exclude `META-INF/NOTICE`
        exclude `META-INF/LICENSE`
        exclude `META-INF/DEPENDENCIES`
        exclude `META-INF/notice.txt`
        exclude `META-INF/license.txt`
        exclude `META-INF/dependencies.txt`
        exclude `META-INF/LGPL2.1`
        exclude `LICENSE.txt`
    }
複製程式碼

lintOptions {
        checkReleaseBuilds true
        abortOnError false
    }
複製程式碼

6.引用本地aar

1.把aar檔案放在某目錄內，比如就放在某個module的libs目錄內
2.在這個module的build.gradle檔案中新增：

api fileTree(include: [`*.aar`], dir: `libs`)
複製程式碼

最後附上:
gradle谷歌官方:developer.android.com/studio/buil…
翻譯版:avatarqing.github.io/Gradle-Plug…

和一首好音樂:
夜班車.(summer night in nanning)
intro:封面日本動漫神作混沌武士仁，在救了一個青樓女子之後佇立河邊目送她乘舟遠去。曲取自頭文字D電影插曲，藤原文太這輩子做夢都不會想到他老婆會離開他，所以車手到底需不需要愛情，同樣來自日本神作動漫《頭文字D》

如有錯誤請指出我及時改正!

Android開發：build.gradle 配置指南
2019-10-05
AndroidUIGradle
《Android Gradle權威指南》之Gradle入門
2019-03-04
AndroidGradle
Android Gradle Groovy自動化構建進階篇
2019-06-11
AndroidGradle
Gradle系列之Android Gradle基礎配置
2020-09-17
GradleAndroid
為什麼說 Gradle 是 Android 進階繞不去的坎 —— Gradle 系列(1)
2022-05-16
GradleAndroid
Android Studio Gradle 常用配置詳解
2019-10-07
AndroidGradle
android studio4.0初次gradle配置
2020-11-21
AndroidGradle
Android Gradle 依賴配置：implementation & api
2019-01-11
AndroidGradleAPI
Android面試題之Gradle配置篇
2018-05-04
Android面試題Gradle
Gradle外掛從入門到進階
2019-05-05
Gradle
Gradle進階：1: 結合spring boot進行web開發
2018-12-11
GradleSpring BootWeb
Apache SeaTunnel Committer 進階指南
2024-09-13
ApacheMIT
GitHub加速指南進階版
2021-03-30
Github
Web 開發進階指南
2018-03-23
Web
Android 應用構建速度提升Gradle配置優化
2020-10-08
AndroidGradle優化
Android中的Gradle之配置及構建優化
2018-10-24
AndroidGradle優化
Android進階（七）Android中的ClassLoader
2019-02-11
Android
Gradle配置lintOptions
2019-02-19
Gradle
Gradle-AS配置
2018-03-29
Gradle
詳解前端進階指南教程
2018-06-06
前端
Android studio maven配置 gradle下載慢問題解決
2024-07-01
AndroidMavenGradle
Android進階知識：ThreadLocal
2019-04-05
Androidthread
高階 Android 工程師的進階之路
2018-07-13
Android工程師
Android Gradle外掛
2021-06-22
AndroidGradle
android Gradle錯(一)
2018-11-22
AndroidGradle
idea 中配置Gradle
2024-11-14
IdeaGradle
AndroidStudio Gradle 常用配置
2018-04-10
AndroidGradle
ChatGPT進階指南——營銷小助手
2023-02-28
ChatGPT
JavaScript正規表示式進階指南
2021-09-09
JavaScript
Android自我進階——JAVA之JVM
2020-11-04
AndroidJavaJVM
【Android進階】RecyclerView之ItemDecoration（一）
2019-03-07
AndroidView
Android面試題——進階篇
2018-10-10
Android面試題
Android進階（六）Binder機制
2019-02-07
Android
Android應用開發進階
2018-07-28
Android
要點提煉| Gradle指南
2019-02-28
Gradle
Gradle Kotlin DSL遷移指南
2019-01-18
GradleKotlin
Gradle系列(三) Gradle配置構建和渠道包
2019-12-12
Gradle
安裝 gradle 及如何在idea 配置 gradle
2019-01-02
GradleIdea