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的集成的接口,并细心分析。 同一时候你必须须要一轮全面的測试。 所以混淆也还是有一定风险的。 为了避免风险,你能够仅仅是混淆部分关键的代码,可是这样你的混淆的效果也会有所减少。


常见的不能混淆的androidCode

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.**

-dontwarn com.tencent.**

-dontwarn org.dom4j.**

-dontwarn org.slf4j.**

-dontwarn org.http.mutipart.**

-dontwarn org.apache.**

-dontwarn org.apache.log4j.**

-dontwarn org.apache.commons.logging.**

-dontwarn org.apache.commons.codec.binary.**

-dontwarn weibo4android.**

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}    使用给定文件里的keyword作为要混淆方法的名称


-overloadaggressively    混淆时应用侵入式重载


-useuniqueclassmembernames    确定统一的混淆类的成员名称来添加混淆


-flattenpackagehierarchy {package_name}    又一次包装全部重命名的包并放在给定的单一包中


-repackageclass {package_name}    又一次包装全部重命名的类文件里放在给定的单一包中


-dontusemixedcaseclassnames    混淆时不会产生形形色色的类名


-keepattributes {attribute_name,...}    保护给定的可选属性,比如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses.


-renamesourcefileattribute {string}    设置源文件里给定的字符串常量


解决export打包的报错

这个时候export提示“conversion to Dalvik format failed with error 1”错误,网上说法有好多种,最后我还是把proguard从4.4升级到4.8就攻克了。官方地址是​​http://proguard.sourceforge.net​​。上面的配置文件參数能够在这里查阅。

升级办法非常easy,就是把android sdk文件夹下的tool/proguard文件夹覆盖一下就可以。


打包出来的程序怎样调试

一旦打包出来,就不能用eclipse的logcat去看了,这里能够用android sdk中ddms.bat的tool来看,一用就发现和logcat事实上还是一个东西,就是多了个设备的选择。


使用 gson 须要的配置

当Gson用到了泛型就会有报错,这个真给郁闷了半天,提示“Missing type parameter”。最后找到一个资料给了一个解决的方法,參考:​​http://stackoverflow.com/questio ... sing-type-parameter​​。

另外我又用到了JsonObject,提交的Object里面的members竟然被改成了a。所以上面给的东西还不够,还要加上

# 用到自己拼接的JsonObject

-keep class com.google.gson.JsonObject { *; }



个人建议降低这些依赖包混淆带来的麻烦,干脆都所有保留不混淆。比如

-keep class com.badlogic.** { *; }

-keep class * implements com.badlogic.gdx.utils.Json*

-keep class com.google.** { *; }


使用libgdx须要的配置

參考​​http://code.google.com/p/libgdx-users/wiki/Ant​



验证打包效果

利用了apktool的反编译工具,把打包文件又解压了看了一下,假设包路径、类名、变量名、方法名这些变化和你期望一致,那就OK了。命令:



apktool.bat d xxx.apk destdir


配置实例

-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.**