android app 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 配置

最经常使用的配置选项

-dontwarn 缺省proguard 会检查每个引用是否正确，可是第三方库里面每每有些不会用到的类，没有正确引用。若是不配置的话，系统就会报错。
-keep 指定的类和类成员被保留做为 入口 。
-keepclassmembers 指定的类成员被保留。
-keepclasseswithmembers 指定的类和类成员被保留，假如指定的类成员存在的话。

proguard 问题和风险

代码混淆后虽然有混淆优化的好处，可是它每每也会带来以下的几点问题

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

2，运行错误，当code 不能混淆的时候，咱们必需要正确配置，不然程序会运行出错，这种状况问题最多。

3，调试苦难，出错了，错误堆栈是混淆后的代码 ，本身也看不懂。

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

常见的不能混淆的android Code

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

其余Anroid 官方建议 不混淆的，如

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

如何实施

如今的系统已经配置为混淆时候会保留

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

        各个开发人员必须检查本身的code 是否用到反射 ，和其余不能混淆的地方。告诉我来修改配置文件（已经保留的就不须要了）

目前系统不检查的第三方库为

-dontwarn android.support.**

proguard 用法

-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} 
-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}    设置源文件中给定的字符串常量

配置实例

-injars  androidtest.jar【jar包所在地址】 
-outjars  out【输出地址】
-libraryjars    'D:\android-sdk-windows\platforms\android-9\android.jar' 【引用的库的jar，用于解析injars所指定的jar类】
-optimizationpasses 5
-dontusemixedcaseclassnames 【混淆时不会产生形形色色的类名 】
-dontskipnonpubliclibraryclasses 【指定不去忽略非公共的库类。 】
-dontpreverify 【不预校验】
-verbose
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/* 【优化】
-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
-keep public abstract interface com.asqw.android.Listener{
public protected <methods>;  【全部方法不进行混淆】
}
-keep public class com.asqw.android{
public void Start(java.lang.String); 【对该方法不进行混淆】
}
-keepclasseswithmembernames class * { 【保护指定的类和类的成员的名称，若是全部指定的类成员出席（在压缩步骤以后）】
native <methods>;
}
-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);
}
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
-keep class * implements android.os.Parcelable {【保护指定的类文件和类的成员】
public static final android.os.Parcelable$Creator *;
}
//不混淆指定包下的类 
-keep class com.aspire.**