概述
Java源代码编译成的class文件(Android中编译成dex文件类似)中有大量包含语义的变量名、方法名的信息,很容易被反编译为Java源代码。为了防止这种现象,我们可以对Java字节码进行混淆。混淆不仅能将代码中的类名、字段、方法名变为无意义的名称,保护代码,也由于移除无用的类、方法,并使用简短名称对类、字段、方法进行重命名缩小了程序的大小。
proguard-rules.pro
ProGuard由shrink、optimize、obfuscate和preverify四个步骤组成,每个步骤都是可选的,需要哪些步骤都可以在脚本中配置。
压缩(Shrink):默认开启,侦测并移除代码中无用的类、字段、方法和特性,减少应用体积,并且会在优化动作执行之后再次执行(因为优化后可能会再次暴露一些未使用的类和成员)。
-dontshrink 关闭混淆优化(Optimize):默认开启,分析和优化字节码,让应用运行的更快。
-dontoptimize 关闭优化,默认混淆配置文件开始
-optimizationpasses n 表示proguard对代码进行迭代优化的次数,Android一般为5混淆(Obfuscate):默认开启,使用a、b、c、d这样简短而无意义的名称,对类、字段和方法进行重命名,增大反编译难度。
-dontobfuscate 关闭混淆
上面三个步骤使代码大小更小、更高效,也更难被逆向工程。预检(Preverify):在java平台上对处理后的代码进行预检。
混淆需要注意的地方
- 在AndroidManifest中配置的类,比如四大组件
- 调用的方法
- 反射用到的类
- WebView中JavaScript调用的方法
- Layout文件引用到的自定义View
- 一些引入的第三方库(一般都会有混淆说明的)
字符含义
1.Filters
?
匹配一个字符
*
匹配一个名字,除了目录外分隔符外的任意部分
**
匹配任意名,可能包含任意路径分隔符
!
排除
匹配类中的所有字段
匹配类中所有的方法
匹配类中所有的构造函数
-keep class com.demo.test.** 本包和所包含子包下的类名都保持
-keep class com.demo.test.* 保持该包下的类名
-keep class com.demo.test.** {*;} 保持包和子包的类名和里面的内容均不被混淆
如果要保留一个类中的内部类不被混淆则需要用$符号。
2.-assumenosideeffects指令:
assumeosideeffects是Optimization过程中的选项,所以为保证指令的有效,需要开启optimization。这个指令的含义是Proguard会在optimization过程中删除对这些方法的调用,需要注意:当你知道你在做什么的时候才能使用它。
常用到的不混淆
1.jni方法不混淆
jni方法不混淆,因为方法需要和native方法保持一致。
-keepclasseswithmembernames class * { # 保持native方法不被混淆 native
2.反射不混淆
反射用到的类不混淆(否则混淆可能出现问题)。
-keepatrributes EnclosingMethod
3.AndroidMainfest中的类不混淆
AndroidMainfest中的类不混淆,所以四大组件和Application的子类和Framework层下所有的类默认不会进行混淆。自定义的View默认也不会被混下,所以排除自定义View,或者四大组件被混淆的规则在ndroid Studio中无需加入的,下面是兼容性比较高的规则:
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Service
-keep public class * extends android.content。BroadcastReceiver
-keep public class * extends android.content.ContentProvider
-keep public class * entends android.app.backup.BackupAgentHelper
-keep public class * entends android.preference.Preference
4.JSON对象类不混淆
与服务器交互时,使用GSON、fastjson等框架解析服务端数据时,所写的JSON对象类不混淆,否则无法将JSON解析成对应的对象。
5.第三方开源或SDK包
使用第三方开源库或者引用其他第三方的SDK包时,如果有特别要求,也需要在混淆文件中加入对应的混淆规则。
6.WebView的JS调用的接口方法不混淆
有用到WebView的JS调用也需要保证写的接口方法不混淆,原则和第一条一样。
-keepclassmembers classs fqcn.of.javascript.interface.for.webview {
public *;
}
7.Parcelable的子类和Creator静态成员变量不混淆
Parcelable的子类和Creator静态成员变量不混淆,否则会产生Android.os.BadParcelableException异常;
-keep class * implements Android.os.Parcelable {
# 保持Parcelable不被混淆
public static final Android.os.Parcelable$Creator *;
}
8.enum类型
使用enum类型时需要注意避免以下两个方法混淆,因为enum类的特殊性,以下两个方法会被反射调用。
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
9.注解不混淆
-keepatrributes *Annotation*
-keep class * extends java.lang.annotation.Annotation {*;}
10.泛型不混淆
-keepattributes Signature
11.内部类不混淆
-keepattributes InnerClasses
自定义通用混淆配置
#++++++++++++++++++++++ 一、保留区域++++++++++++++++++++++++++++++
#----------基本指令区-----------
# 代码混淆的压缩比例,值在0-7之间
-optimizationpasses 5
# 指定不去忽略非公共的库的类
-dontskipnonpubliclibraryclassmembers
# 生成原类名和混淆后的类名的映射文件
-verbose
-printmapping proguardMapping.txt
#google推荐算法
#-optimizations !code/simplification/cast,!field/*,!class/merging/*
-optimizations !code/simplification/arithmetic,!code/simplication/cast,!field/*,!class/mergin/*
#避免混淆Annotation、内部类、泛型、匿名类
-keepattributes *Annotation*,InnerClasses,Signature,EnclosingMethod
#不做预校验,preverify是proguard的四个步骤之一,Android不需要precerify,去掉这一步能够加快混淆速度。
-dontpreverify
# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable
#重命名抛出异常时的文件名称
-renamesourcefileattribute SourceFile
#---------默认保留区,保留四大组件,自定义的Application等这些类不被混淆--------------
-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.app.backup.BackupAgentHelper
-keep public class * extends android.preference.Preference
-keep public class * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
-keep class android.support.** {*;}
#保留本地native方法不被混淆
-keepclasseswithmembernames class * {
native ;
}
#保留枚举类不被混淆
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
-keep class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator *;
}
#保留自定义的xlog文件夹下面的类、类成员和方法不被混淆
-keep class com.text.xlog.** {
;
;
}
#assume no side effects;删除android.util.Log输出的日志
-assumenosideeffects class android.util.Log {
public static *** v(...);
public static *** d(...);
public static *** i(...);
public static *** w(...);
public static *** e(...);
}
#保留keep注解的类名和方法
-keep,allowobfuscation @interface android.support.annotation.Keep
-keep @android.support.annotation.Keep class *
-keepclassmember class * {
@android.support.annotation.Keep *;
}
-keep public class * extends android.view.View{
*** get*();
void set*(***);
public (android.content.Context);
public (android.content.Context, android.util.AttributeSet);
public (android.content.Context, android.util.AttributeSet, int);
}
-keepclasseswithmembers class * {
public (android.content.Context, android.util.AttributeSet);
public (android.content.Context, android.util.AttributeSet, int);
}
-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();
}
-keep class **.R$* {
*;
}
-keepclassmembers class * {
void *(**On*Event);
}
#-------------webview配置------------
-keepclassmembers class fqcn.of.javascript.interface.for.Webview {
public *;
}
-keepclassmembers class * extends android.webkit.WebViewClient {
public void *(android.webkit.WebView, java.lang.String, android.graphics.Bitmap);
public boolean *(android.webkit.WebView, java.lang.String);
}
-keepclassmembers class * extends android.webkit.WebViewClient {
public void *(android.webkit.WebView, jav.lang.String);
}
#++++++++++++++++++++++++++++++二、定制化区域++++++++++++++++++++++++++++++
#--------1.与服务端交互的实体类,不能混淆,应当保留----------
# 事例 :-keep class com.demo.bean.** { *; }
#--------2.第三方包-------------------------------
# 事例
#glide
-keep public class * implements com.bumptech.glide.module.GlideModule
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
**[] $VALUES;
public *;
}
#---------3.与js互相调用的类,不能混淆,应当保留--------
# 事例 : -keepclasseswithmembers class com.demo.login.bean.ui.MainActivity$JSInterface { ; }
#---------4.反射相关的类和方法,不能混淆,应当保留--------