寫給Android 混淆小白的快速混淆方法

爲啥子要混淆

簡單來說，Android 進行ProGuard，可以起到壓縮，混淆，預檢，優化的功能，雖然不能說更安全但還是一個不容忽視的環節。

開始混淆第一步

首先在build.gradle 中將混淆的開關打開，即 minifyEnabled 置爲 true

然後就要去proguard-rules.pro寫入我們的混淆的規則（如文件其名），防止重要的類被混淆移除了。

先特別介紹的是與保持相關元素不參與混淆的規則相關的幾種命令：

命令	作用
-keep	防止類和成員被移除或者被重命名
-keepnames	防止類和成員被重命名
-keepclassmembers	防止成員被移除或者被重命名
-keepclasseswithmembers	防止擁有該成員的類和成員被移除或者被重命名
-keepclasseswithmembernames	防止擁有該成員的類和成員被重命名

快速混淆？

省事第一步，先套個模板，就是找到網上博客上別人分享好的模板，像四大組件，主流開源庫，JNI調用本地方法，R資源等的混淆規則都一般有了，注意一點就是套模板，也要套個時間比較近的，沒有翻車的模板，可以能比較節省自己的時間，畢竟這麼多行不一定能快速看出來，打個包出來才發現有問題就尷尬啦。

一般來說，用了混淆的模板後，我們還會有很多項目專屬的需要混淆的部分，例如我們的自定義View，Json解析的實體類，反射用到的類，還有我們依賴的非主流的開源框架，SDK等等。
對於自定義View，很多的模板都會將繼承與View的類用keep指令防止被混淆。有個偷懶的方法就是把自定義View 放入同一個包，再把這個包的類都寫入混淆規則，就可以搞定了。
對於Json解析的實體類，反射用到的類都是同理可得，找到那些不能被移除的，把它們寫入自己的混淆規則裏面。

所以如果在做項目時，有提前想到要給項目做混淆的，在導入依賴時就順手把對應混淆規則寫了，那事後就快活似神仙了。

如果依賴的非主流的開源庫作者沒提及有關混淆的東西，demo裏也沒找到，怎麼辦？

首先，先判斷下它是否內置了混淆規則。如果不聲明它的混淆規則也正常運行，說明已經它帶了混淆。

但是生活往往不會一帆風順，一般來說會有各種報錯，所以還是需要對它聲明混淆。

最簡單的辦法就是找到依賴的這個包，就這個包的類都寫入混淆規則。例如：

項目裏導入了一個非主流的開源庫，然後我需要對它寫入混淆規則，確保它能正常工作。

implementation 'site.gemus:openingstartanimation:1.0.0'

這時候不可以認爲直接去使用它的地方，將有關它 import的類 keep class 就可以。

因爲可能它內部還會使用包內其他類，所以最好仔細排查，最簡(tou)單(lan)就是把這個包的類都 用 keep 指令，防止它們被混淆。如下所示：

一般來說就可以防止這個開源庫裏的類被混淆了。

如果導入了SDK，官網沒有提及有關混淆的事項，demo裏也沒找到，怎麼辦？

例如

先使用 -libraryjars 命令 ，對導入的jar包和 so 文件進行聲明保留它們。

-libraryjars libs/Msc.jar
#-libraryjars libs/armeabi-v7a/libmsc.so
#-libraryjars libs/armeabi-v7a/libmsc.so

如果依舊出錯，嘗試去External library文件夾 或者使用 這個SDK的地方 找到這個 SDK的包找到，並把這個包裏的類 都用 keep 指令保持不被移除。如：

根據包名，寫入混淆規則

-keep class com.iflytek.**{*;}
-keepattributes Signature

一般來說，這樣就可以避免這個SDK的類被混淆啦

模板時間

好了，最後附上一份自己做的項目的混淆規則（僞模板）

