Android Gradle進階配置指南

時間  2019-11-08
標籤 android gradle 進階 配置 指南 欄目 Android 简体版
原文   原文鏈接

簡單的總結一下gradle:

1.Gradle是一種構建工具,它能夠幫你管理項目中的差別,依賴,編譯,打包,部署......你能夠定義知足本身須要的構建邏輯,寫入到build.gradle中供往後複用.java

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

Gradle 基本

若是你用Android Studio新建一個項目的時候，默認生成一大堆關於gradle的東西，其中最重要的是一個build.gradle的文件，內容以下：git

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.+'
}
複製代碼

解讀:github

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大力支持的。api

進階配置

配置manifest變量bash

不少第三方SDK須要在AndroidManifest.xml中配置你的一些key信息，以融云爲例,測試包和正式包的key是不一樣的，那麼就能夠這麼寫：：app

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

而後在productFlavors中的各個版本中加上不一樣的信息，這樣你打出的不一樣包採用的appkey也會不同。maven

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》

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

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程