Gradle構建Android項目

時間 2019-11-16

原文原文鏈接

簽名

gradle自己支持直接簽名，只須要在releas部分添加以下代碼便可html

signingConfigs {
        debug {

        }
        release {
            storeFile file("../yourapp.keystore")
            storePassword "your password"
            keyAlias "your alias"
            keyPassword "your password"
        }
    }

    buildTypes {
        debug {
            minifyEnabled false
            zipAlignEnabled false
            shrinkResources false
            signingConfig signingConfigs.debug
        }

        release {
            minifyEnabled true//混淆編譯
            zipAlignEnabled true
            //移除無用的資源文件
            shrinkResources true
            signingConfig signingConfigs.release
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }

通常填上上面的代碼便可執行簽名，可是這種方式不太安全，建議不要在build.gradle文件中寫上簽名文件的密碼，由於build.gradle文件通常都會集成到代碼的版本控制中，這樣全部人都會有簽名文件的密碼。android

因此應該把簽名文件的密碼隔離起來，寫到一個配置文件中，此配置文件不包含在代碼版本控制中，這樣其餘開發者就不會知道簽名文件的密碼。git

gradle配置文件通常以.properties結束，咱們先新建一個signing.properties文件，內容以下：github

STORE_FILE=yourapp.keystore
STORE_PASSWORD=your password
KEY_ALIAS=your alias
KEY_PASSWORD=your password

注意沒有字符串雙引號""api

接下在guild.gradle文件中讀取signing.properties配置文件，讀取的代碼以下：android-studio

File propFile = file('signing.properties');
if (propFile.exists()) {
    def Properties props = new Properties()
    props.load(new FileInputStream(propFile))
    if (props.containsKey('STORE_FILE') && props.containsKey('STORE_PASSWORD') &&
            props.containsKey('KEY_ALIAS') && props.containsKey('KEY_PASSWORD')) {
        android.signingConfigs.release.storeFile = file(props['STORE_FILE'])
        android.signingConfigs.release.storePassword = props['STORE_PASSWORD']
        android.signingConfigs.release.keyAlias = props['KEY_ALIAS']
        android.signingConfigs.release.keyPassword = props['KEY_PASSWORD']
    } else {
        android.buildTypes.release.signingConfig = null
    }
} else {
    android.buildTypes.release.signingConfig = null
}

代碼很簡單，就是讀取文件，而後拿到簽名須要的四個變量值分別賦值便可。安全

多渠道打包

美團Android自動化之旅—生成渠道包服務器

因爲國內Android市場衆多渠道，爲了統計每一個渠道的下載及其它數據統計，就須要咱們針對每一個渠道單獨打包。
gradle的多渠道打包很簡單，由於gradle已經幫咱們作好了不少基礎功能。app

下面以友盟統計爲例說明，通常友盟統計在AndroidManifest.xml裏面會有這麼一段聲明：ide

<meta-data
    android:name="UMENG_CHANNEL"
    android:value="CHANNEL_ID" />

其中CHANNEL_ID就是友盟的渠道標示，多渠道的實現通常就是經過修改CHANNEL_ID值來實現的。

接下來將一步一步來實現多渠道版本打包。

1.在AndroidManifest.xml裏配置PlaceHolder,用與在build.gradle文件中來替換成本身想要設置的值

<meta-data
    android:name="UMENG_CHANNEL"
    android:value="${UMENG_CHANNEL_VALUE}" />

2.在build.gradle設置productFlavors，修改PlaceHolder的值

productFlavors {
        playStore {
            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "playStore"]
        }
        miui {
            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "miui"]
        }
        wandoujia {
            manifestPlaceholders = [UMENG_CHANNEL_VALUE: "wandoujia"]
        }
    }

或者批量修改

productFlavors {
        playStore {}
        miui {}
        wandoujia {}
}
 //批量處理
productFlavors.all { 
       flavor -> flavor.manifestPlaceholders = [UMENG_CHANNEL_VALUE: name] 
}

按照上面兩步便可編譯打多渠道包了，命令是 ./gradlew assembleRelease，能夠打包全部的多渠道包。

經過下面這張圖能夠看到gradle能夠執行的task。

若是隻是想打單渠道包，則執行相應的task便可，如gradle assemblePalyStoreRelease就是打PlayStore渠道的Release版本。

3.若是但願能夠對最終的文件名作修改，如須要針對不一樣的需求生成不一樣的文件。而修改文件名也很簡單，參考如下代碼便可實現

def releaseTime() {
    return new Date().format("yyyy-MM-dd", TimeZone.getTimeZone("UTC"))
}