# 指定代碼的壓縮級別 0 - 7(指定代碼進行迭代優化的次數，在Android裏面默認是5，這條指令也只有在可以優化時起作用。)
-optimizationpasses 5
# 混淆時不會產生形形色色的類名(混淆時不使用大小寫混合類名)
-dontusemixedcaseclassnames
# 指定不去忽略非公共的庫類(不跳過library中的非public的類)
-dontskipnonpubliclibraryclasses
# 指定不去忽略包可見的庫類的成員
-dontskipnonpubliclibraryclassmembers
#不進行優化，建議使用此選項，
-dontoptimize
 # 不進行預校驗,Android不需要,可加快混淆速度。
-dontpreverify
# 屏蔽警告
-ignorewarnings
# 指定混淆是採用的算法，後面的參數是一個過濾器
# 這個過濾器是谷歌推薦的算法，一般不做更改
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
# 保護代碼中的Annotation不被混淆
-keepattributes *Annotation*
# 避免混淆泛型, 這在JSON實體映射時非常重要
-keepattributes Signature
# 拋出異常時保留代碼行號
-keepattributes SourceFile,LineNumberTable
 #優化時允許訪問並修改有修飾符的類和類的成員，這可以提高優化步驟的結果。
# 比如，當內聯一個公共的getter方法時，這也可能需要外地公共訪問。
# 雖然java二進制規範不需要這個，要不然有的虛擬機處理這些代碼會有問題。當有優化和使用-repackageclasses時才適用。
#指示語：不能用這個指令處理庫中的代碼，因爲有的類和類成員沒有設計成public ,而在api中可能變成public
-allowaccessmodification
#當有優化和使用-repackageclasses時才適用。
-repackageclasses ''
 # 混淆時記錄日誌(打印混淆的詳細信息)
 # 這句話能夠使我們的項目混淆後產生映射文件
 # 包含有類名->混淆後類名的映射關係
-verbose
# ----------------------------- 默認保留 -----------------------------
# 保持哪些類不被混淆
#繼承activity,application,service,broadcastReceiver,contentprovider....不進行混淆
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
-keep public class * extends android.support.multidex.MultiDexApplication
-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 class android.support.** {*;}## 保留support下的所有類及其內部類

-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService
#表示不混淆上面聲明的類，最後這兩個類我們基本也用不上，是接入Google原生的一些服務時使用的。
#----------------------------------------------------

# 保留繼承的
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**

#表示不混淆任何包含native方法的類的類名以及native方法名，這個和我們剛纔驗證的結果是一致
-keepclasseswithmembernames class * {
    native <methods>;
}

#這個主要是在layout 中寫的onclick方法android:onclick="onClick"，不進行混淆
#表示不混淆Activity中參數是View的方法，因爲有這樣一種用法，在XML中配置android:onClick=”buttonClick”屬性，
#當用戶點擊該按鈕時就會調用Activity中的buttonClick(View view)方法，如果這個方法被混淆的話就找不到了
-keepclassmembers class * extends android.app.Activity{
    public void *(android.view.View);
}

#表示不混淆枚舉中的values()和valueOf()方法，枚舉我用的非常少，這個就不評論了
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

#表示不混淆任何一個View中的setXxx()和getXxx()方法，
#因爲屬性動畫需要有相應的setter和getter的方法實現，混淆了就無法工作了。
-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);
}

#表示不混淆Parcelable實現類中的CREATOR字段，
#毫無疑問，CREATOR字段是絕對不能改變的，包括大小寫都不能變，不然整個Parcelable工作機制都會失敗。
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}
# 這指定了繼承Serizalizable的類的如下成員不被移除混淆
-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();
}
# 保留R下面的資源
-keep class **.R$* {
 *;
}
#不混淆資源類下static的
-keepclassmembers class **.R$* {
    public static <fields>;
}

# 對於帶有回調函數的onXXEvent、**On*Listener的，不能被混淆
-keepclassmembers class * {
    void *(**On*Event);
    void *(**On*Listener);
}

# 保留我們自定義控件（繼承自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);
}
-keep class com.example.odm.garbagesorthelper.widget.** { *; }


