Android 中 ProGuard 混淆详解（一）

概述

Android开发中混淆是防止代码反编译的重要手段，同时在混淆中还包括了代码压缩，资源压缩的优化过程。使用ProGuard，我们可以将项目中未被使用的类，类成员，方法，属性移除，有助于规避64K方法数的瓶颈，把类，类成员，方法重命名为无意义的简短名称，增加逆向工程的难度，同时还可以通过Gradle来移除未被使用的资源，可以有效减少apk的大小。

ProGuard简介

ProGuard 由shrink（压缩），optimize（优化），obfuscate（混淆），preveirfy（预检）四个步骤组成，每个步骤都是可选的，我们通过配置脚本来决定执行其中哪几个步骤。
● 压缩：检测并移除代码中无用的类，字段，方法和特性；
● 优化：对字节码进行优化，移除无用的指令。优化可能会造成一些潜在风险，不能保证在所有版本上都能正常运行；
● 混淆：使用a，b，c，d这样简短而无意义的名称，对类，字段和方法进行重命名；
● 预检：在java平台上对处理后的代码进行预检，确保加载的class文件是可执行的。这个预校验是作用在java平台上的，Android平台不需要这项功能，去掉之后还可以加快混淆速度。

混淆配置

默认情况下，app module的build.gradle文件，会有如下：

android {
    . . .
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

由于开启混淆会是编译时间变长，所以debug模式下选择关闭，这时我们需要：
1.将release版本中，minifyEnabled 为true，打开混淆；
2.加上shrinkResources true ，打开资源压缩。

修改后如下：

release {
            minifyEnabled true
            shrinkResources true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
 }

proguardFiles getDefaultProguardFile 就是制定混淆规则的文件，Android studio 默认生成了proguard-rules.pro 文件。

定义混淆规则

上面生成proguard-rules.pro 文件后，我们就可以直接定义自己的混淆文件了。
首先，我们可以先设置通用的混淆规则，如下：

//指定压缩级别，在0和7之间，默认为5，一般不需要修改
-optimizationpasses 5

//不跳过非公共的库的类成员
-dontskipnonpubliclibraryclassmembers

//混淆时采用的算法，后面的参数一个过滤器，谷歌推荐，不需要改变
-optimizations !code/simplification/arithmetic,!field/,!class/merging/

//把混淆类中的方法名也混淆了
-useuniqueclassmembernames

//优化时允许访问并修改有修饰符的类和类的成员
-allowaccessmodification

//将文件来源重命名为“SourceFile”字符串
-renamesourcefileattribute SourceFile

//避免混淆泛型，这在JSON实体映射时非常重要，比如fastJson
-keepattributes Signature

//抛出异常时保留代码行号，在异常分析中可以方便定位
-keepattributes SourceFile,LineNumberTable

//保持所有实现 Serializable 接口的类成员
-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();
}

//Fragment不需要在AndroidManifest.xml中注册，需要额外保护下
-keep public class * extends android.support.v4.app.Fragment
-keep public class * extends android.app.Fragment

//保持测试相关的代码
-dontnote junit.framework.**
-dontnote junit.runner.**
-dontwarn android.test.**
-dontwarn android.support.test.**
-dontwarn org.junit.**

以上是通用的混淆规则，另外我们还需要根据自身需求添加一些混淆规则：
第三个库所需的混淆规则，正规的第三方库一般都会在接入文档中写好所需混淆规则，使用时注意添加。
运行时动态改变的代码，例如反射，与json相互转换的实体类，假如项目命名规范要求实体类都要放在model包中，可以添加类型这样的代码把所有实体类，都保持住：-keep public class .Model. {*;}
JNI中调用的类。
WebView中JavaScript调用的方法；
Layout布局中使用的View构造函数，android：onClick等；

检查混淆结果

混淆过的包必须进行检查，避免因混淆引入的bug。使用上面的配置进行混淆打包后在/build/outputs/mapping/release/ 目录下会输出以下文件：

dump.txt：描述APK文件中所有类的内部结构
mapping.txt：提供混淆前后类，方法，类成员的对照表
seeds.txt：列出没有被混淆的类和成员
resources.txt：列出被移除的代码

我们可以根据seeds.txt 文件检查为被混淆的类和成员是否包含所期望保留的，再根据resources.txt文件是否有被误移除的代码。最后，需要从测试方面检查。将混淆过的包进行全方面测试，检查是否有 bug 产生。

解析查看混淆栈

混淆后的类，方法名等难以阅读，这固然会增加逆向工程的难度，但是对追踪线上crash也造成了阻碍，我们很难根据栈信息定位问题，这时需要将混淆反解。

在 /tools/proguard/ 路径下有附带的的反解工具（Window 系统为 proguardgui.bat，Mac 或 Linux 系统为 proguardgui.sh）。

这里以 Window 平台为例。双击运行 proguardgui.bat 后，可以看到左侧的一行菜单。点击 ReTrace，选择该混淆包对应的 mapping 文件，再将 crash 的 stack trace 黏贴进输入框中，点击右下角的 ReTrace ，混淆后的堆栈信息就显示出来了。

以上使用 GUI 程序进行操作，另一种方式是利用该路径下的 retrace 工具通过命令行进行反解，命令是：
retrace.bat|retrace.sh [-verbose] mapping.txt []

例如：
retrace.bat -verbose mapping.txt obfuscated_trace.txt

注意：
1.所有在AndroidMainfest.xml，涉及到的类已经自动被保持，因此不用特意去添加这块混淆规则。（很多老的混淆文件里会加，现在已经没必要）
2.proguard-android.txt 已经存在一些默认混淆规则，没必要在 proguard-rules.pro 重复添加，该文件具体规则可见如下：proguard-android.txt。