由于本人能力有限遏佣,文中若有錯(cuò)誤之處怔檩,歡迎指正睛藻。
轉(zhuǎn)載請(qǐng)注明出處:http://www.reibang.com/p/7371952ae006
不會(huì)代碼混淆的程序員不是合格的Android
工程師则北。一般在商業(yè)項(xiàng)目中,一個(gè) App
上線之前重要的一環(huán)就是實(shí)現(xiàn)代碼保護(hù)呐能,當(dāng)然念搬,手段有很多抑堡,今天主要介紹的是代碼混淆(ProGuard)
。
ProGuard簡(jiǎn)介
ProGuard是一個(gè)壓縮朗徊、優(yōu)化和混淆Java字節(jié)碼文件的免費(fèi)的工具首妖。它同時(shí)提供了命令行和圖形界面。Android SDK中已經(jīng)對(duì)其提供了支持爷恳。
ProGuard作用
- 壓縮:刪除無(wú)用資源
- 優(yōu)化:精簡(jiǎn)有缆,優(yōu)化字節(jié)碼
- 混淆:以簡(jiǎn)短無(wú)意義的名稱重命名類、字段等温亲,增加反編譯的難度
- 預(yù)校驗(yàn):為字節(jié)碼添加預(yù)校驗(yàn)信息(Android平臺(tái)上不需要這項(xiàng)功能)
ProGuard使用
由于Android SDK
中已經(jīng)集成了該工具棚壁,所以可以直接開啟混淆即可。
buildTypes {
release {
minifyEnabled true
zipAlignEnabled true
shrinkResources true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
minifyEnabled: 混淆開關(guān)栈虚,默認(rèn)為 false
zipAlignEnabled : zipAlign
優(yōu)化袖外,默認(rèn)為 true
。一般我們打包之后先得到xxx-unaligned.apk
魂务,開啟這個(gè)之后才得到最終的xxx-aligned.apk
曼验。
shrinkResources :移除無(wú)用resources
文件(需要保證minifyEnabled
開啟)
proguardFiles: 混淆配置文件≌辰可添加多個(gè)鬓照,因?yàn)?code>Gradle會(huì)在構(gòu)建的時(shí)候?qū)ξ募M(jìn)行合并操作。
proguard-rules.pro:對(duì)應(yīng)module
下的proguard-rules.pro
文件孤紧。
getDefaultProguardFile:這個(gè)函數(shù)指向的路徑是<SDK_HOME>/tools/proguard
文件夾颖杏,如下圖:
ProGuard配置
Android SDK
中已經(jīng)給我們提供了一些默認(rèn)的常規(guī)配置,如下圖:
我們可以通過(guò)在module
下面的proguard-rules.pro
文件中坛芽,對(duì)混淆配置進(jìn)行擴(kuò)展,以適用自己的項(xiàng)目翼抠。
下面總結(jié)出一個(gè)模板咙轩,里面包含常用的混淆配置含義,按需添加即可:
# -allowaccessmodification
# -optimizationpasses 5
# -optimizations !code/simplification/arithmetic,!code/simplification/cast,!field/*,!class/merging/*
# 不進(jìn)行優(yōu)化阴颖。優(yōu)化可能會(huì)造成一些潛在風(fēng)險(xiǎn)活喊,不能保證在所有版本的Dalvik上都正常運(yùn)行
-dontoptimize
# 混合時(shí)不使用大小寫混合,混合后的類名為小寫
-dontusemixedcaseclassnames
# 不跳過(guò)library中的非public的類
-dontskipnonpubliclibraryclasses
# 不跳過(guò)library中的非public的類成員
-dontskipnonpubliclibraryclassmembers
# 在處理時(shí)打印冗長(zhǎng)的信息
-verbose
# 不做預(yù)校驗(yàn)量愧,preverify是proguard的四個(gè)步驟之一钾菊,Android平臺(tái)不需要preverify,去掉這一步能夠加快混淆速度
-dontpreverify
# 保留異常表偎肃,以便編譯器知道哪些異成诽蹋可能被拋出
# 保留InnerClasses,否則外部無(wú)法引用內(nèi)部類
# 保留Signature累颂,否則無(wú)法訪問(wèn)泛型
-keepattributes Exceptions,SourceFile,LineNumberTable,EnclosingMethod,Signature,*Annotation*,InnerClasses,Deprecated
################################## 需要保留的公共部分 ##################################
# 保留四大組件滞详,自定義的Application等等這些類不被混淆
-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的方法凛俱,
# 這樣以來(lái)我們?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序列化的類不被混淆
-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)目中沒(méi)有使用到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);
}
#-----------處理js交互---------------
#-----------處理反射類---------------
#-----------處理實(shí)體類---------------
# 在開發(fā)的時(shí)候我們可以將所有的實(shí)體類放在一個(gè)包內(nèi)蒲犬,這樣我們寫一次混淆就行了。
-keep public class com.upd.proguard.bean.** {
public void set*(***);
public *** get*();
public *** is*();
}
#-----------處理第三方依賴庫(kù)---------
當(dāng)然岸啡,很多博客中也都有類似的模板供大家參考原叮。這里在注釋的地方給出了配置的含義。需要特別注意的是開頭幾個(gè)被注釋掉的混淆配置巡蘸,可根據(jù)需要選擇配置:
# 是否允許放寬類奋隶、類成員的訪問(wèn)限定符
# -allowaccessmodification
# 優(yōu)化的步驟數(shù),默認(rèn)1步赡若,如果發(fā)現(xiàn)沒(méi)有可優(yōu)化的达布,后續(xù)步驟自動(dòng)省略
# -optimizationpasses 5
# 指定混淆是采用的算法
# -optimizations !code/simplification/arithmetic,!code/simplification/cast,!field/*,!class/merging/*
有很多博客中推薦加上這些配置,這里我是不推薦大家使用的逾冬。具體原因如下:
由Android SDK
的 proguard-android.txt
文件可知黍聂,Android
默認(rèn)給我們提供的混淆配置也是關(guān)閉了優(yōu)化的,如果想開啟優(yōu)化身腻,SDK
中還提供了 proguard-android-optimize.txt
文件产还,如下:
通過(guò)這個(gè)文件的注釋可知:優(yōu)化可能會(huì)造成一些潛在風(fēng)險(xiǎn),不能保證在所有版本的Dalvik
上都正常運(yùn)行嘀趟。官方推薦我們?nèi)绻_啟優(yōu)化的話脐区,一定要進(jìn)行嚴(yán)格的測(cè)試。
所以她按,我也建議大家不開啟優(yōu)化即可牛隅。如果非要開啟優(yōu)化,一定要使用proguard-android-optimize.txt
文件中官方提供的算法酌泰,并保證充分的測(cè)試媒佣。
關(guān)于第三方庫(kù)的ProGuard
一般開源的第三方庫(kù)/SDK都提供了混淆配置。我們直接復(fù)制到自己的項(xiàng)目中即可陵刹。
如果沒(méi)有提供的話默伍,可參考以下做法,不對(duì)第三方庫(kù)進(jìn)行混淆(反正也是開源或已經(jīng)混淆過(guò)的):
- 打開 AS 中衰琐,找到所有依賴的
library
-
找到需要目標(biāo)第三方庫(kù)/SDK
按以下規(guī)則添加混淆配置也糊,
keep
住所以包名下的代碼即可
-dontwarn com.readystatesoftware.systembartint.**
-keep class com.readystatesoftware.systembartint.** { *;}
# Eclipse時(shí)代需要添加以下配置,AS時(shí)代Gradle中已經(jīng)默認(rèn)添加羡宙,所以不需重復(fù)配置狸剃,否則會(huì)報(bào)錯(cuò)!9啡取捕捂!
# -libraryjars libs/xxxx.jar
另外瑟枫,也有前人幫我們總結(jié)了一些常用的三方庫(kù)/SDK的混淆配置:
android-proguard-snippets
android-proguard-cn
混淆之后的效果
堆棧信息還原
如果我們開啟混淆功能,那么每次打包之后指攒,都會(huì)生成一個(gè)mapping.txt
文件慷妙。該文件記錄了混淆前后對(duì)應(yīng)的關(guān)系。默認(rèn)位于build--outputs--mapping
下允悦,如下圖:
Android SDK
提供的混淆工具位于:<SDK_HOME>/tools/proguard/bin
膝擂,如下圖:
可以看到:這個(gè)文件夾下都是一些批處理文件,最終運(yùn)行的其實(shí)是一些可執(zhí)行jar文件隙弛。對(duì)應(yīng)于<SDK_HOME>/tools/proguard/lib
目錄下,如下圖:
我們可以運(yùn)行proguardgui
架馋,點(diǎn)擊ReTrace
選項(xiàng),如下圖:
使用友盟統(tǒng)計(jì)全闷,bugly 管理 mapping 文件
統(tǒng)計(jì)平臺(tái)中一般會(huì)包含錯(cuò)誤分析功能叉寂,我們可以上傳mapping
文件到平臺(tái)上,那么我們看到的錯(cuò)誤報(bào)告就直接是還原好的堆棧信息总珠,有利于快速定位錯(cuò)誤代碼屏鳍。以友盟統(tǒng)計(jì)為例:
其它代碼保護(hù)的解決方案
apk 加固
有很多廠商提供免費(fèi)的 apk 加固服務(wù),有興趣的自行了解局服。AndResGuard
微信資源混淆解決方案钓瞭。傳送門:AndResGuard
混淆配置語(yǔ)法學(xué)習(xí)
ProGuard官網(wǎng)
ProGuard學(xué)習(xí)筆記