Android-Proguard(混淆)
混淆这玩意,也是经常用,但也是没总结,趁端午有假有时间,就在这里整理一下,也祝大家端午快乐。
一:混淆是什么,该怎么做?
如果我们的app正常发布就必须要经历混淆这一步,混淆可以使我们的app不那么容易被别人用反编译工具破解,就算被破解,想要读懂我们的源码也是非常费劲的,因为混淆过的源码的类和类成员会被随机命名,代码非常的乱和没有规律,除非之前用keep进行了保护。
以我们的常用开发工具andorid studio 为例,Android Studio自身集成Java语言的ProGuard作为压缩,优化,混淆和预校验,并配合Gradle工具进行构建,我们只需要在工程应用目录的build.gradle文件中设置minifyEnabled为true,然后可以到proguard-rules.pro文件中加入我们的混淆规则即可。如图:
大家看到了,有两个混淆文件,proguard-android.txt和proguard-rules.pro,proguard-rules.pro是我们需要自己编写的混淆文件,proguard-android.txt是系统默认的,那么它在哪里呢?
用工具打开txt文件是这样的效果:
这里说一下,你只要设置了minifyEnabled true开启混淆,其他的压缩,优化,预校验就默认开启了,那我们就可以开始proguard-rules.pro 文件的编写了,如图:
刚才是开启混淆,那我们如何关闭,比如关闭压缩,关闭优化呢?
总结一下:
我们通常说的proguard包括四个功能,shrinker(压缩), optimizer(优化),obfuscator(混淆),preverifier(预校验),他们的作用分别是:
shrink: 检测并移除没有用到的类,变量,方法和属性;
optimize: 优化代码,非入口节点类会加上private/static/final, 在字节码级别执行优化,让应用运行的更快。。
obfuscate: 增大反编译难度,类和类成员会被随机命名,除非用keep保护。
preverify: 预校验代码是否符合Java1.6或者更高的规范.
除了proguard之外,还有一个DexGuard,是专门用来优化混淆Android应用的。它包括资源混淆,字符串加密,类加密和dex文件分割等。它是在android编译的时候直接产生Dalvik字节码.......
混淆后我们会在工程目录app/build/outputs/mapping/release(debug)下找到一个mapping.txt文件,这就是混淆规则,我们可以根据这个文件把混淆后的代码反推回源本的代码,所以这个文件比较重要,请妥善保管.
二:接下来我们来说一说混淆的基本规则:
但如果你用两颗星,会发现,虽然类名被保持了,但里面的变量名啥的都变了,那如果我们既要本包保持类名和内容又要子包保存呢?
-keep class com.xzt.demotwo.**{*;}
剩下的我直接上代码了,大家自己看吧:
-keep class com.xzt.demotwo.* # 一颗星只保持本包的类名(不包含内容)
-keep class com.xzt.demotwo.** # 二颗星表示保持本包和子包下的类名(不包含内容)
# 只保持本包的类名和内容
-keep class com.xzt.demotwo.*{*;}
#可以保持本包和子包的类名和内容
-keep class com.xzt.demotwo.**{*;}
#保持某个具体的类名不被混淆
-keep class com.xzt.demotwo.MainActivity
#保持某个具体的类及其内容不被混淆
-keep class com.xzt.demotwo.MainActivity{*;}
#保持类中特定内容,而不是所有的内容可以使用如下:
-keep class com.xzt.demotwo.MainActivity{
〈init〉;#匹配所有构造器
〈fields〉;#匹配所有域
〈methods〉;#匹配所有方法
}
你还可以在<fields>或<methods>前面加上private 、public、native等来进一步指定不被混淆的内容,如
-keep class com.xzt.demotwo{
public <methods>;
}
表示MainActivity下的所有public方法都不会被混淆,当然你还可以加入参数,比如以下表示用JSONObject作为入参的构造函数不会被混淆
-keep class com.xzt.demotwo {
public <init>(org.json.JSONObject);
}
#保持类中特定内容,还可以进一步缩小范围
-keep class com.xzt.demotwo.MainActivity{
public ;#保持该类下所有的共有方法不被混淆
public *;#保持该类下所有的共有内容不被混淆
private ;#保持该类下所有的私有方法不被混淆
private *;#保持该类下所有的私有内容不被混淆
public (java.lang.String);#保持该类的String类型的构造方法
}
#在方法后加入参数,限制特定的构造方法
-keep class com.xzt.demotwo.MainActivity{
public (String);
}
#要保留一个类中的内部类及其内容不被混淆需要用 $ 符号
-keep class com.xzt.demotwo.MainActivity$MyClass{*;}
#使用Java的基本规则来保护特定类不被混淆,比如用extends,implement等这些Java规则,
#如下:保持Android底层组件和类不要混淆
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Application
-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.view.View
#如果不需要保持类名,只需要保持该类下的特定方法保持不被混淆,
#需要使用keepclassmembers,而不是keep,因为keep方法会保持类名。
#保持MainActivity类下test(String)方法不被混淆
-keepclassmembernames class com.xzt.demotwo.MainActivity{
public void test(java.lang.String);
}
这里我附一张图:
#如果拥有某成员,保留类和类成员
-keepclasseswithmembernames class com.xzt.demotwo.MainActivity
注意事项
1,jni方法不可混淆,因为这个方法需要和native方法保持一致;
-keepclasseswithmembernamesclass*{# 保持native方法不被混淆 native ;}
2,反射用到的类不混淆(否则反射可能出现问题);
3,AndroidMainfest中的类不混淆,所以四大组件和Application的子类和Framework层下所有的类默认不会进行混淆。自定义的View默认也不会被混淆;所以像网上贴的很多排除自定义View,或四大组件被混淆的规则在Android Studio中是无需加入的;
4,与服务端交互时,使用GSON、fastjson等框架解析服务端数据时,所写的JSON对象类不混淆,否则无法将JSON解析成对应的对象;
5,使用第三方开源库或者引用其他第三方的SDK包时,如果有特别要求,也需要在混淆文件中加入对应的混淆规则;
6,有用到WebView的JS调用也需要保证写的接口方法不混淆,原因和第一条一样;
7,Parcelable的子类和Creator静态成员变量不混淆,否则会产生Android.os.BadParcelableException异常;
-keepclass*implementsAndroid.os.Parcelable{# 保持Parcelable不被混淆 publicstaticfinalAndroid.os.Parcelable$Creator *;}
8,使用enum类型时需要注意避免以下两个方法混淆,因为enum类的特殊性,以下两个方法会被反射调用。
-keepclassmembersenum* {publicstatic**[] values();publicstatic**valueOf(java.lang.String); }
好了,大概就这么多。
参考:彭涛(@彭涛me) 致力于让技术变得易懂且有趣
个人博客:http://pengtao.me, GitHub地址:https://github.com/CPPAlien