#
#----------------------------- WebView(項目中沒有可以忽略) -----------------------------
#
#webView需要進行特殊處理

#在app中與HTML5的JavaScript的交互進行特殊處理
#我們需要確保這些js要調用的原生方法不能夠被混淆，於是我們需要做如下處理：


#
#---------------------------------實體類---------------------------
#--------(實體Model不能混淆，否則找不到對應的屬性獲取不到值)-----
#
-keep class com.example.odm.garbagesorthelper.model.entity.** { *; }
-dontwarn  com.example.odm.garbagesorthelper.model.entity.**

#對含有反射類的處理
-keep class com.example.odm.garbagesorthelper.utils.** { *; }

#
# ----------------------------- 其他的 -----------------------------
#
# 刪除代碼中Log相關的代碼
-assumenosideeffects class android.util.Log {
    public static boolean isLoggable(java.lang.String, int);
    public static int v(...);
    public static int i(...);
    public static int w(...);
    public static int d(...);
    public static int e(...);
}

# 保持測試相關的代碼
-dontnote junit.framework.**
-dontnote junit.runner.**
-dontwarn android.test.**
-dontwarn android.support.test.**
-dontwarn org.junit.**
#
# ----------------------------- 第三方庫、框架、SDK -----------------------------
#logger
-dontwarn com.orhanobut.logger.**
-keep class com.orhanobut.logger.**{*;}
-keep interface com.orhanobut.logger.**{*;}

# Gson
-keep class com.google.gson.stream.** { *; }
-keepattributes EnclosingMethod
-dontwarn com.google.gson.**
-keep class com.google.gson.**{*;}
-keep interface com.google.gson.**{*;}
#gson
#如果用到Gson解析包的，直接添加下面這幾行就能成功混淆，不然會報錯。

##---------------Begin: proguard configuration for Gson  ----------
# Gson uses generic type information stored in a class file when working with fields. Proguard
# removes such information by default, so configure it to keep all of it.
-keepattributes Signature

# For using GSON @Expose annotation
-keepattributes *Annotation*

# Gson specific classes
-dontwarn sun.misc.**
#-keep class com.google.gson.stream.** { *; }

# Prevent proguard from stripping interface information from TypeAdapterFactory,
# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer
# Application classes that will be serialized/deserialized over Gso


# OkHttp3
-dontwarn okhttp3.logging.**
-keep class okhttp3.internal.**{*;}
-dontwarn okio.**

# Retrofit
-dontwarn retrofit2.**
-keep class retrofit2.** { *; }
#-keepattributes Signature-keepattributes Exceptions

# Platform calls Class.forName on types which do not exist on Android to determine platform.
-dontnote retrofit2.Platform
# Platform used when running on Java 8 VMs. Will not be used at runtime.
-dontwarn retrofit2.Platform$Java8
# Retain generic type information for use by reflection by converters and adapters.
-keepattributes Signature
# Retain declared checked exceptions for use by a Proxy instance.
-keepattributes Exceptions


# 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;
}

#LiveEventBus
-dontwarn com.jeremyliao.liveeventbus.**
-keep class com.jeremyliao.liveeventbus.** { *; }
-keep class androidx.lifecycle.** { *; }
-keep class androidx.arch.core.** { *; }

#glide
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
  **[] $VALUES;
  public *;
}

#utilcodex
-keep class  com.blankj.utilcode.util.** { *; }

#
-keep class site.gemus.** { *; }

#XUI
-keep class com.xuexiang.xui.** { *; }

#訊飛SDK
-libraryjars libs/Msc.jar
-libraryjars src/main/jniLibs/Msc.jar
-keep class com.iflytek.**{*;}
-keepattributes Signature

#RxPermission
-keep class com.tbruyelle.rxpermissions2.** { *; }

#XBanner
-keep class com.stx.xhb.androidx.XBanner.** { *; }

#底部導航欄
-keep class com.aurelhubert.ahbottomnavigation.** { *; }


#Bugly SDK
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
-keep class android.support.**{*;}