為啥子要混淆

簡(jiǎn)單來(lái)說(shuō)，Android 進(jìn)行ProGuard，可以起到壓縮，混淆，預(yù)檢，優(yōu)化的功能，雖然不能說(shuō)更安全但還是一個(gè)不容忽視的環(huán)節(jié)。

開(kāi)始混淆第一步

首先在build.gradle 中將混淆的開(kāi)關(guān)打開(kāi)，即 minifyEnabled 置為 true

image

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

先特別介紹的是與防止類被混淆的的幾條指令：

快速混淆？

省事第一步，先套個(gè)模板，就是找到網(wǎng)上博客上別人分享好的模板，像四大組件，主流開(kāi)源庫(kù)，JNI調(diào)用本地方法，R資源等的混淆規(guī)則都一般有了，注意一點(diǎn)就是套模板，也要套個(gè)時(shí)間比較近的，沒(méi)有翻車的模板，可以能比較節(jié)省自己的時(shí)間，畢竟這么多行不一定能快速看出來(lái)，打個(gè)包出來(lái)才發(fā)現(xiàn)有問(wèn)題就尷尬啦。

一般來(lái)說(shuō)，用了混淆的模板后，我們還會(huì)有很多項(xiàng)目專屬的需要混淆的部分，例如我們的自定義View，Json解析的實(shí)體類，反射用到的類，還有我們依賴的非主流的開(kāi)源框架，SDK等等。
對(duì)于自定義View，很多的模板都會(huì)將繼承與View的類用keep指令防止被混淆。有個(gè)偷懶的方法就是把自定義View 放入同一個(gè)包，再把這個(gè)包的類都寫入混淆規(guī)則，就可以搞定了。
對(duì)于Json解析的實(shí)體類，反射用到的類都是同理可得，找到那些不能被移除的，把它們寫入自己的混淆規(guī)則里面。

所以如果在做項(xiàng)目時(shí)，有提前想到要給項(xiàng)目做混淆的，在導(dǎo)入依賴時(shí)就順手把對(duì)應(yīng)混淆規(guī)則寫了，那事后就快活似神仙了。

如果依賴的非主流的開(kāi)源庫(kù)作者沒(méi)提及有關(guān)混淆的東西，demo里也沒(méi)找到，怎么辦？

首先，先判斷下它是否內(nèi)置了混淆規(guī)則。如果不聲明它的混淆規(guī)則也正常運(yùn)行，說(shuō)明已經(jīng)它帶了混淆。

但是生活往往不會(huì)一帆風(fēng)順，一般來(lái)說(shuō)會(huì)有各種報(bào)錯(cuò)，所以還是需要對(duì)它聲明混淆。

最簡(jiǎn)單的辦法就是找到依賴的這個(gè)包，就這個(gè)包的類都寫入混淆規(guī)則。例如：

項(xiàng)目里導(dǎo)入了一個(gè)非主流的開(kāi)源庫(kù)，然后我需要對(duì)它寫入混淆規(guī)則，確保它能正常工作。

implementation 'site.gemus:openingstartanimation:1.0.0'

這時(shí)候不可以認(rèn)為直接去使用它的地方，將有關(guān)它 import的類 keep class 就可以。

image

因?yàn)榭赡芩鼉?nèi)部還會(huì)使用包內(nèi)其他類，所以最好仔細(xì)排查，最簡(jiǎn)(tou)單(lan)就是把這個(gè)包的類都 用 keep 指令，防止它們被混淆。如下所示：

image

一般來(lái)說(shuō)就可以防止這個(gè)開(kāi)源庫(kù)里的類被混淆了。

如果導(dǎo)入了SDK，官網(wǎng)沒(méi)有提及有關(guān)混淆的事項(xiàng)，demo里也沒(méi)找到，怎么辦？

例如

image

先使用 -libraryjars 命令 ，對(duì)導(dǎo)入的jar包和 so 文件進(jìn)行聲明保留它們。

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

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

image

根據(jù)包名，寫入混淆規(guī)則

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

一般來(lái)說(shuō)，這樣就可以避免這個(gè)SDK的類被混淆啦

模板時(shí)間

好了，最后附上一份自己做的項(xiàng)目的混淆規(guī)則（偽模板）

