目錄
一.混淆(Proguard)
混淆是打包過程中最重要的流程之一,這里所說的的混淆是包括代碼混淆和資源的“混淆”。
1.代碼混淆
通過代碼混淆不僅能夠提高APK的反編譯,還能較小APK大小;混淆可以刪除注釋和無用的代碼;可以將Java文件,變量,方法名登改為短名,這樣就可以縮減字符所占的空間,但并不是所有的文件都可以混淆;比如res下的文件,文件res下的資源文件在R.java 文件中都會(huì)有對(duì)應(yīng)的ID,如果直接將文件名改了,資源和ID就不對(duì)應(yīng)了。導(dǎo)致程序崩潰。
混淆配置
在app下的build.gradle中開啟混淆
android {
.......
signingConfigs {
release {//release版的簽名配置信息
storeFile file(rootProject.ext.signConfigs.storeFile)
storePassword rootProject.ext.signConfigs.storePassword
keyAlias rootProject.ext.signConfigs.keyAlias
keyPassword rootProject.ext.signConfigs.keyPassword
}
}
buildTypes {
release {
minifyEnabled true //開啟混淆編譯
shrinkResources true //移除無用資源
zipAlignEnabled true //zipalign優(yōu)化
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.release
buildConfigField("boolean", "LOG_DEBUG", "false")//正式版不打印日志
}
debug {//為了方便調(diào)試微信支付、登陸、分享等把deug簽名配置成了Release版的簽名
signingConfig signingConfigs.release
buildConfigField("boolean", "LOG_DEBUG", "true")
}
}
......
}
getDefaultProguardFile('proguard-android.txt')
:表示默認(rèn)的混淆規(guī)則,文件位于android sdk 目錄 \sdk\tools\proguard\proguard-android.txt 中
這里把
proguard-android.txt
替換成了proguard-android-optimize.txt
,兩者的區(qū)別是前置沒有開啟優(yōu)化。使用proguard-android-optimize.txt
開啟優(yōu)化,這樣我們配置的優(yōu)化選項(xiàng)才會(huì)生效。zipAlignEnabled
,shrinkResources
等
proguard-android.txt的部分內(nèi)容如下:
.......
# 表示不進(jìn)行優(yōu)化
-dontoptimize
表示不進(jìn)行預(yù)校驗(yàn)
-dontpreverify
......
proguard-rules.pro是我們自定義的混淆規(guī)則,位于app根目錄下,默認(rèn)為空,需要我們自己添加規(guī)則。這里貼出一根模板:
#############################################
# 對(duì)于一些基本指令的添加
#############################################
# 代碼混淆壓縮比,在0~7之間,默認(rèn)為5,一般不做修改
-optimizationpasses 5
# 混合時(shí)不使用大小寫混合,混合后的類名為小寫
-dontusemixedcaseclassnames
# 指定不去忽略非公共庫的類
-dontskipnonpubliclibraryclasses
# 這句話能夠使我們的項(xiàng)目混淆后產(chǎn)生映射文件
# 包含有類名->混淆后類名的映射關(guān)系
-verbose
# 指定不去忽略非公共庫的類成員
-dontskipnonpubliclibraryclassmembers
# 不做預(yù)校驗(yàn),preverify是proguard的四個(gè)步驟之一,Android不需要preverify,去掉這一步能夠加快混淆速度。
-dontpreverify
# 忽略警告
-ignorewarnings
# 保留Annotation不混淆
-keepattributes *Annotation*,InnerClasses
# 避免混淆泛型
-keepattributes Signature
# 拋出異常時(shí)保留代碼行號(hào)
-keepattributes SourceFile,LineNumberTable
# 指定混淆是采用的算法,后面的參數(shù)是一個(gè)過濾器
# 這個(gè)過濾器是谷歌推薦的算法,一般不做更改
-optimizations !code/simplification/cast,!field/*,!class/merging/*
#############################################
# Android開發(fā)中一些需要保留的公共部分
#############################################
# 保留我們使用的四大組件,自定義的Application等等這些類不被混淆
# 因?yàn)檫@些子類都有可能被外部調(diào)用
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Appliction
-keep public class * extends android.app.Service
-keep public class * extends android.content.BroadcastReceiver
-keep public class * extends android.content.ContentProvider
-keep public class * extends android.app.backup.BackupAgentHelper
-keep public class * extends android.preference.Preference
-keep public class * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
# 保留support下的所有類及其內(nèi)部類
-keep class android.support.** {*;}
# 保留繼承的
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**
# 保留R下面的資源
-keep class **.R$* {*;}
# 保留本地native方法不被混淆
-keepclasseswithmembernames class * {
native <methods>;
}
# 保留在Activity中的方法參數(shù)是view的方法,
# 這樣以來我們?cè)趌ayout中寫的onClick就不會(huì)被影響
-keepclassmembers class * extends android.app.Activity{
public void *(android.view.View);
}
# 保留枚舉類不被混淆
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
# 保留我們自定義控件(繼承自View)不被混淆
-keep public class * extends android.view.View{
*** get*();
void set*(***);
public <init>(android.content.Context);
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
}
# 保留Parcelable序列化類不被混淆
-keep class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator *;
}
# 保留Serializable序列化的類不被混淆
-keepnames class * implements java.io.Serializable
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
!static !transient <fields>;
!private <fields>;
!private <methods>;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
# 對(duì)于帶有回調(diào)函數(shù)的onXXEvent、**On*Listener的,不能被混淆
-keepclassmembers class * {
void *(**On*Event);
void *(**On*Listener);
}
# webView處理,項(xiàng)目中沒有使用到webView忽略即可
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
public *;
}
-keepclassmembers class * extends android.webkit.webViewClient {
public void *(android.webkit.WebView, java.lang.String, android.graphics.Bitmap);
public boolean *(android.webkit.WebView, java.lang.String);
}
-keepclassmembers class * extends android.webkit.webViewClient {
public void *(android.webkit.webView, jav.lang.String);
}
# 移除Log類打印各個(gè)等級(jí)日志的代碼,打正式包的時(shí)候可以做為禁log使用,這里可以作為禁止log打印的功能使用
# 記得proguard-android.txt中一定不要加-dontoptimize才起作用
# 另外的一種實(shí)現(xiàn)方案是通過BuildConfig.DEBUG的變量來控制
#-assumenosideeffects class android.util.Log {
# public static int v(...);
# public static int i(...);
# public static int w(...);
# public static int d(...);
# public static int e(...);
#}
#############################################
# 項(xiàng)目中特殊處理部分
#############################################
#-----------處理反射類---------------
#-----------處理js交互---------------
-keepattributes *JavascriptInterface*
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
public *;
}
-keepclassmembers class * extends android.webkit.WebViewClient {
public void *(android.webkit.WebView, java.lang.String, android.graphics.Bitmap);
public boolean *(android.webkit.WebView, java.lang.String);
}
-keepclassmembers class * extends android.webkit.WebViewClient {
public void *(android.webkit.WebView, java.lang.String);
}
#-----------處理實(shí)體類---------------
-keep class com.xiyang51.platform.entity.**{ *; }
#-----------處理第三方依賴庫---------
# gson
-keep class com.google.**{*;}
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.stream.** { *; }
# FastJson
-dontwarn com.alibaba.fastjson.**
-keep class com.alibaba.fastjson.** { *; }
# 百度地圖(jar包換成自己的版本,記得簽名要匹配)
-keep class com.baidu.** {*;}
-keep class vi.com.** {*;}
-keep class com.sinovoice.** {*;}
-keep class pvi.com.** {*;}
-dontwarn com.baidu.**
-dontwarn vi.com.**
-dontwarn pvi.com.**
# Bugly
-dontwarn com.tencent.bugly.**
-keep class com.tencent.bugly.** {*;}
# ButterKnife
-keep public class * implements butterknife.Unbinder {
public <init>(**, android.view.View);
}
-keep class butterknife.*
-keepclasseswithmembernames class * {
@butterknife.* <methods>;
}
-keepclasseswithmembernames class * {
@butterknife.* <fields>;
}
# EventBus
-keepclassmembers class ** {
@org.greenrobot.eventbus.Subscribe <methods>;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; }
# Glide
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
**[] $VALUES;
public *;
}
### greenDAO 3
-keepclassmembers class * extends org.greenrobot.greendao.AbstractDao {
public static java.lang.String TABLENAME;
}
-keep class **$Properties
-dontwarn org.greenrobot.greendao.database.**
-dontwarn rx.**
# 極光推送
-dontoptimize
-dontpreverify
-dontwarn cn.jpush.**
-keep class cn.jpush.** { *; }
# OkHttp
-dontwarn okio.**
-dontwarn okhttp3.**
-dontwarn javax.annotation.Nullable
-dontwarn javax.annotation.ParametersAreNonnullByDefault
# OrmLite
-keepattributes *DatabaseField*
-keepattributes *DatabaseTable*
-keepattributes *SerializedName*
-keep class com.j256.**
-keepclassmembers class com.j256.** { *; }
-keep enum com.j256.**
-keepclassmembers enum com.j256.** { *; }
-keep interface com.j256.**
-keepclassmembers interface com.j256.** { *; }
# Retrofit
-keep class retrofit2.** { *; }
-dontwarn retrofit2.**
-keepattributes Exceptions
-dontwarn okio.**
-dontwarn javax.annotation.**
# RxJava RxAndroid
-dontwarn sun.misc.**
-keepclassmembers class rx.internal.util.unsafe.*ArrayQueue*Field* {
long producerIndex;
long consumerIndex;
}
-keepclassmembers class rx.internal.util.unsafe.BaseLinkedQueueProducerNodeRef {
rx.internal.util.atomic.LinkedQueueNode producerNode;
}
-keepclassmembers class rx.internal.util.unsafe.BaseLinkedQueueConsumerNodeRef {
rx.internal.util.atomic.LinkedQueueNode consumerNode;
}
-dontnote rx.internal.util.PlatformDependent
# 微信支付
-dontwarn com.tencent.mm.**
-dontwarn com.tencent.wxop.stat.**
-keep class com.tencent.mm.** {*;}
-keep class com.tencent.wxop.stat.**{*;}
# 新浪微博
-keep class com.sina.weibo.sdk.* { *; }
-keep class android.support.v4.* { *; }
-keep class com.tencent.* { *; }
-keep class com.baidu.* { *; }
-keep class lombok.ast.ecj.* { *; }
-dontwarn android.support.v4.**
-dontwarn com.tencent.**s
-dontwarn com.baidu.**
# 友盟統(tǒng)計(jì)分析
-keepclassmembers class * { public <init>(org.json.JSONObject); }
-keepclassmembers enum com.umeng.analytics.** {
public static **[] values();
public static ** valueOf(java.lang.String);
}
# 支付寶錢包
-dontwarn com.alipay.**
-dontwarn HttpUtils.HttpFetcher
-dontwarn com.ta.utdid2.**
-dontwarn com.ut.device.**
-keep class com.alipay.android.app.IAlixPay{*;}
-keep class com.alipay.android.app.IAlixPay$Stub{*;}
-keep class com.alipay.android.app.IRemoteServiceCallback{*;}
-keep class com.alipay.android.app.IRemoteServiceCallback$Stub{*;}
-keep class com.alipay.sdk.app.PayTask{ public *;}
-keep class com.alipay.sdk.app.AuthTask{ public *;}
-keep class com.alipay.mobilesecuritysdk.*
-keep class com.ut.*
里面每一行都有對(duì)應(yīng)的注釋,如果你還使用到了別的三方庫,需要使用的時(shí)候自行添加,切勿照搬。
雙擊assembleRelease
打正式包
打正式包的時(shí)候開啟了混淆,打包結(jié)束后會(huì)在
\app\build\outputs\mapping\release\
目錄下生成一個(gè)mapping.txt
文件,是代碼混淆前后的名字對(duì)應(yīng)關(guān)系。
資源“混淆”
上面提到,res下的資源文件不能混淆,如果我們可以將res下的資源文件名也改成短名,并且ID對(duì)應(yīng)關(guān)系也改成對(duì)應(yīng)的;這樣就可以實(shí)現(xiàn)資源文件的“混淆了”,apk解壓后會(huì)有一個(gè)resources.arsc
文件:資源索引表,資源的描述文件,用來描述具有ID值的資源的對(duì)應(yīng)關(guān)系。所以我們把res下的文件改成短名后,還需要更改resources.arsc
中的對(duì)應(yīng)關(guān)系。這里使用的是微信開源的資源混淆工具 AndResGuard
配置
1.在工程的build.gradle中配置插件
buildscript {
repositories {
jcenter()
google()
}
dependencies {
......
classpath 'com.tencent.mm:AndResGuard-gradle-plugin:1.2.15'
}
}
2.可以在app下的build.gradle中直接配置混淆,為了更直觀一些,這里在工程的根目錄中單獨(dú)建立了一個(gè)gradle文件:and_res_guard.gradle
內(nèi)容如下:
apply plugin: 'AndResGuard'//引入插件
//資源"混淆"配置文件
andResGuard {
mappingFile = null
use7zip = true
useSign = true
keepRoot = false // 打開這個(gè)開關(guān),會(huì)keep住所有資源的原始路徑,只混淆資源的名字
compressFilePattern = [//對(duì)哪些類型的圖片進(jìn)行“混淆”
"*.png",
"*.jpg",
"*.jpeg",
"*.gif",
"resources.arsc"
]
whiteList = [ //白名單,忽略哪些資源文件
"R.drawable.icon",
"R.string.com.crashlytics.*",
// google-services.json
"R.string.google_app_id",
"R.string.gcm_defaultSenderId",
"R.string.default_web_client_id",
"R.string.ga_trackingId",
"R.string.firebase_database_url",
"R.string.google_api_key",
"R.string.google_crash_reporting_api_key",
//友盟
"R.string.tb_*",
"R.layout.tb_*",
"R.drawable.tb_*",
"R.drawable.u1*",
"R.drawable.u2*",
"R.color.tb_*",
"R.drawable.sina*",
"R.string.umeng*",
"R.string.UM*",
"R.layout.umeng*",
"R.drawable.umeng*",
"R.id.umeng*",
"R.anim.umeng*",
"R.color.umeng*",
"R.style.*UM*",
"R.style.umeng*",
//極光推送
"R.drawable.jpush_notification_icon"
]
sevenzip {
artifact = 'com.tencent.mm:SevenZip:1.2.15' //使用7Zip
}
digestalg = "SHA-256" //簽名算法
}
3.在app下的build.gradle文件中引入and_res_guard.gradle
文件
apply plugin: 'com.android.application'
apply plugin: 'org.greenrobot.greendao'
apply from: rootProject.file('libbase.gradle')
apply from: rootProject.file('and_res_guard.gradle')
......
4.配置完成后在Tasks下多出了一個(gè)andresguard,我們?cè)俅蛘桨臅r(shí)候點(diǎn)擊它下的resguardRelease即可,默認(rèn)的apk輸出文件在app/build/outputs/
下
二.自定義APK輸出的名字
我們默認(rèn)打包輸出的名字為:app-release.apk,我們希望加上時(shí)間,版本號(hào)等信息。
在app下的build.gradle添加如下代碼:
gradle3.0以下
android{
......
applicationVariants.all {
variant ->
variant.outputs.each { output ->
if (buildType.name == 'release') {//打正式包的時(shí)候
output.outputFile = new File(
output.outputFile.parent, //輸出目錄
"app_v" + defaultConfig.versionName + "_" +
new Date().format("yyyy-MM-dd") + "_" + //打包時(shí)間
buildType.name + ".apk")
}
}
}
}
......
gradle3.0及以上
//自定義輸出apk名字
applicationVariants.all {
variant ->
variant.outputs.all { output ->
if (buildType.name == 'release') {
outputFileName = new File("app_v" + defaultConfig.versionName + "_" +
new Date().format("yyyy-MM-dd") + "_" +
buildType.name + ".apk")
}
}
}
最終輸出的格式為:app_v1.0_2018-11-01_release.apk,你可以按照自己的格式定義輸出。
三.自動(dòng)維護(hù)版本發(fā)布文檔
我們APP每次迭代需要記錄APP的版本信息和對(duì)應(yīng)的變化信息,以某一特定的格式記錄,方便以后對(duì)比管理。我們可以寫一個(gè)gradle腳本來自動(dòng)實(shí)現(xiàn)。
在工程的根目錄下新建一個(gè)releaseinfo.gradle文件,內(nèi)容如下:
import groovy.xml.MarkupBuilder
/**
* 描述:版本發(fā)布文檔自動(dòng)維護(hù)腳本
* 流程描述:
* 1、將版本相關(guān)信息解析出來
* 2、將解析出的數(shù)據(jù)生成xml格式數(shù)據(jù)
* 3、寫入到已有的文檔數(shù)據(jù)中
**/
ext {
versionName = rootProject.ext.android.versionName
versionCode = rootProject.ext.android.versionCode
versionInfo = 'App的第1個(gè)版本,上線了一些最基礎(chǔ)核心的功能,。。。。。。'
destFile = file('releasesInfo.xml')//指定輸出文件
if (destFile != null && !destFile.exists()) {
destFile.createNewFile()
}
}
//掛在到應(yīng)用構(gòu)建的過程中
this.project.afterEvaluate { project ->
def buildTask = project.tasks.getByName('assembleRelease')
if (buildTask != null) {
buildTask.doLast {//assembleRelease 之后執(zhí)行
releaseInfoTask.execute()
}
}
}
//創(chuàng)建一個(gè)Task,并指定輸入輸出
task releaseInfoTask {
inputs.property('versionCode', this.versionCode)
inputs.property('versionName', this.versionName)
inputs.property('versionInfo', this.versionInfo)
outputs.file this.destFile
doLast {
//將輸入的內(nèi)容寫入到輸出文件中去
def data = inputs.getProperties()
File file = outputs.getFiles().getSingleFile()
def versionMsg = new VersionMsg(data)
//將實(shí)體對(duì)象寫入到xml文件中
def sw = new StringWriter()
def xmlBuilder = new MarkupBuilder(sw)
if (file.text != null && file.text.size() <= 0) {
//沒有內(nèi)容
xmlBuilder.releases {
release {
versionCode(versionMsg.versionCode)
versionName(versionMsg.versionName)
versionInfo(versionMsg.versionInfo)
}
}
//直接寫入
file.withWriter { writer ->
writer.append("<?xml version=\"1.0\" encoding=\"GBK\"?>" + '\r\n')
writer.append(sw.toString())
}
} else {//有內(nèi)容判斷版本是否改變
def releases = new XmlParser().parse(file)
def codeName = releases.release[-1].versionName.text()
if (codeName != versionMsg.versionName) {//新的版本信息
xmlBuilder.release {
versionCode(versionMsg.versionCode)
versionName(versionMsg.versionName)
versionInfo(versionMsg.versionInfo)
}
//插入到最后一行前面
def lines = file.readLines()
def lengths = lines.size() - 1
file.withWriter { writer ->
lines.eachWithIndex { line, index ->
if (index != lengths) {
writer.append(line + '\r\n')
} else if (index == lengths) {
writer.append('\r\n' + sw.toString() + '\r\n')
writer.append(lines.get(lengths))
}
}
}
}
}
}
}
//信息實(shí)體類
class VersionMsg {
String versionCode
String versionName
String versionInfo
}
將自動(dòng)維護(hù)版本信息文檔的Task,releaseInfoTask加入到了構(gòu)建過程中:
//掛在到應(yīng)用構(gòu)建的過程中
this.project.afterEvaluate { project ->
def buildTask = project.tasks.getByName('assembleRelease')//只有正式包才會(huì)寫入文檔
if (buildTask != null) {
buildTask.doLast {//assembleRelease 之后執(zhí)行
releaseInfoTask.execute()
}
}
}
打正式包結(jié)束后會(huì)在app的根目錄下生成一個(gè)releaseInfo.xml文件,內(nèi)容格式如下:
<?xml version="1.0" encoding="GBK"?>
<releases>
<release>
<versionCode>1</versionCode>
<versionName>1.0</versionName>
<versionInfo>App的第1個(gè)版本,上線了一些最基礎(chǔ)核心的功能,。。。。。。</versionInfo>
</release>
</releases>
當(dāng)版本改變的時(shí)候,我們只需要修改versionInfo 對(duì)應(yīng)的內(nèi)容即可。
四.多渠道打包
渠道包就是要在安裝包中添加渠道信息,也就是channel,對(duì)應(yīng)不同的渠道,例如:小米市場、360市場、應(yīng)用寶市場等,我們要在安裝包中添加不同的標(biāo)識(shí),應(yīng)用在請(qǐng)求網(wǎng)絡(luò)的時(shí)候攜帶渠道信息,方便后臺(tái)做運(yùn)營統(tǒng)計(jì)。
以友盟統(tǒng)計(jì)為例:
1.在AndroidManifest添加如下信息
<meta-data
android:name="UMENG_CHANNEL"
android:value="${UMENG_CHANNEL_VALUE}" />
2.在app下的build.gradle中配置渠道
/*配置渠道*/
productFlavors {
wandoujia{
manifestPlaceholders = [UMENG_CHANNEL_VALUE: "wandoujia"]
}
yingyongbao{
manifestPlaceholders = [UMENG_CHANNEL_VALUE: "yingyongbao"]
}
huawei{
manifestPlaceholders = [UMENG_CHANNEL_VALUE: "huawei"]
}
........
}
3.然后在代碼中調(diào)用友盟統(tǒng)計(jì)的相關(guān)代碼。此處省略。
這樣打渠道包的缺點(diǎn):
- 每一個(gè)渠道包需要release一次
- 我們上傳應(yīng)用市場的時(shí)候都需要加固,加固后渠道信息會(huì)丟失,所以必須加固后再打渠道包。
使用360加固時(shí),支持多渠道打包,這樣使用比較方便。
注意:友盟統(tǒng)計(jì)的渠道號(hào)不能全是數(shù)字。
還有一種是使用三方開源的打包工具,比如美團(tuán)開源的打包工具:walle