混淆介绍
Proguard是一个Java类文件压缩器、优化器、混淆器、预校验器。压缩环节会检测以及移除没有用到的类、字段、方法以及属性。优化环节会分析以及优化方法的字节码。混淆环节会用无意义的短变量去重命名类、变量、方法。这些步骤让代码更精简,更高效,也更难被逆向(破解)。
混淆后默认会在工程目录app/build/outputs/mapping/release(debug)下生成一个mapping.txt文件,这就是混淆规则,我们可以根据这个文件把混淆后的代码反推回源本的代码,所以这个文件很重要,注意保护好。原则上,代码混淆后越乱越无规律越好,但有些地方我们是要避免混淆的,否则程序运行就会出错。
ProGuard常用操作
压缩(Shrinking)
压缩(Shrinking):默认开启,用以减小应用体积,移除未被使用的类和成员,并且会在优化动作执行之后再次执行(因为优化后可能会再次暴露一些未被使用的类和成员)。
#关闭压缩
-dontshrink
优化(Optimization)
优化(Optimization):默认开启,在字节码级别执行优化,让应用运行的更快。
#关闭优化
#-dontoptimize
#表示proguard对代码进行迭代优化的次数,Android一般为5
-optimizationpasses n
混淆(Obfuscation)
混淆(Obfuscation):默认开启,增大反编译难度,类和类成员会被随机命名,除非用keep保护。
-dontobfuscate #关闭混淆
-Keep
一颗星表示只是保持该包下的类名,而子包下的类名还是会被混淆;
-keep class pr.tongson.bean.*
两颗星表示把本包和所含子包下的类名都保持;
-keep class pr.tongson.bean.**
(上面两种方式保持类后,会发现类名虽然未混淆,但里面的具体方法和变量命名还是变了)
既可以保持该包下的类名,又可以保持类里面的内容不被混淆;
-keep class pr.tongson.bean.*{*;}
既可以保持该包及子包下的类名,又可以保持类里面的内容不被混淆;
-keep class pr.tongson.bean.**{*;}
保持某个类名不被混淆(但是内部内容会被混淆)
-keep class pr.tongson.bean.KeyBoardBean
保持某个类的 类名及内部的所有内容不会混淆
-keep class pr.tongson.bean.KeyBoardBean{*;}
保持类中特定内容,而不是所有的内容可以使用如下:
-keep class pr.tongson.bean.KeyBoardBean{
#匹配所有构造器
<init>;
#匹配所有域
<fields>;
#匹配所有方法
<methods>;
}
(上面就保持住了KeyBoardBean这个类中的所有的构造方法、变量、和方法)
可以在<fields>或<methods>前面加上private 、public、native等来进一步指定不被混淆的内容
-keep class pr.tongson.algorithm.Calculate{
#保持该类下所有的共有方法不被混淆
public <methods>;
#保持该类下所有的共有内容不被混淆
public *;
#保持该类下所有的私有方法不被混淆
private <methods>;
#保持该类下所有的私有内容不被混淆
private *;
#保持该类的String类型的构造方法
public <init>(java.lang.String);
}
在方法后加入参数,限制特定的方法(经测试:仅限于构造方法可以混淆)
-keep class pr.tongson.algorithm.Calculate{
public <init>(String);
}
要保留一个类中的内部类不被混淆需要用 $ 符号
#保持Calculate中的MyClass不被混淆
-keep class pr.tongson.algorithm.Calculate$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方法会保持类名。
#保持ProguardTest类下test(String)方法不被混淆
-keepclassmembernames class pr.tongson.algorithm.Calculate{
public void test(java.lang.String);
}
如果拥有某成员,保留类和类成员
-keepclasseswithmembernames class pr.tongson.algorithm.Calculate
注意事项
jni方法
jni方法不可混淆,因为native方法是要完整的包名类名方法名来定义的,不能修改,否则找不到;
#保持native方法不被混淆
-keepclasseswithmembernames class * {
native <methods>;
}
反射
反射用到的类混淆时需要注意:只要保持反射用到的类名和方法即可,并不需要将整个被反射到的类都进行保持
AndroidMainfest中的类
AndroidMainfest中的类不混淆,所以四大组件和Application的子类和Framework层下所有的类默认不要进行混淆。
自定义的View
自定义的View默认也不会被混淆
JSON对象类
与服务端交互时,使用GSON、fastjson等框架解析服务端数据时,所写的JSON对象类不混淆,否则无法将JSON解析成对应的对象;
第三方
使用第三方开源库或者引用其他第三方的SDK包时,如果有特别要求,也需要在混淆文件中加入对应的混淆规则;官方文档一般都有混淆规则的,复制粘贴下即可。
有用到WebView的JS
有用到WebView的JS调用也需要保证写的接口方法不混淆,原因和第一条一样;
Parcelable的子类和Creator静态成员变量
Parcelable的子类和Creator静态成员变量不混淆,否则会产生Android.os.BadParcelableException异常;
-keep class * implements Android.os.Parcelable {
# 保持Parcelable不被混淆
public static final Android.os.Parcelable$Creator *;
}
enum
使用enum类型时需要注意避免以下两个方法混淆,因为enum类的特殊性,以下两个方法会被反射调用,见第二条规则。
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
注解不能混淆
建议
建议:
发布一款应用除了设minifyEnabled
为ture,你也应该设置zipAlignEnabled
为true,像Google Play强制要求开发者上传的应用必须是经过zipAlign的,zipAlign可以让安装包中的资源按4字节对齐,这样可以减少应用在运行时的内存消耗。
混淆情况记录
例子中使用:classA和classB,在加混淆的情况下多种结果:
如果classA没有被keep,则不会看到classA的class文件
如果classA没有被keep,classB被保持,同时classB引用到了classA,这个时候能够看到被混淆的classA的class文件,如显示为a
如果classA中通过反射,获取到classB,那么classB的类名及反射用到的方法必须keep住
jar包混淆,暴露出的类、方法、方法的参数需要keep住
情况说明:工程Demo依赖了小米渠道的依赖,小米依赖又依赖了Common,对Common进行混淆但是不对小米渠道混淆,那么小米的依赖中使用到的Common中的类都需要keep住
参考
模版
#指定压缩级别
-optimizationpasses 5
#不跳过非公共的库的类成员
-dontskipnonpubliclibraryclassmembers
#混淆时采用的算法
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
#把混淆类中的方法名也混淆了
-useuniqueclassmembernames
#优化时允许访问并修改有修饰符的类和类的成员
-allowaccessmodification
#将文件来源重命名为“SourceFile”字符串
-renamesourcefileattribute SourceFile
#保留行号
-keepattributes SourceFile,LineNumberTable
#保持泛型
-keepattributes Signature
#保持所有实现 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.**
语法
-include {filename} 从给定的文件中读取配置参数
-basedirectory {directoryname} 指定基础目录为以后相对的档案名称
-injars {class_path} 指定要处理的应用程序jar,war,ear和目录
-outjars {class_path} 指定处理完后要输出的jar,war,ear和目录的名称
-libraryjars {classpath} 指定要处理的应用程序jar,war,ear和目录所需要的程序库文件
-dontskipnonpubliclibraryclasses 指定不去忽略非公共的库类。
-dontskipnonpubliclibraryclassmembers 指定不去忽略包可见的库类的成员。
保留选项
-keep {Modifier} {class_specification} 保护指定的类文件和类的成员
-keepclassmembers {modifier} {class_specification} 保护指定类的成员,如果此类受到保护他们会保护的更好
-keepclasseswithmembers {class_specification} 保护指定的类和类的成员,但条件是所有指定的类和类成员是要存在。
-keepnames {class_specification} 保护指定的类和类的成员的名称(如果他们不会压缩步骤中删除)
-keepclassmembernames {class_specification} 保护指定的类的成员的名称(如果他们不会压缩步骤中删除)
-keepclasseswithmembernames {class_specification} 保护指定的类和类的成员的名称,如果所有指定的类成员出席(在压缩步骤之后)
-printseeds {filename} 列出类和类的成员-keep选项的清单,标准输出到给定的文件
压缩
-dontshrink 不压缩输入的类文件
-printusage {filename}
-dontwarn 如果有警告也不终止
-whyareyoukeeping {class_specification}
优化
-dontoptimize 不优化输入的类文件
-assumenosideeffects {class_specification} 优化时假设指定的方法,没有任何副作用
-allowaccessmodification 优化时允许访问并修改有修饰符的类和类的成员
混淆
-dontobfuscate 不混淆输入的类文件
-printmapping {filename}
-applymapping {filename} 重用映射增加混淆
-obfuscationdictionary {filename} 使用给定文件中的关键字作为要混淆方法的名称
-overloadaggressively 混淆时应用侵入式重载
-useuniqueclassmembernames 确定统一的混淆类的成员名称来增加混淆
-flattenpackagehierarchy {package_name} 重新包装所有重命名的包并放在给定的单一包中
-repackageclass {package_name} 重新包装所有重命名的类文件中放在给定的单一包中
-dontusemixedcaseclassnames 混淆时不会产生形形色色的类名
-keepattributes {attribute_name,...} 保护给定的可选属性,例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and
InnerClasses.
-renamesourcefileattribute {string} 设置源文件中给定的字符串常量