android{
    applicationVariants.all { variant ->
        variant.outputs.each { output ->
            def outputFile = output.outputFile
            if (outputFile != null && outputFile.name.endsWith('.apk')) {
                File outputDirectory = new File(outputFile.parent);
                def fileName
                if (variant.buildType.name == "release") {
                    fileName =  "app_v${defaultConfig.versionName}_${releaseTime()}_${variant.productFlavors[0].name}.apk"
                } else {
                    fileName = "app_v${defaultConfig.versionName}_${packageTime()}_debug.apk"
                }
                output.outputFile = new File(outputDirectory, fileName)
            }
        }
    }

}

此方法有必定侷限性，就是渠道包多了以後編譯花費的時間會很長，這裏推薦美團打包的第三種方法。

buildConfigField自定義配置

你們可能會遇到下面這種狀況，就是Beta版本服務器和Release版本服務器一般不在一臺服務器上，而測試但願能夠同時發佈兩個服務器的版本用於測試，這個時候咱們就須要修改代碼，而後一個一個老老實實的發包。gradle提供buildConfigField配合多渠道打不一樣服務器版本的方法。
其實用法很簡單,首先在相應的節點加上定義，好比：

buildTypes {
        debug {
            buildConfigField "boolean", "LOG_DEBUG", "true"//是否輸出LOG信息
            buildConfigField "String", "API_HOST", "\"http://api.test.com\""//API Host
           }
    }

而後在代碼中經過BuildConfig.LOG_DEBUG或者BuildConfig.API_HOST調用便可。

dex突破65535的限制

隨着項目的一每天變大，慢慢的都會遇到單個dex最多65535個方法數的瓶頸，若是是ANT構建的項目就會比較麻煩，可是Gradle已經幫咱們處理好了，而添加的方法也很簡單，總共就分三步 :
1.首先是在defaultConfig節點使能多DEX功能

android {
        defaultConfig {
            // dex突破65535的限制
            multiDexEnabled true
        }
    }

2.而後就是引入multidex庫文件

dependencies {
         compile 'com.android.support:multidex:1.0.0'
    }

3.最後就是你的AppApplication繼承一下MultiDexApplication便可。

完整的gradle腳本

一份項目中使用的完整的gradle文件配置

// 聲明是Android程序
apply plugin: 'com.android.application'

// 定義一個打包時間
def releaseTime() {
    return new Date().format("yyyy-MM-dd", TimeZone.getTimeZone("UTC"))
}

android {
    // 編譯SDK的版本
    compileSdkVersion 21
    // build tools的版本
    buildToolsVersion '21.1.2'

    defaultConfig {
        // 應用的包名
        applicationId "com.**.*"
        minSdkVersion 14
        targetSdkVersion 21
        versionCode 1
        versionName "1.0"

        // dex突破65535的限制
        multiDexEnabled true
        // 默認是umeng的渠道
        manifestPlaceholders = [UMENG_CHANNEL_VALUE: "umeng"]
    }

    // 移除lint檢查的error
    lintOptions {
        abortOnError false
    }

    //簽名配置
    signingConfigs {
        debug {
            // No debug config
        }

        release {
            storeFile file("../yourapp.keystore")
            storePassword "your password"
            keyAlias "your alias"
            keyPassword "your password"
        }
    }

    buildTypes {
        debug {
            // buildConfigField 自定義配置默認值
            buildConfigField "boolean", "LOG_DEBUG", "true"
            buildConfigField "String", "API_HOST", "\"http://api.test.com\""//API Hos
            versionNameSuffix "-debug"
            minifyEnabled false
            //是否zip對齊
            zipAlignEnabled false
            shrinkResources false
            signingConfig signingConfigs.debug
        }

        release {
            // buildConfigField 自定義配置默認值
            buildConfigField "boolean", "LOG_DEBUG", "false"
            buildConfigField "String", "API_HOST", "\"http://api.release.com\""//API Host
            //// 是否進行混淆
            minifyEnabled true
            zipAlignEnabled true
            // 移除無用的resource文件
            shrinkResources true
            //混淆規則文件
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            signingConfig signingConfigs.release

            applicationVariants.all { variant ->
                variant.outputs.each { output ->
                    def outputFile = output.outputFile
                    if (outputFile != null && outputFile.name.endsWith('.apk')) {
                        // 輸出apk名稱爲boohee_v1.0_2015-06-15_wandoujia.apk
                        def fileName = "boohee_v${defaultConfig.versionName}_${releaseTime()}_${variant.productFlavors[0].name}.apk"
                        output.outputFile = new File(outputFile.parent, fileName)
                    }
                }
            }
        }
    }

    // 友盟多渠道打包
    productFlavors {
        wandoujia {}
        _360 {}
        baidu {}
        xiaomi {}
        tencent {}
        taobao {}
        ...
    }

    productFlavors.all { flavor ->
        flavor.manifestPlaceholders = [UMENG_CHANNEL_VALUE: name]
    }
}

dependencies {
    // 編譯libs目錄下的全部jar包
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile 'com.android.support:support-v4:21.0.3'
    compile 'com.jakewharton:butterknife:6.0.0'
    ...
}