简介
Java代码是非常容易反编译的。为了很好的保护Java源代码,我们往往会对编译好的class文件进行混淆处理。
ProGuard是一个混淆代码的开源项目。它的主要作用就是混淆,当然它还能对字节码进行缩减体积、优化等,但那些对于我们来说都算是次要的功能。
官网地址:http://proguard.sourceforge.NET/
原理
Java 是一种跨平台的、解释型语言,Java 源代码编译成中间”字节码”存储于 class 文件中。由于跨平台的需要,Java 字节码中包括了很多源代码信息,如变量名、方法名,并且通过这些名称来访问变量和方法,这些符号带有许多语义信息,很容易被反编译成 Java 源代码。为了防止这种现象,我们可以使用 Java 混淆器对 Java 字节码进行混淆。
混淆就是对发布出去的程序进行重新组织和处理,使得处理后的代码与处理前代码完成相同的功能,而混淆后的代码很难被反编译,即使反编译成功也很难得出程序的真正语义。被混淆过的程序代码,仍然遵照原来的档案格式和指令集,执行结果也与混淆前一样,只是混淆器将代码中的所有变量、函数、类的名称变为简短的英文字母代号,在缺乏相应的函数名和程序注释的况下,即使被反编译,也将难以阅读。同时混淆是不可逆的,在混淆的过程中一些不影响正常运行的信息将永久丢失,这些信息的丢失使程序变得更加难以理解。
混淆器的作用不仅仅是保护代码,它也有精简编译后程序大小的作用。由于以上介绍的缩短变量和函数名以及丢失部分信息的原因, 编译后 jar 文件体积大约能减少25% ,这对当前费用较贵的无线网络传输是有一定意义的。第三方jar包中如果有.so文件,不用去理会,引入的第三方jar文件不要混淆,否则可能会报异常-optimizationpasses 7 #指定代码的压缩级别 0 - 7 -dontusemixedcaseclassnames #是否使用大小写混合 -dontskipnonpubliclibraryclasses #如果应用程序引入的有jar包,并且想混淆jar包里面的class -dontpreverify #混淆时是否做预校验(可去掉加快混淆速度) -verbose #混淆时是否记录日志(混淆后生产映射文件 map 类名 -> 转化后类名的映射 -optimizations !code/simplification/arithmetic,!field/*,!class/merging/* #淆采用的算法 -keep public class * extends android.app.Activity #所有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.app.backup.BackupAgentHelper -keep public class * extends android.preference.Preference -keepclasseswithmembernames class * { native <methods>; #保持 native 的方法不去混淆 } -keepclasseswithmembers class * { public <init>(android.content.Context, android.util.AttributeSet); #保持自定义控件类不被混淆,指定格式的构造方法不去混淆 } -keepclasseswithmembers class * { public <init>(android.content.Context, android.util.AttributeSet, int); } -keepclassmembers class * extends android.app.Activity { public void *(android.view.View); #保持指定规则的方法不被混淆(Android layout 布局文件中为控件配置的onClick方法不能混淆) } -keep public class * extends android.view.View { #保持自定义控件指定规则的方法不被混淆 public <init>(android.content.Context); public <init>(android.content.Context, android.util.AttributeSet); public <init>(android.content.Context, android.util.AttributeSet, int); public void set*(...); } -keepclassmembers enum * { #保持枚举 enum 不被混淆 public static **[] values(); public static ** valueOf(java.lang.String); } -keep class * implements android.os.Parcelable { #保持 Parcelable 不被混淆(aidl文件不能去混淆) public static final android.os.Parcelable$Creator *; } -keepnames class * implements java.io.Serializable #需要序列化和反序列化的类不能被混淆(注:Java反射用到的类也不能被混淆) -keepclassmembers class * implements java.io.Serializable { #保护实现接口Serializable的类中,指定规则的类成员不被混淆 static final long serialVersionUID; private static final java.io.ObjectStreamField[] serialPersistentFields; !static !transient <fields>; private void writeObject(java.io.ObjectOutputStream); private void readObject(java.io.ObjectInputStream); java.lang.Object writeReplace(); java.lang.Object readResolve(); } -keepattributes Signature #过滤泛型(不写可能会出现类型转换错误,一般情况把这个加上就是了) -keepattributes *Annotation* #假如项目中有用到注解,应加入这行配置 -keep class **.R$* { *; } #保持R文件不被混淆,否则,你的反射是获取不到资源id的 -keepclassmembernames class com.hipad.news.bean.** { *; } #转换JSON的JavaBean,类成员名称保护,使其不被混淆 ################################################################## # 下面都是项目中引入的第三方 jar 包。第三方 jar 包中的代码不是我们的目标和关心的对象,故而对此我们全部忽略不进行混淆。 ################################################################## -libraryjars libs/android-support-v4.jar -dontwarn android.support.v4.** -keep class android.support.v4.** { *; } -keep interface android.support.v4.** { *; } -keep public class * extends android.support.v4.** -keep public class * extends android.app.Fragment -keep class com.google.gson.** { *; } -keep class de.tavendo.** { *; } -dontwarn de.tavendo.** -libraryjars libs/hpSSOAuths_fat.jar -libraryjars libs/jsoup-1.7.2.jar -libraryjars libs/universal-image-loader-1.9.2-SNAPSHOT-with-sources.jar -libraryjars libs/armeabi/libp2psclient.so -libraryjars libs/p2psvideo.jar -dontwarn p2psvideo.** -keep class b00li.** { *; } -dontwarn b00li.** -dontwarn com.google.gson.** -keep class sun.misc.Unsafe { *; } -keep class com.google.gson.** { *; }
不能混淆的代码
顾名思义,不能混淆代码如果被混淆了,就会出现错误。
1、需要反射的代码
2、系统接口
3、Jni接口
4、需要序列号和反序列化的代码(即实现Serializable接口的JavaBean)
5、与服务端进行元数据交互的JavaBean(JSON、XML中对应的类)
……
常见错误
1) Proguard returned with error code 1. See console> 更新proguard版本
> android-support-v4 不进行混淆
> 添加缺少相应的库
2) 使用gson包解析数据时,出现 missing type parameter 异常
> 在 proguard-project.txt 中添加
-dontobfuscate
-dontoptimize
> 在 proguard-project.txt 中添加
# removes such information by default, so configure it to keep all of it.
-keepattributes Signature
# Gson specific classes
-keep class sun.misc.Unsafe { *; }
#-keep class com.google.gson.stream.** { *; }
# Application classes that will be serialized/deserialized over Gson
-keep class com.google.gson.examples.android.model.** { *; }
3) 类型转换错误
> 在 proguard-project.txt 中添加
-keepattributes Signature
4) 空指针异常
> 混淆过滤掉相关类与方法
5) java.lang.reflect.UndeclaredThrowableException
> -keep interface com.dev.impl.**
6) Error: Unable to access jarfile ..libproguard.jar
> 路径问题
7) java.lang.NoSuchMethodError
> 这也是最常见的问题,因为找不到相关方法,方法被混淆了,混淆过滤掉相关方法便可。