用ProGuard进行代码混淆技术详解

目前项目android客户端需要代码混淆，抽空了解了下ProGuard的原理及使用，记录下来以备后续使用。

目录

ProGuard简介
ProGuard使用原理
studio下编写ProGuard文件

ProGuard简介

ProGuard是一个集压缩（Shrink）、混淆（Obfuscate）、优化（Optimize）Java字节码文件（.class）的免费工具，可以删除多余的类、方法、无效的注释，最大限度的优化字节码文件。上线的app反编译后出现的命名都是通过ProGuard生成的，增加了反编译的难度。
官网介绍：The ProGuard tool shrinks, optimizes, and obfuscates your code by removing unused code and renaming classes, fields, and methods with semantically obscure names. The result is a smaller sized .apkfile that is more difficult to reverse engineer。

ProGuard使用原理

通过前面的介绍，我们知道了ProGuard技术是由Shrink、Optimize、Obfuscate，还有一个preverify（预检）四个功能点组成，每个功能点都是可以选择的。那么ProGuard是如何工作的呢？在这里我们引入一个概念EntryPoint。EntryPoint可以理解为一种标志，它是在ProGuard过程中不会被处理的类或者方法，在压缩的过程,ProGuard会从上述的EntryPoint中开始遍搜索出哪些类和类的成员在使用（被标记为EntryPoint的类和方法有些是在使用的而且这些是我们在混淆文件中配置不希望被混淆的类和方法，有些是没有使用的）。
对于那些没有被使用的类和成员，就会在压缩阶段被丢弃。然后在接下来的优化步骤中，那些非EntryPoint的类，方法都会被设置为private，static或者final，而且不使用的参数都会被移除。接着在混淆的步骤中，ProGuard会对非EntryPoint的类和方法进行重命名。最后就会对代码进行预检测，以便保证稳定性。

studio下编写ProGuard文件

studio下可以通过build.gradle进行Proguard的相关配置：
release {
minifyEnabled true // 是否进行代码混淆
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
// proguard-androi.txt是android默认的混淆声明，proguard-rules.pro为自定义的混淆申明
}
如下是在网上找到的一份模板，比较完善：

# 代码混淆压缩比，在0~7之间，默认为5，一般不做修改
-optimizationpasses 5

#  混合时不使用大小写混合，混合后的类名为小写
-dontusemixedcaseclassnames

#  指定不去忽略非公共库的类
-dontskipnonpubliclibraryclasses

# 这句话能够使我们的项目混淆后产生映射文件
# 包含有类名->混淆后类名的映射关系
-verbose

#  指定不去忽略非公共库的类成员
-dontskipnonpubliclibraryclassmembers

#  不做预校验，preverify是proguard的四个步骤之一，Android不需要preverify，去掉这一步能够加快混淆速度。
-dontpreverify

#  保留Annotation不混淆
-keepattributes *Annotation*,InnerClasses

#  避免混淆泛型
-keepattributes Signature

#  抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable

#  指定混淆是采用的算法，后面的参数是一个过滤器这个过滤器是谷歌推荐的算法，一般不做更改
-optimizations !code/simplification/cast,!field/*,!class/merging/*


#############################################
#
#  Android开发中一些需要保留的公共部分
#
#############################################

#  保留我们使用的四大组件，自定义的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下的所有类及其内部类
-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 ;
}

#  保留在Activity中的方法参数是view的方法，这样以来我们在layout中写的onClick就不会被影响
-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 (android.content.Context);
    public (android.content.Context, android.util.AttributeSet);
    public (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 ;
    !private ;
    !private ;
    private void writeObject(java.io.ObjectOutputStream);
    private void readObject(java.io.ObjectInputStream);
    java.lang.Object writeReplace();
    java.lang.Object readResolve();
}

#  对于带有回调函数的onXXEvent、**On*Listener的，不能被混淆
-keepclassmembers class * {
    void *(**On*Event);
    void *(**On*Listener);
}

#  webView处理，项目中没有使用到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交互---------------

# -----------处理实体类---------------
-keep class x.x.*{*;}


# -----------处理第三方依赖库---------