一、爲什麼要混淆-混淆的作用
壓縮(Shrinking):默認開啓,用以減小應用體積,移除未被使用的類和成員,並且會在優化動作執行之後再次執行(因爲優化後可能會再次暴露一些未被使用的類和成員)。
-dontshrink 關閉壓縮
優化(Optimization):默認開啓,在字節碼級別執行優化,讓應用運行的更快。
-dontoptimize 關閉優化
-optimizationpasses n 表示proguard對代碼進行迭代優化的次數,Android一般爲5
混淆(Obfuscation):默認開啓,增大反編譯難度,類和類成員會被隨機命名,除非用keep保護。
-dontobfuscate 關閉混淆
所以,混淆可以讓我們的代碼哪怕被反編譯了,也沒那麼容易閱讀。
二、開啓混淆
Android Studio只需要在工程應用目錄的gradle文件中設置minifyEnabled爲true即可。
android {
...
buildTypes {
release {
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
以上示例代碼表示對release版本就行混淆處理。注意:zipAlignEnabled不能用在主項目中,但可以用在依賴庫上。zipAlign可以讓資源按4字節對齊,這樣可以減少應用在運行時的內存消耗。
三、混淆基本規則
這裏我們按包——>類(內部、外部)——>成員變量(public、private)——>成員方法(public、private、參數)由大到小的結構順序來闡述相關規則。
3.1、包
-keep class cn.hadcn.test.**
-keep class cn.hadcn.test.*
一顆星表示只是保持該包下的類名,而子包下的類名還是會被混淆;兩顆星表示把本包和所含子包下的類名都保持;用以上方法保持類後,你會發現類名雖然未混淆,但裏面的具體方法和變量命名還是變了,這時如果既想保持類名,又想保持裏面的內容不被混淆,我們就需要以下方法了:
-keep class cn.hadcn.test.* {*;}
3.2、類
在以上的基礎上,我們也可以使用Java的基本規則來保護特定類不被混淆,比如我們可以用extend,implement等這些Java規則。如下例子就避免所有繼承Activity的類被混淆
-keep public class * extends android.app.Activity
內部類: 如果我們要保留一個類中的內部類不被混淆則需要用 $ 符號,如下例子表示保持ScriptFragment內部類JavaScriptInterface中的所有public內容不被混淆。
-keepclassmembers class cc.ninty.chat.ui.fragment.ScriptFragment$JavaScriptInterface {
public *;
}
注意:上面的方式是以keepclassmembers保持,還有另一種方式就是以keep保持,原理是先keep其外部類不被混淆,再keep該內部類不被混淆,分兩步完成,如下:
-keep class com.banglin.emergencysdk.EmergencySdk {
public *;
}
-keep class com.banglin.emergencysdk.EmergencySdk$* {
public *;
}
這裏就是先保持外部類EmergencySdk不被混淆,再保持其所有內部類($*)和內部類中的所有public內容不被混淆。
3.3、成員變量
如果一個類中你不希望保持全部內容不被混淆,而只是希望保護類下的成員變量,就可以使用
<fields>; //匹配所有域
3.4、成員方法
如果一個類中你不希望保持全部內容不被混淆,而只是希望保護類下的成員方法,就可以使用
<init>; //匹配所有構造器
<methods>; //匹配所有方法方法
你還可以在< fields >或< methods >前面加上private 、public、native等來進一步指定不被混淆的內容,如
-keep class cn.hadcn.test.One {
public <methods>;
}
上面表示One類下的所有public方法都不會被混淆,當然你還可以加入參數,比如以下表示用JSONObject作爲入參的構造函數不會被混淆
-keep class cn.hadcn.test.One {
public <init>(org.json.JSONObject);
}
有時候你是不是還想着,我不需要保持類名,我只需要把該類下的特定方法保持不被混淆就好,那你就不能用keep方法了,keep方法會保持類名,而需要用keepclassmembers ,如此類名就不會被保持,爲了便於對這些規則進行理解,官網給出了以下表格
保留 | 防止被移除或者被重命名 | 防止被重命名 |
---|---|---|
類和類成員 | -keep | -keepnames |
僅類成員 | -keepclassmembers | -keepclassmembernames |
如果擁有某成員,保留類和類成員 | -keepclasseswithmembers | -keepclasseswithmembername |
注意事項:
以下注意事項引自:Android混淆那些事,看這篇就夠了 一文
1,jni方法不可混淆,因爲這個方法需要和native方法保持一致;
-keepclasseswithmembernames class * { # 保持native方法不被混淆
native <methods>;
}
2,反射用到的類不混淆(否則反射可能出現問題);
3,AndroidMainfest中的類不混淆,所以四大組件和Application的子類和Framework層下所有的類默認不會進行混淆。自定義的View默認也不會被混淆;所以像網上貼的很多排除自定義View,或四大組件被混淆的規則在Android Studio中是無需加入的;
4,與服務端交互時,使用GSON、fastjson等框架解析服務端數據時,所寫的JSON對象類不混淆,否則無法將JSON解析成對應的對象;
5,使用第三方開源庫或者引用其他第三方的SDK包時,如果有特別要求,也需要在混淆文件中加入對應的混淆規則;
6,有用到WebView的JS調用也需要保證寫的接口方法不混淆,原因和第一條一樣;
7,Parcelable的子類和Creator靜態成員變量不混淆,否則會產生Android.os.BadParcelableException異常;
-keep class * implements Android.os.Parcelable { # 保持Parcelable不被混淆
public static final Android.os.Parcelable$Creator *;
}
8,使用enum類型時需要注意避免以下兩個方法混淆,因爲enum類的特殊性,以下兩個方法會被反射調用,見第二條規則。
-keepclassmembers enum * {
public static ** values();
public static ** valueOf(java.lang.String);
}
9,自己寫的依賴庫的混淆規則要定義在APP目錄下的混淆規則文件中,不要定義在本依賴庫的混淆文件中,否則也不起作用哦。
一般對外暴露供調用的類或成員方法(即public)需要保持不被混淆,否則會提示找不到相關類或成員;另外,我們也可以根據混淆規則來規劃我們的項目結構,例如實體類統統只寫在一個包下,與js交互的類都只寫在一個包下,反射相關的類也都只寫在一個包下,以此類推,換句話說就是我們在創建一個類時,要想想這個類創建在哪個包下會使我們的混淆工作更容易做。
最後,是下面這個模板化的混淆方案,引自:5分鐘搞定android混淆
一文
#-------------------------------------------定製化區域----------------------------------------------
#---------------------------------1.實體類---------------------------------
-keep class com.demo.login.bean.** { *; }
-keep class com.demo.main.bean.** { *; }
#-------------------------------------------------------------------------
#---------------------------------2.第三方包-------------------------------
#eventBus
-keepattributes *Annotation*
-keepclassmembers class ** {
@org.greenrobot.eventbus.Subscribe <methods>;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; }
-keepclassmembers class * extends org.greenrobot.eventbus.util.ThrowableFailureEvent {
<init>(java.lang.Throwable);
}
#glide
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
**[] $VALUES;
public *;
}
#log4j
-libraryjars log4j-1.2.17.jar
-dontwarn org.apache.log4j.**
-keep class org.apache.log4j.** { *;}
#-------------------------------------------------------------------------
#---------------------------------3.與js互相調用的類------------------------
-keepclasseswithmembers class com.demo.login.bean.ui.MainActivity$JSInterface {
<methods>;
}
#-------------------------------------------------------------------------
#---------------------------------4.反射相關的類和方法-----------------------
#TODO 我的工程裏沒有。。。
#----------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------------
#-------------------------------------------基本不用動區域--------------------------------------------
#---------------------------------基本指令區----------------------------------
-optimizationpasses 5
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-dontskipnonpubliclibraryclassmembers
-dontpreverify
-verbose
-printmapping proguardMapping.txt
-optimizations !code/simplification/cast,!field/*,!class/merging/*
-keepattributes *Annotation*,InnerClasses
-keepattributes Signature
-keepattributes SourceFile,LineNumberTable
#----------------------------------------------------------------------------
#---------------------------------默認保留區---------------------------------
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
-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
-keep class android.support.** {*;}
-keepclasseswithmembernames class * {
native <methods>;
}
-keepclassmembers class * extends android.app.Activity{
public void *(android.view.View);
}
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
-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);
}
-keepclasseswithmembers class * {
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
}
-keep class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator *;
}
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
-keep class **.R$* {
*;
}
-keepclassmembers class * {
void *(**On*Event);
}
#----------------------------------------------------------------------------
#---------------------------------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);
}
#----------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------------