本文主要是介绍Android混淆规则--proguard-rules.pro,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
一、混淆是什么,该怎么做?
如果我们的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 文件的编写了,如图:
刚才是开启混淆,那我们如何关闭,比如关闭压缩,关闭优化呢?
1.总结以下
我们通常说的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); }
好了,大概就这么多。
四、 附件:其它代码
#==================================【基本配置】==================================
# 代码混淆压缩比,在0~7之间,默认为5,一般不下需要修改
-optimizationpasses 5
# 混淆时不使用大小写混合,混淆后的类名为小写
# windows下的同学还是加入这个选项吧(windows大小写不敏感)
-dontusemixedcaseclassnames
# 指定不去忽略非公共的库的类
# 默认跳过,有些情况下编写的代码与类库中的类在同一个包下,并且持有包中内容的引用,此时就需要加入此条声明
-dontskipnonpubliclibraryclasses
# 指定不去忽略非公共的库的类的成员
-dontskipnonpubliclibraryclassmembers
# 不做预检验,preverify是proguard的四个步骤之一
# Android不需要preverify,去掉这一步可以加快混淆速度
-dontpreverify
# 有了verbose这句话,混淆后就会生成映射文件
-verbose
#apk 包内所有 class 的内部结构
-dump class_files.txt
#未混淆的类和成员
-printseeds seeds.txt
#列出从 apk 中删除的代码
-printusage unused.txt
#混淆前后的映射
-printmapping mapping.txt
# 指定混淆时采用的算法,后面的参数是一个过滤器
# 这个过滤器是谷歌推荐的算法,一般不改变
-optimizations !code/simplification/artithmetic,!field/*,!class/merging/*
# 保护代码中的Annotation不被混淆
# 这在JSON实体映射时非常重要,比如fastJson
-keepattributes *Annotation*
# 避免混淆泛型
# 这在JSON实体映射时非常重要,比如fastJson
-keepattributes Signature
# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable
#忽略警告
-ignorewarning
#==================================【项目配置】==================================
# 保留所有的本地native方法不被混淆
-keepclasseswithmembernames class * {native <methods>;
}
# 保留了继承自Activity、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.preference.Preference
-keep public class * extends android.view.View
-keep public class * extends android.database.sqlite.SQLiteOpenHelper{*;}
# 如果有引用android-support-v4.jar包,可以添加下面这行
-keep public class com.null.test.ui.fragment.** {*;}
#如果引用了v4或者v7包
-dontwarn android.support.**
# 保留Activity中的方法参数是view的方法,
# 从而我们在layout里面编写onClick就不会影响
-keepclassmembers class * extends android.app.Activity {public void * (android.view.View);
}
# 枚举类不能被混淆
-keepclassmembers enum * {public static **[] values();public static ** valueOf(java.lang.String);
}
# 保留自定义控件(继承自View)不能被混淆
-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*(***);*** get* ();
}
# 保留Parcelable序列化的类不能被混淆
-keep class * implements android.os.Parcelable{public static final android.os.Parcelable$Creator *;
}
# 保留Serializable 序列化的类不被混淆
-keepclassmembers class * implements java.io.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();
}
# 对R文件下的所有类及其方法,都不能被混淆
-keepclassmembers class **.R$* {*;
}
# 对于带有回调函数onXXEvent的,不能混淆
-keepclassmembers class * {void *(**On*Event);
}
#实体类
-keep class guoxin.app.android.bean.** { *; }
#内部方法
-keepattributes EnclosingMethod
#==================================【三方配置】==================================
#环信混淆--------------------------------------------
-keep class com.easemob.** {*;}
-keep class org.jivesoftware.** {*;}
-keep class org.apache.** {*;}
-dontwarn com.easemob.**
#另外,demo中发送表情的时候使用到反射,需要keep SmileUtils
-keep class com.easemob.chatuidemo.utils.SmileUtils {*;}
#注意前面的包名,如果把这个类复制到自己的项目底下,比如放在com.example.utils底下,应该这么写(实际要去掉#)
#-keep class com.example.utils.SmileUtils {*;}
#如果使用EaseUI库,需要这么写
-keep class com.easemob.easeui.utils.EaseSmileUtils {*;}
#2.0.9后加入语音通话功能,如需使用此功能的API,加入以下keep
-dontwarn ch.imvs.**
-dontwarn org.slf4j.**
-keep class org.ice4j.** {*;}
-keep class net.java.sip.** {*;}
-keep class org.webrtc.voiceengine.** {*;}
-keep class org.bitlet.** {*;}
-keep class org.slf4j.** {*;}
-keep class ch.imvs.** {*;}
-keep class com.hyphenate.** {*;}
-dontwarn com.hyphenate.**
#okhttp
-keep class com.squareup.okhttp.** { *;}
-dontwarn okio.**
-keepclassmembers class **.R$* {public static <fields>;
}
#eventbus
-keepattributes *Annotation*
-keepclassmembers class ** {@org.greenrobot.eventbus.Subscribe <methods>;
}
-keep enum org.greenrobot.eventbus.ThreadMode { *; }
# Only required if you use AsyncExecutor
-keepclassmembers class * extends org.greenrobot.eventbus.util.ThrowableFailureEvent {<init>(java.lang.Throwable);
}
#友盟分享-dontwarn com.google.android.maps.**-dontwarn android.webkit.WebView-dontwarn com.umeng.**-dontwarn com.tencent.weibo.sdk.**-dontwarn com.facebook.**-keep public class javax.**-keep public class android.webkit.**-dontwarn android.support.v4.**-keep class android.support.** {*;}-keep enum com.facebook.**-keepattributes Exceptions,InnerClasses,Signature-keepattributes *Annotation*-keepattributes SourceFile,LineNumberTable-keep public interface com.facebook.**-keep public interface com.tencent.**-keep public interface com.umeng.socialize.**-keep public interface com.umeng.socialize.sensor.**-keep public interface com.umeng.scrshot.**
#视频直播混淆
-dontwarn com.gensee.**
-keep class com.gensee.**{*;}
-dontwarn com.tictactec.ta.**
#fastjson
-dontwarn com.alibaba.fastjson.**
-keep class com.alibaba.fastjson.** { *; }
# fresco
-keep,allowobfuscation @interface com.facebook.common.internal.DoNotStrip
-keep @com.facebook.common.internal.DoNotStrip class *
-keepclassmembers class * {@com.facebook.common.internal.DoNotStrip *;}
-keep class com.facebook.imagepipeline.animated.factory.AnimatedFactoryImpl {public AnimatedFactoryImpl(com.facebook.imagepipeline.bitmaps.PlatformBitmapFactory, com.facebook.imagepipeline.core.ExecutorSupplier);
}
-keep class com.facebook.animated.gif.** {*;}
-dontwarn javax.annotation.**
#保留混淆mapping文件
-printmapping build/outputs/mapping/release/mapping.txt#growingio统计
-keep class com.growingio.android.sdk.** {*;
}
-dontwarn com.growingio.android.sdk.**
-keepnames class * extends android.view.View
-keep class * extends android.app.Fragment {public void setUserVisibleHint(boolean);public void onHiddenChanged(boolean);public void onResume();public void onPause();
}
-keep class android.support.v4.app.Fragment {public void setUserVisibleHint(boolean);public void onHiddenChanged(boolean);public void onResume();public void onPause();
}
-keep class * extends android.support.v4.app.Fragment {public void setUserVisibleHint(boolean);public void onHiddenChanged(boolean);public void onResume();public void onPause();
}
这篇关于Android混淆规则--proguard-rules.pro的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!