概述
混淆是Android Apk打包过程中的一个重要步骤，默认情况下，打包都是需要混淆过程的。
Android App混淆，包括：代码混淆、代码压缩、资源压缩
混淆过程具体做了什么？
答：将主项目和依赖库中未被使用的类、类成员、方法、属性移除，有助于规避64K方法数的瓶颈；同时，将类和类成员、方法重命名为无意义的字段，增加逆向工程难度
工具：ProGuard
入门
（一）build.gradle的混淆配置
- 我们在AS中创建一个新的Project，得到的app module 的build.gradle中的原始配置如下：
///原始的app/build.gradle中的打包混淆相关配置
android{
.................
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
..................
}
- 我们需要：让release打包时开启混淆
minifyEnabled true和资源压缩shrinkResources true、让debug方式打包时关闭混淆minifyEnabled false【减少编译时间】
///原始的app/build.gradle中的打包混淆相关配置
android{
.................
buildTypes {
release {
minifyEnabled true
shrinkResources true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
debug {
minifyEnabled false
}
}
..................
}
（二）自定义混淆文件proguard-rules.pro
- 常用通用自定义混淆配置
#指定压缩级别
-optimizationpasses 5
#不跳过非公共的库的类成员
-dontskipnonpubliclibraryclassmembers
#混淆时采用的算法
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
#把混淆类中的方法名也混淆了
-useuniqueclassmembernames
#优化时允许访问并修改有修饰符的类和类的成员
-allowaccessmodification
#将文件来源重命名为“SourceFile”字符串
-renamesourcefileattribute SourceFile
#保留行号
-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.**
# 忽略警告
-ignorewarning
# 记录生成的日志数据,gradle build时在本项目根目录输出
# apk 包内所有 class 的内部结构
-dump class_files.txt
# 未混淆的类和成员
-printseeds seeds.txt
# 列出从 apk 中删除的代码
-printusage unused.txt
# 混淆前后的映射
-printmapping mapping.txt
- 根据项目不同需要具体再加的混淆规则：
- 第三方库开发指南指定的混淆规则
- 在运行时动态改变的代码，例如反射。比较典型的例子就是会与 json 相互转换的实体类。假如项目命名规范要求实体类都要放在model包下的话，可以添加类似这样的代码把所有实体类都保持住：
-keep public class **.*Model*.** {*;} - JNI 调用的类
-
WebView中JavaScript调用的方法 -
layout中使用的View构造函数、android:onClick等
（三）检查混淆结果
-
Generate Signed APK完成后，默认会到app/build/outputs/mapping/release/目录下生成一些信息日志文件
- dump.txt：描述APK文件中所有类的内部结构
- mapping.txt：提供混淆前后类、方法、类成员等的对照表
- seeds.txt：列出没有被混淆的类和成员
- usage.txt：列出被移除的代码
-
Proguard工具 与 release apk bug调试
-
【以Mac为例】在
<SDK_rootDir>/tools/proguard/bin/目录下，有着反解相关GUI工具proguardgui.sh(Windows下为proguardgui.bat) 和 反解命令行工具retrace.sh- GUI反解工具
proguardgui.sh:- 命令行输入
./proguardgui.sh（Windows下直接双击）
- 在弹出的界面中，点击左侧菜单的“ReTrace”按钮，选择混淆打包好的apk对应的
mapping.txt文件，并将自己调试过程中看到了被混淆了的exception信息粘贴到下方编辑框
- 混淆后的堆栈信息就显示出来
- 命令行输入
- GUI反解工具
-
命令行反解工具
retrace.sh:- 直接命令行输入:
例如：retrace.sh [-verbose] mapping.txt [<stacktrace_file>]retrace.sh -verbose mapping.txt obfuscated_trace.txt
- 直接命令行输入:
-
巩固 和 深入
（一）混淆过程深入
虽然 宏观在讲，Android混淆打包过程有：代码混淆和资源压缩两个部分，但是，资源压缩（移除项目及依赖的库中未被使用的资源）实际上与真正意义上的“混淆”没有关系
- 【代码压缩优化过程】整个代码混淆优化过程具体包括几个流程：
代码压缩 -> 优化 -> 混淆 -> 预校验- 压缩：移除无效的类、类成员、方法、属性等。
- 优化：分析和优化方法的二进制代码；根据proguard-android-optimize.txt中的描述，优化可能会造成一些潜在风险，不能保证在所有版本的Dalvik上都正常运行。
- 混淆：把类名、属性名、方法名替换为简短且无意义的名称。
- 预校验：添加预校验信息。这个预校验是作用在Java平台上的，Android平台上不需要这项功能，去掉之后还可以加快混淆速度。
注意：
1. 以上四个流程默认执行。
2. 相关命令：-dontoptimize【关闭“优化”流程】，-dontpreverify【关闭“预校验”流程】（当然，默认的
proguard-android.txt文件已包含这两条混淆命令，不需要开发者额外配置） - 【资源压缩过程】资源压缩过程也包括几个流程：
资源合并 -> 资源移除-
资源合并：名称相同的资源被视为重复资源会被合并。【此过程不受
shrinkResources属性控制，也无法禁止，<u>gradle 必然会做这项工作，因为假如不同项目中存在相同名称的资源将导致错误</u>】- gradle查找资源的目录有：
src/main/res/- 不同构造类型：release 和 debug 等
- 不同构建渠道
- 项目依赖的第三方库
- gradle查找资源的目录有：
-
优先级：依赖 < main < 渠道 < 构建类型
- 资源在不同优先级中重复出现，则合并并保留高优先级资源。（比如：重复资源存在于
main文件夹和不同渠道中，则选择保留渠道中的资源） - 资源在相同优先级中重复出现，则报错（不同依赖库的
src/main/res/中都有同一个资源，则无法合并）
- 资源在不同优先级中重复出现，则合并并保留高优先级资源。（比如：重复资源存在于
-
资源合并：名称相同的资源被视为重复资源会被合并。【此过程不受
（二）自定义混淆规则
详细的规则写法可以去官网查看：http://developer.android.com/guide/developing/tools/proguard.html
- 保持相关元素不参与混淆的规则：
| 命令 | 作用 |
|---|---|
| -keep | 防止类和成员被移除或者被重命名 |
| -keepnames | 防止类和成员被重命名 |
| -keepclassmembers | 防止成员被移除或者被重命名 |
| -keepnames | 防止成员被重命名 |
| -keepclasseswithmembers | 防止拥有该成员的类和成员被移除或者被重命名 |
| -keepclasseswithmembernames | 防止拥有该成员的类和成员被重命名 |
-
语法格式：
[命令] [类] { [成员] } ///其中： /// [类]: 最终定位到符合某个条件的类。 // 包括：具体类、访问修饰符、 '*'【匹配任意长度字符】、'**'【匹配包含分隔符'.'的任意长度字符】 、'extends'、'implements'、'$'【匹配某个类的内部类】 ///[成员]: 最终定位到符合某个条件的类成员。 // 包括：具体类、访问修饰符、 '*'【匹配任意长度字符】、'**'【匹配包含分隔符'.'的任意长度字符】 、'extends'、'implements'、'$'【匹配某个类的内部类】、'***'【匹配任意参数类型】、'...'【匹配任意长度的任意参数类型】例子： -keep public class com.jp.test.** extends Android.app.Activity { <init>
}
* 常用的代码保留的混淆规则例子【其实有点像写正则表达式】
* 不混淆某个类：
`-keep public class com.jp.example.Test { *; }`
* 不混淆某个包所有的类：
`-keep class com.jp.test.** { *; }`
* 不混淆某个类的子类：
`-keep class * extends com.jp.example.Test {*;}`
* 不混淆所有类名中含有"model"的类及其成员
`-keep public class **.*model*.** {*;}`
* 不混淆某个接口的实现
`-keep class * implements com.jp.interface.ILogin {*;}`
* 不混淆某个类的构造方法
-keepclassmembers com.jp.example.Person{
public <init>();
}
* 不混淆某个类的特定方法
-keepclassmembers com.jp.example.Person{
public void speak(java.lang.String){
}
}
* 资源保留的混淆规则制定【如果想强行保留某些本应该被移除的资源】
* 默认情况下，`shrinkResources true`会让所有未被使用的资源都移除。
* 特殊情况：在`res/raw/`目录中创建一个xml文件如`keep.xml`，然后设置相关属性：
* `tools:keep`：定义哪些资源需要被保留（资源之间用“,”隔开）
* `tools:discard`：定义哪些资源需要被移除（资源之间用“,”隔开）
* `tools:shrinkMode="strict"`：开启严格模式
运用情景：用动态的字符串来获取并使用资源时，普通的资源引用检查就可能会有问题。例如，如下代码会导致所有以“img_”开头的资源都被标记为已使用：
```
String name = String.format("img_%1d", angle + 1);
res = getResources().getIdentifier(name, "drawable", getPackageName());
```
此时，设置严格模式，使只有确实被使用的资源被保留。
* 例子：
<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
tools:keep="@layout/l_used_c,@layout/l_used_a,@layout/l_used_b"
tools:discard="@layout/unused2"
tools:shrinkMode="strict"/>
* 移除替代资源
* 一些替代资源，如多语言支持的`strings.xml`和多分辨率支持的`layout.xml`（比如说像项目中的 `src/res/values/`和`src/res/values-w820dp/`中都存在的`dimens.xml`文件），在不需要使用到时，可以设置被移除，使用`resConfigs`：
```
android {
defaultConfig {
...
resConfigs "en", "fr" ///只保留：英语、法语，其他未显式声明的语言资源将被移除
}
}
```
###（三）再看`build.gradle`的混淆配置代码
* 【默认的混淆配置文件内容】看看`proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'`，意思是：混淆规则默认会是读取`AndroidSDK目录/tools/proguard/proguard-android.txt`文件 和 `项目/app/proguard_rules.pro`文件，分别表示：默认混淆配置 和 自定义混淆规则配置。
而默认的混淆规则`proguard-android.txt`内容解释如下：
包名不混合大小写
-dontusemixedcaseclassnames
不跳过非公共的库的类
-dontskipnonpubliclibraryclasses
混淆时记录日志
-verbose
关闭预校验
-dontpreverify
不优化输入的类文件
-dontoptimize
保护注解
-keepattributes Annotation
保持所有拥有本地方法的类名及本地方法名
-keepclasseswithmembernames class * {
native <methods>;
}
保持自定义View的get和set相关方法
-keepclassmembers public class * extends android.view.View {
void set(*);
*** get();
}
保持Activity中View及其子类入参的方法
-keepclassmembers class * extends android.app.Activity {
public void *(android.view.View);
}
枚举
-keepclassmembers enum * {
**[] $VALUES;
public *;
}
Parcelable
-keepclassmembers class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator CREATOR;
}
R文件的静态成员
-keepclassmembers class .R$ {
public static <fields>;
}
-dontwarn android.support.*
keep相关注解
-keep class android.support.annotation.Keep
-keep @android.support.annotation.Keep class * {*;}
-keepclasseswithmembers class * {
@android.support.annotation.Keep <methods>;
}
-keepclasseswithmembers class * {
@android.support.annotation.Keep <fields>;
}
-keepclasseswithmembers class * {
@android.support.annotation.Keep <init>(...);
}
# 注意事项
---
1. 所有在`AndroidManifest.xml`涉及到的类已经自动被保持，因此不用特意去添加这块混淆规则。（很多老的混淆文件里会加，现在已经没必要）。
2. `proguard-android.txt`已经存在一些默认混淆规则，没必要在`proguard-rules.pro` 重复添加。
## 参考文章
* https://yq.aliyun.com/articles/62980?utm_campaign=wenzhang&utm_medium=article&utm_source=QQ-qun&2017314&utm_content=m_13399
*