# 指定代碼的壓縮級(jí)別 0 - 7(指定代碼進(jìn)行迭代優(yōu)化的次數(shù)，在Android里面默認(rèn)是5，這條指令也只有在可以優(yōu)化時(shí)起作用。)
-optimizationpasses 5
# 混淆時(shí)不會(huì)產(chǎn)生形形色色的類名(混淆時(shí)不使用大小寫混合類名)
-dontusemixedcaseclassnames
# 指定不去忽略非公共的庫(kù)類(不跳過(guò)library中的非public的類)
-dontskipnonpubliclibraryclasses
# 指定不去忽略包可見(jiàn)的庫(kù)類的成員
-dontskipnonpubliclibraryclassmembers
#不進(jìn)行優(yōu)化，建議使用此選項(xiàng)，
-dontoptimize
 # 不進(jìn)行預(yù)校驗(yàn),Android不需要,可加快混淆速度。
-dontpreverify
# 屏蔽警告
-ignorewarnings
# 指定混淆是采用的算法，后面的參數(shù)是一個(gè)過(guò)濾器
# 這個(gè)過(guò)濾器是谷歌推薦的算法，一般不做更改
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
# 保護(hù)代碼中的Annotation不被混淆
-keepattributes *Annotation*
# 避免混淆泛型, 這在JSON實(shí)體映射時(shí)非常重要
-keepattributes Signature
# 拋出異常時(shí)保留代碼行號(hào)
-keepattributes SourceFile,LineNumberTable
 #優(yōu)化時(shí)允許訪問(wèn)并修改有修飾符的類和類的成員，這可以提高優(yōu)化步驟的結(jié)果。
# 比如，當(dāng)內(nèi)聯(lián)一個(gè)公共的getter方法時(shí)，這也可能需要外地公共訪問(wèn)。
# 雖然java二進(jìn)制規(guī)范不需要這個(gè)，要不然有的虛擬機(jī)處理這些代碼會(huì)有問(wèn)題。當(dāng)有優(yōu)化和使用-repackageclasses時(shí)才適用。
#指示語(yǔ)：不能用這個(gè)指令處理庫(kù)中的代碼，因?yàn)橛械念惡皖惓蓡T沒(méi)有設(shè)計(jì)成public ,而在api中可能變成public
-allowaccessmodification
#當(dāng)有優(yōu)化和使用-repackageclasses時(shí)才適用。
-repackageclasses ''
 # 混淆時(shí)記錄日志(打印混淆的詳細(xì)信息)
 # 這句話能夠使我們的項(xiàng)目混淆后產(chǎn)生映射文件
 # 包含有類名->混淆后類名的映射關(guān)系
-verbose
# ----------------------------- 默認(rèn)保留 -----------------------------
# 保持哪些類不被混淆
#繼承activity,application,service,broadcastReceiver,contentprovider....不進(jìn)行混淆
-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下的所有類及其內(nèi)部類

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

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

#表示不混淆任何包含native方法的類的類名以及native方法名，這個(gè)和我們剛才驗(yàn)證的結(jié)果是一致
-keepclasseswithmembernames class * {
    native <methods>;
}

#這個(gè)主要是在layout 中寫的onclick方法android:onclick="onClick"，不進(jìn)行混淆
#表示不混淆Activity中參數(shù)是View的方法，因?yàn)橛羞@樣一種用法，在XML中配置android:onClick=”buttonClick”屬性，
#當(dāng)用戶點(diǎn)擊該按鈕時(shí)就會(huì)調(diào)用Activity中的buttonClick(View view)方法，如果這個(gè)方法被混淆的話就找不到了
-keepclassmembers class * extends android.app.Activity{
    public void *(android.view.View);
}

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

#表示不混淆任何一個(gè)View中的setXxx()和getXxx()方法，
#因?yàn)閷傩詣?dòng)畫需要有相應(yīng)的setter和getter的方法實(shí)現(xiàn)，混淆了就無(wú)法工作了。
-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實(shí)現(xiàn)類中的CREATOR字段，
#毫無(wú)疑問(wèn)，CREATOR字段是絕對(duì)不能改變的，包括大小寫都不能變，不然整個(gè)Parcelable工作機(jī)制都會(huì)失敗。
-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>;
}

# 對(duì)于帶有回調(diào)函數(shù)的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(項(xiàng)目中沒(méi)有可以忽略) -----------------------------
#
#webView需要進(jìn)行特殊處理

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


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

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

#
# ----------------------------- 其他的 -----------------------------
#
# 刪除代碼中Log相關(guān)的代碼
-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(...);
}

# 保持測(cè)試相關(guān)的代碼
-dontnote junit.framework.**
-dontnote junit.runner.**
-dontwarn android.test.**
-dontwarn android.support.test.**
-dontwarn org.junit.**
#
# ----------------------------- 第三方庫(kù)、框架、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解析包的，直接添加下面這幾行就能成功混淆，不然會(huì)報(bào)錯(cuò)。

##---------------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.** { *; }

#底部導(dǎo)航欄
-keep class com.aurelhubert.ahbottomnavigation.** { *; }


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