Android打包的那些事
使用gradle打包apk已經(jīng)成為當(dāng)前主流趨勢(shì),我也在這個(gè)過(guò)程中經(jīng)歷了各種需求,并不斷結(jié)合gradle新的支持,一一改進(jìn)。在此,把這些相關(guān)的東西記錄,做一總結(jié)。
1. 替換AndroidManifest中的占位符
我想把其中的${app_label}替換為@string/app_name
| 1 2 3 4 5 | android{ defaultConfig{ manifestPlaceholders = [app_label:"@string/app_name"] } } |
如果只想替換debug版本:
| 1 2 3 4 5 6 7 8 9 | android{ buildTypes { debug { manifestPlaceholders = [app_label:"@string/app_name_debug"] } release { } } } |
更多的需求是替換渠道編號(hào):
| 1 2 3 4 5 6 7 8 | android{ productFlavors { // 把dev產(chǎn)品型號(hào)的apk的AndroidManifest中的channel替換dev "dev"{ manifestPlaceholders = [channel:"dev"] } } } |
2. 獨(dú)立配置簽名信息
對(duì)于簽名相關(guān)的信息,直接寫(xiě)在gradle當(dāng)然不好,特別是一些開(kāi)源項(xiàng)目,可以添加到gradle.properties:
| 1 2 3 4 | RELEASE_KEY_PASSWORD=xxxx RELEASE_KEY_ALIAS=xxx RELEASE_STORE_PASSWORD=xxx RELEASE_STORE_FILE=../.keystore/xxx.jks |
然后在build.gradle中引用即可:
| 1 2 3 4 5 6 7 8 9 10 | android { signingConfigs { release { storeFile file(RELEASE_STORE_FILE) storePassword RELEASE_STORE_PASSWORD keyAlias RELEASE_KEY_ALIAS keyPassword RELEASE_KEY_PASSWORD } } } |
如果不想提交到版本庫(kù),可以添加到local.properties中,然后在build.gradle中讀取。
3. 多渠道打包
多渠道打包的關(guān)鍵之處在于,定義不同的product flavor, 并把AndroiManifest中的channel渠道編號(hào)替換為對(duì)應(yīng)的flavor標(biāo)識(shí):
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | android { productFlavors { dev{ manifestPlaceholders = [channel:"dev"] } official{ manifestPlaceholders = [channel:"official"] } // ... ... wandoujia{ manifestPlaceholders = [channel:"wandoujia"] } xiaomi{ manifestPlaceholders = [channel:"xiaomi"] } "360"{ manifestPlaceholders = [channel:"360"] } } |
注意一點(diǎn),這里的flavor名如果是數(shù)字開(kāi)頭,必須用引號(hào)引起來(lái)。
構(gòu)建一下,就能生成一系列的Build Variant了:
| 1 2 3 4 5 6 7 8 9 10 | devDebug devRelease officialDebug officialRelease wandoujiaDebug wandoujiaRelease xiaomiDebug xiaomiRelease 360Debug 360Release |
其中debug, release是gradle默認(rèn)自帶的兩個(gè)build type, 下一節(jié)還會(huì)繼續(xù)說(shuō)明。
選擇一個(gè),就能編譯出對(duì)應(yīng)渠道的apk了。
4. 自定義Build Type
前面說(shuō)到默認(rèn)的build type有兩種debug和release,區(qū)別如下:
| 1 2 3 4 5 6 7 8 9 10 | // release版本生成的BuildConfig特性信息 public final class BuildConfig { public static final boolean DEBUG = false; public static final String BUILD_TYPE = "release"; } // debug版本生成的BuildConfig特性信息 public final class BuildConfig { public static final boolean DEBUG = true; public static final String BUILD_TYPE = "debug"; } |
現(xiàn)在有一種需求,增加一種build type,介于debug和release之間,就是和release版本一樣,但是要保留debug狀態(tài)(如果做過(guò)rom開(kāi)發(fā)的話(huà),類(lèi)似于user debug版本),我們稱(chēng)為preview版本吧。
其實(shí)很簡(jiǎn)單:
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | android { signingConfigs { debug { storeFile file(RELEASE_STORE_FILE) storePassword RELEASE_STORE_PASSWORD keyAlias RELEASE_KEY_ALIAS keyPassword RELEASE_KEY_PASSWORD } preview { storeFile file(RELEASE_STORE_FILE) storePassword RELEASE_STORE_PASSWORD keyAlias RELEASE_KEY_ALIAS keyPassword RELEASE_KEY_PASSWORD } release { storeFile file(RELEASE_STORE_FILE) storePassword RELEASE_STORE_PASSWORD keyAlias RELEASE_KEY_ALIAS keyPassword RELEASE_KEY_PASSWORD } } buildTypes { debug { manifestPlaceholders = [app_label:"@string/app_name_debug"] } release { manifestPlaceholders = [app_label:"@string/app_name"] } preview{ manifestPlaceholders = [app_label:"@string/app_name_preview"] } } } |
另外,build type還有一個(gè)好處,如果想要一次性生成所有的preview版本,執(zhí)行assemblePreview即可,debug和releae版本同理。
5. build type中的定制參數(shù)
上面我們?cè)诓煌腷uild type替換${app_label}為不同的字符串,這樣安裝到手機(jī)上就能明顯的區(qū)分出不同build type的版本。
除此之外,可能還可以配置一些參數(shù),我這里列幾個(gè)我在工作中用到的:
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | android { debug { manifestPlaceholders = [app_label:"@string/app_name_debug"] applicationIdSuffix ".debug" minifyEnabled false signingConfig signingConfigs.debug proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } release { manifestPlaceholders = [app_label:"@string/app_name"] minifyEnabled true shrinkResources true signingConfig signingConfigs.release proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } preview{ manifestPlaceholders = [app_label:"@string/app_name_preview"] applicationIdSuffix ".preview" debuggable true // 保留debug信息 minifyEnabled true shrinkResources true signingConfig signingConfigs.preview proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } } } |
這些都用的太多了,稍微解釋一下:
| 1 2 3 4 5 6 7 | // minifyEnabled 混淆處理 // shrinkResources 去除無(wú)用資源 // signingConfig 簽名 // proguardFiles 混淆配置 // applicationIdSuffix 增加APP ID的后綴 // debuggable 是否保留調(diào)試信息 // ... ... |
6. 多工程全局配置
隨著產(chǎn)品渠道的鋪開(kāi),往往一套代碼需要支持多個(gè)產(chǎn)品形態(tài),這就需要抽象出主要代碼到一個(gè)Library,然后基于Library擴(kuò)展幾個(gè)App Module。
相信每個(gè)module的build.gradle都會(huì)有這個(gè)代碼:
| 1 2 3 4 5 6 7 8 9 10 11 | android { compileSdkVersion 22 buildToolsVersion "23.0.1" defaultConfig { minSdkVersion 10 targetSdkVersion 22 versionCode 34 versionName "v2.6.1" } } |
當(dāng)升級(jí)sdk、build tool、target sdk等,幾個(gè)module都要更改,非常的麻煩。最重要的是,很容易忘記,最終導(dǎo)致app module之間的差異不統(tǒng)一,也不可控。
強(qiáng)大的gradle插件在1.1.0支持全局變量設(shè)定,一舉解決了這個(gè)問(wèn)題。
先在project的根目錄下的build.gradle定義ext全局變量:
| 1 2 3 4 5 6 7 8 | ext { compileSdkVersion = 22 buildToolsVersion = "23.0.1" minSdkVersion = 10 targetSdkVersion = 22 versionCode = 34 versionName = "v2.6.1" } |
然后在各module的build.gradle中引用如下:
| 1 2 3 4 5 6 7 8 9 10 11 12 | android { compileSdkVersion rootProject.ext.compileSdkVersion buildToolsVersion rootProject.ext.buildToolsVersion defaultConfig { applicationId "com.xxx.xxx" minSdkVersion rootProject.ext.minSdkVersion targetSdkVersion rootProject.ext.targetSdkVersion versionCode rootProject.ext.versionCode versionName rootProject.ext.versionName } } |
然后每次修改project級(jí)別的build.gradle即可實(shí)現(xiàn)全局統(tǒng)一配置。
7. 自定義導(dǎo)出的APK名稱(chēng)
默認(rèn)android studio生成的apk名稱(chēng)為app-debug.apk或者app-release.apk,當(dāng)有多個(gè)渠道的時(shí)候,需要同時(shí)編出50個(gè)渠道包的時(shí)候,就麻煩了,不知道誰(shuí)是誰(shuí)了。
這個(gè)時(shí)候,就需要自定義導(dǎo)出的APK名稱(chēng)了,不同的渠道編出的APK的文件名應(yīng)該是不一樣的。
| 1 2 3 4 5 6 7 8 9 10 | android { // rename the apk with the version name applicationVariants.all { variant -> variant.outputs.each { output -> output.outputFile = new File( output.outputFile.parent, "ganchai-${variant.buildType.name}-${variant.versionName}-${variant.productFlavors[0].name}.apk".toLowerCase()) } } } |
當(dāng)apk太多時(shí),如果能把a(bǔ)pk按debug,release,preview分一下類(lèi)就更好了(事實(shí)上,對(duì)于我這樣經(jīng)常發(fā)版的人,一編往往就要編四五十個(gè)版本的人,debug和release版本全混在一起沒(méi)法看,必須分類(lèi)),簡(jiǎn)單:
| 1 2 3 4 5 6 7 8 9 10 11 | android { // rename the apk with the version name // add output file sub folder by build type applicationVariants.all { variant -> variant.outputs.each { output -> output.outputFile = new File( output.outputFile.parent + "/${variant.buildType.name}", "ganchai-${variant.buildType.name}-${variant.versionName}-${variant.productFlavors[0].name}.apk".toLowerCase()) } } } |
現(xiàn)在生成了類(lèi)似于ganchai-dev-preview-v2.4.0.0.apk這樣格式的包了,preview的包自然就放在preview的文件夾下,清晰明了。
8. 混淆技巧
混淆能讓反編譯的代碼可讀性變的很差,而且還能顯著的減少APK包的大小。
1). 第一個(gè)技巧
相信很多朋友對(duì)混淆都覺(jué)得麻煩,甚至說(shuō),非常亂。因?yàn)樘砑踊煜?guī)則需要查詢(xún)官方說(shuō)明文檔,甚至有的官方文檔還沒(méi)說(shuō)明。當(dāng)你引用了太多庫(kù)后,添加混淆規(guī)則將使一場(chǎng)噩夢(mèng)。
這里介紹一個(gè)技巧,不用查官方文檔,不用逐個(gè)庫(kù)考慮添加規(guī)則。
首先,除了默認(rèn)的混淆配置(android-sdk/tools/proguard/proguard-android.txt), 自己的代碼肯定是要自己配置的:
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | ## 位于module下的proguard-rules.pro ##################################### ######### 主程序不能混淆的代碼 ######### ##################################### -dontwarn xxx.model.** -keep class xxx.model.** { *; } ## 等等,自己的代碼自己清楚 ##################################### ########### 不優(yōu)化泛型和反射 ########## ##################################### -keepattributes Signature |
接下來(lái)是麻煩的第三方庫(kù),一般來(lái)說(shuō),如果是極光推的話(huà),它的包名是cn.jpush, 添加如下代碼即可:
| 1 2 | -dontwarn cn.jpush.** -keep class cn.jpush.** { *; } |
其他的第三庫(kù)也是如此,一個(gè)一個(gè)添加,太累!其實(shí)可以用第三方反編譯工具(比如jadx:https://github.com/skylot/jadx?),打開(kāi)apk后,一眼就能看到引用的所有第三方庫(kù)的包名,把所有不想混淆或者不確定能不能混淆的,直接都添加又有何不可:
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | ##################################### ######### 第三方庫(kù)或者jar包 ########### ##################################### -dontwarn cn.jpush.** -keep class cn.jpush.** { *; } -dontwarn com.squareup.** -keep class com.squareup.** { *; } -dontwarn com.octo.** -keep class com.octo.** { *; } -dontwarn de.** -keep class de.** { *; } -dontwarn javax.** -keep class javax.** { *; } -dontwarn org.** -keep class org.** { *; } -dontwarn u.aly.** -keep class u.aly.** { *; } -dontwarn uk.** -keep class uk.** { *; } -dontwarn com.baidu.** -keep class com.baidu.** { *; } -dontwarn com.facebook.** -keep class com.facebook.** { *; } -dontwarn com.google.** -keep class com.google.** { *; } ## ... ... |
2). 第二個(gè)技巧
一般release版本混淆之后,像友盟這樣的統(tǒng)計(jì)系統(tǒng)如果有崩潰異常,會(huì)記錄如下:
| 1 2 | java.lang.NullPointerException: java.lang.NullPointerException at com.xxx.TabMessageFragment$7.run(Unknown Source) |
這個(gè)Unknown Source是很要命的,排除錯(cuò)誤無(wú)法定位到具體行了,大大降低調(diào)試效率。
當(dāng)然,友盟支持上傳Mapping文件,可幫助定位,mapping文件的位置在:
| 1 2 | project > module > build > outputs > {flavor name} > {build type} > mapping.txt |
如果版本一多,mapping.txt每次都要重新生成,還要上傳,終歸還是麻煩。
其實(shí),在proguard-rules.pro中添加如下代碼即可:
| 1 | -keepattributes SourceFile,LineNumberTable |
當(dāng)然apk包會(huì)大那么一點(diǎn)點(diǎn)(我這里6M的包,大個(gè)200k吧),但是再也不用mapping.txt也能定位到行了,為了這種解脫,這個(gè)代價(jià)我個(gè)人覺(jué)得是值的,而且超值!
9. 動(dòng)態(tài)設(shè)置一些額外信息
假如想把當(dāng)前的編譯時(shí)間、編譯的機(jī)器、最新的commit版本添加到apk,而這些信息又不好寫(xiě)在代碼里,強(qiáng)大的gradle給了我創(chuàng)造可能的自信:
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | android { defaultConfig { resValue "string", "build_time", buildTime() resValue "string", "build_host", hostName() resValue "string", "build_revision", revision() } } def buildTime() { return new Date().format("yyyy-MM-dd HH:mm:ss") } def hostName() { return System.getProperty("user.name") + "@" + InetAddress.localHost.hostName } def revision() { def code = new ByteArrayOutputStream() exec { commandLine 'git', 'rev-parse', '--short', 'HEAD' standardOutput = code } return code.toString() } |
上述代碼實(shí)現(xiàn)了動(dòng)態(tài)的添加了3個(gè)字符串資源: build_time、build_host、build_revision, 然后在其他地方可像如引用字符串一樣使用如下:
| 1 2 3 4 | // 在Activity里調(diào)用 getString(R.string.build_time) // 輸出2015-11-07 17:01 getString(R.string.build_host) // 輸出jay@deepin,這是我的電腦的用戶(hù)名和PC名 getString(R.string.build_revision) // 輸出3dd5823, 這是最后一次commit的sha值 |
這個(gè)地方,如何從命令行讀取返回結(jié)果,很有意思。
其實(shí)這段代碼來(lái)自我學(xué)習(xí)VLC源碼時(shí)偶然看到,深受啟發(fā),不敢獨(dú)享,特摘抄在此。
vlc源碼及編譯地址:https://wiki.videolan.org/AndroidCompile,?有興趣可以過(guò)去一觀(guān)。
10. 給自己留個(gè)”后門(mén)”: 點(diǎn)七下
為了調(diào)試方便,我們往往會(huì)在debug版本留一個(gè)顯示我們想看的界面(記得之前微博的一個(gè)iOS版本就泄露了一個(gè)調(diào)試界面),如何進(jìn)入到一個(gè)界面,我們可以仿照android開(kāi)發(fā)者選項(xiàng)的方式,點(diǎn)七下才顯示,我們來(lái)實(shí)現(xiàn)一個(gè):
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | private int clickCount = 0; private long clickTime = 0; sevenClickView.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { if (clickTime == 0) { clickTime = System.currentTimeMillis(); } if (System.currentTimeMillis() - clickTime > 500) { clickCount = 0; } else { clickCount++; } clickTime = System.currentTimeMillis(); if (clickCount > 6) { // 點(diǎn)七下條件達(dá)到,跳到debug界面 } } }); |
release版本肯定是不能暴露這個(gè)界面的,也不能讓人用am在命令行調(diào)起,如何防止呢,可以在release版本把這個(gè)debug界面的exported設(shè)為false。
11. 自動(dòng)化構(gòu)建
如何使用jenkins打包android和ios,并上傳到蒲公英平臺(tái),這個(gè)可以參考我的另外一篇文章專(zhuān)門(mén)介紹:《使用jenkins自動(dòng)化構(gòu)建android和ios應(yīng)用》,不過(guò),這篇文章還沒(méi)寫(xiě)完,實(shí)際上在公司里已經(jīng)一直在用了,哪天心情好了總會(huì)寫(xiě)完的,這里不再贅述。
12. 小結(jié)
android打包因?yàn)間roovy語(yǔ)言的強(qiáng)大,變的強(qiáng)大的同時(shí)必然也變的復(fù)雜,今天把我經(jīng)歷的這些門(mén)道拿出來(lái)說(shuō)道一下,做一個(gè)小小的總結(jié),后續(xù)有更新我還會(huì)添加。
原文地址: http://jayfeng.com/2015/11/07/Android%E6%89%93%E5%8C%85%E7%9A%84%E9%82%A3%E4%BA%9B%E4%BA%8B/
總結(jié)
以上是生活随笔為你收集整理的Android打包的那些事的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 搭建一个日常好用的linux系统
- 下一篇: eclipse项目迁移到Android