Android ProGuard 代码混淆

释放双眼,带上耳机,听听看~!

proguard 原理

Java代码编译成二进制class 文件,这个class 文件也可以反编译成源代码 ,除了注释外,原来的code 基本都可以看到。为了防止重要code 被泄露,我们往往需要混淆(Obfuscation code , 也就是把方法,字段,包和类这些java 元素的名称改成无意义的名称,这样代码结构没有变化,还可以运行,但是想弄懂代码的架构却很难。 proguard 就是这样的混淆工具,它可以分析一组class 的结构,根据用户的配置,然后把这些class 文件的可以混淆java 元素名混淆掉。在分析class 的同时,他还有其他两个功能,删除无效代码(Shrinking 收缩),和代码进行优化(Optimization Options)。

缺省情况下,proguard 会混淆所有代码,但是下面几种情况是不能改变java 元素的名称,否则就会这样就会导致程序出错。

  • 一, 我们用到反射的地方,最好不要混淆或者指定部分方法不被混淆。
  • 二,我们代码依赖于系统的接口,比如被系统代码调用的回调方法,这种情况最复杂。
  • 三, 是我们的java 元素名称是在配置文件中配置好的。

所以使用proguard时,我们需要有个配置文件告诉proguard 那些java 元素是不能混淆的。

proguard 配置

2.1.最常用的配置选项

-dontwarn 缺省proguard 会检查每一个引用是否正确,但是第三方库里面往往有些不会用到的类,没有正确引用。如果不配置的话,系统就会报错。

-keep 指定的类和类成员被保留作为 入口。

-keepclassmembers 指定的类成员被保留。

-keepclasseswithmembers 指定的类和类成员被保留,假如指定的类成员存在的话。

 

2.2.proguard 问题和风险

代码混淆后虽然有混淆优化的好处,但是它往往也会带来如下的几点问题

1,混淆错误,用到第三方库的时候,必须告诉 proguard 不要检查,否则proguard 会报错。

2,运行错误,当code 不能混淆的时候,我们必须要正确配置,否则程序会运行出错,这种情况问题最多。

3,调试苦难,出错了,错误堆栈是混淆后的代码,自己也看不懂。

 

为了防止混淆出问题,你需要熟悉你所有的code ,系统的架构,以及系统和你code的集成的接口,并细心分析。 同时你必须需要一轮全面的测试。 所以混淆也还是有一定风险的。为了避免风险,你可以只是混淆部分关键的代码,但是这样你的混淆的效果也会有所降低。

 

2.3 常见的不能混淆的androidCode

  • Android 程序,下面这样代码混淆的时候要注意保留。
  • Android系统组件,系统组件有固定的方法被系统调用。
  • 被Android Resource 文件引用到的。名字已经固定,也不能混淆,比如自定义的View 。
  • Android Parcelable ,需要使用android 序列化的,当然也包括Seriliazable。

其他Anroid 官方建议不混淆的,如

  • android.app.backup.BackupAgentHelper
  • android.preference.Preference
  • com.android.vending.licensing.ILicensingService
  • Java序列化方法,系统序列化需要固定的方法。
  • 枚举 ,系统需要处理枚举的固定方法。
  • 本地方法,不能修改本地方法名
  • annotations 注释
  • 数据库驱动
  • 有些resource 文件
  • 用到反射的地方

2.2 现在的系统已经配置为混淆时候会保留

  • Android系统组件
  • 自定义View
  • Android Parcelable
  • Android R 文件
  • 枚举

各个开发人员必须检查自己的code 是否用到反射,和其他不能混淆的地方。告诉我来修改配置文件(已经保留的就不需要了)

实战

#指定代码的压缩级别  
-optimizationpasses 5  
#包明不混合大小写  
-dontusemixedcaseclassnames  
#不去忽略非公共的库类  
-dontskipnonpubliclibraryclasses  
 #优化  不优化输入的类文件  
-dontoptimize  
 #预校验  
-dontpreverify  
 # 混淆时所采用的算法  
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*  
#保护注解  
-keepattributes *Annotation*  
  
  
# 保持哪些类不被混淆  
-keep public class * extends android.app.Fragment  
-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 com.android.vending.licensing.ILicensingService  
#如果有引用v4包可以添加下面这行  
#-keep public class * extends android.support.v4.app.Fragment  
-keep public class * extends android.support.** { *; }  
#如果引用了v4或者v7包  
-dontwarn android.support.*  
#忽略警告  
-ignorewarning  
  
  
#####################记录生成的日志数据,gradle build时在本项目根目录输出################  
 #混淆时是否记录日志  
-verbose  
#apk 包内所有 class 的内部结构  
-dump class_files.txt  
#未混淆的类和成员  
-printseeds seeds.txt  
#列出从 apk 中删除的代码  
-printusage unused.txt  
#混淆前后的映射  
-printmapping mapping.txt  
  
  
#####################记录生成的日志数据,gradle build时 在本项目根目录输出-end################  
  
  
#####混淆保护自己项目的部分代码以及引用的第三方jar包library - start #######  
  
  
#如果不想混淆 keep 掉  保留一个完整的包  
#-keep class com.lippi.recorder.iirfilterdesigner.** {*; }  
#项目特殊处理代码  
#忽略警告  
#-dontwarn com.lippi.recorder.utils**  
  
  
#如果用用到Gson解析包的,直接添加下面这几行就能成功混淆,不然会报错。  
#//原因分析,可能是高版本的 sdk 通过 proguard 混淆代码时默认已经将 lib目录中的 jar 都已经添加到打包脚本中,所以不需要再次手动添加  
# 混淆jar  
#-libraryjars libs/gson-2.2.4.jar  
# 混淆类  
#-keep class sun.misc.Unsafe { *; }  
# 混淆包  
#-keep class com.google.gson.examples.android.model.** { *; }  
#dialog  
-keep class me.drakeet.materialdialog.** { *; }  
#加载框  
-keep class com.kaopiz.kprogresshud.** { *; }  
#下拉刷新  
-keep class in.srain.cube.views.ptr.** { *; }  
#实体类不混淆  
  
  
-keep class com.ousrslook.shimao.commen.ioc.** { *; } #不能混淆 否则注解无效  
-keep class com.ousrslook.shimao.model.** { *; } #不能混淆  
-keep class com.ousrslook.shimao.net.XaResult{ *; }#统一返回的实体类泛型不能混淆  
#-keep class com.ousrslook.shimao.net.** { *; }  
  
  
####混淆保护自己项目的部分代码以及引用的第三方jar包library-end####  
  
  
-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*(...);  
}  
  
  
#保持 native 方法不被混淆  
-keepclasseswithmembernames class * {  
    native <methods>;  
}  
  
  
#保持自定义控件类不被混淆  
-keepclasseswithmembers class * {  
    public <init>(android.content.Context, android.util.AttributeSet);  
}  
  
  
#保持自定义控件类不被混淆  
-keepclassmembers class * extends android.app.Activity {  
   public void *(android.view.View);  
}  
  
  
#保持 Parcelable 不被混淆  
-keep class * implements android.os.Parcelable {  
  public static final android.os.Parcelable$Creator *;  
}  
  
  
#保持 Serializable 不被混淆  
-keepnames class * implements java.io.Serializable  
  
  
#保持 Serializable 不被混淆并且enum 类也不被混淆  
-keepclassmembers class * implements java.io.Serializable {  
    static final long serialVersionUID;  
    private static final java.io.ObjectStreamField[] serialPersistentFields;  
    !static !transient <fields>;  
    !private <fields>;  
    !private <methods>;  
    private void writeObject(java.io.ObjectOutputStream);  
    private void readObject(java.io.ObjectInputStream);  
    java.lang.Object writeReplace();  
    java.lang.Object readResolve();  
}  
  
  
#保持枚举 enum 类不被混淆 如果混淆报错,建议直接使用上面的 -keepclassmembers class * implements java.io.Serializable即可  
-keepclassmembers enum * {  
  public static **[] values();  
  public static ** valueOf(java.lang.String);  
}  
  
  
-keepclassmembers class * {  
    public void *ButtonClicked(android.view.View);  
}  
  
  
#不混淆资源类  
-keepclassmembers class **.R$* {  
    public static <fields>;  
}  
 -keep class **.R$* { *; }  
#避免混淆泛型 如果混淆报错建议关掉  
-keepattributes Signature

参考博客

https://www.jianshu.com/p/d1cbe2fdb82c

http://blog.csdn.net/byhook/article/details/52529617

人已赞赏
Android文章

Android Fragment重复添加问题解决方法

2019-10-26 18:29:55

Android文章

iOS WKWebView Cookie同步

2019-10-27 7:35:07

0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
搜索