文章标题

ProGuard混淆存在的问题
2012-08-29 18:51 3732人阅读 评论(0) 收藏 举报
optimizationjavascriptclassandroidstringmethods

先说点题外的，前一秒我心想干点什么呢，想到写篇博文吧，最近写的频率有点低了。另外标题有点长了。

进正文。

前些日子几次遇到ProGuard的问题，想偷个懒，没好好RTFM,后来通读了一下ProGuard的Manual，有点收获，总结一下。

主要是读了Usage部分，http://proguard.sourceforge.net/#manual/usage.html

命令：java -jar proguard.jar options … 或 java -jar proguard.jar @myconfig.pro(myconfig.pro是配置文件)。Android提供的ant脚本把这个包含了进去，ADT也相应做了处理，所以基本不会直接用到这个。proguard包含在android sdk的tools目录下。

options或者配置文件设定了proguard的参数，分为Input/Output Options，Input/Output Options，Shrinking Options，Optimization Options，Obfuscation Options，Preverification Options，General Options 这些可选的参数。

从配置选项中其实可以看出，proguard有几部分的功能，Shrinking，Optimization，Obfuscation，Preverification。

1. Shrinking

就是缩减代码，他的工作是把代码中没被引用或者依赖的类、类成员删掉。可以通过Keep参数来设定保存。我之前就遇到这么一个问题，这里简称为“寻找getSomething游戏”（这个问题几乎会贯穿全文），我写了这么一段代码，大意如下：

public class JavascriptInterface {
void getSomething(String something) {}
}

webview.addJavascriptObject(new JavascriptInterface(), “jsi”);
webview.loadUrl(“javascript:window.jsi.getSomething(“hello”)”);

就是通过js给java传个值。然后打包运行正常，再然后使用proguard处理打包，结果不正常，提示大意为object没有getSomething方法。

出了什么问题呢，因为android的proguard默认配置是开启Shrinking的，所以结果是getSomething(String)方法被删掉了，我通过反编译打出来的apk包也证实了这一点。

解决方法是，在配置文件中加入keep

-keep public class yourpackagename.JavascriptInterface

对于keep有几个类似的选项，下面的表格抄自：http://proguard.sourceforge.net/#manual/usage.html
Keep From being removed or renamed From being renamed
Classes and class members -keep -keepnames
Class members only -keepclassmembers -keepclassmembernames
Classes and class members, if class members present -keepclasseswithmembers -keepclasseswithmembernames

我就不解释了。

1. Optimization

代码优化，说是bytecode层级的优化，具体怎么优化的我就不知道，而且Android默认配置也没开起这个。

1. Obfuscation

这个就是传说中的混淆了，可以通过-dontobfuscate关闭（关闭为什么还用proguard呢？）什么是混淆呢，就是把类和类成员 （包括变量和函数）的名字替换成相应的随机字符，大大增加别人解包破解你代码的难度。混淆过程生成mapping文件，记录每个类和成员被替换称什么随机字符了，也可以自己提供一些生成随机字符的规则，这里提供了很多选项，很有意思。

前面说道“寻找getSomething游戏”的例子，其实象刚才那样做并没有搞定这个问题，这里一个重要的概念是，单写一行keep并不能让proguard不做成员变量的混淆处理，而只是不被删掉。所以getSomething作为一个类成员方法依然会被混淆，变成了一个随机字符，比如a，那么这句代码：webview.loadUrl(“javascript:window.jsi.getSomething(“hello”)”); 显然不再能正常使用了，因为它已经找不到getSomething了。

过程中我反复解包，由于认为keep就可以防止混淆，觉得无解，因我解包发现每次getSomething都变成了a，所以进行了一种很狗屎的方法的尝试，将webview.loadUrl(“javascript:window.jsi.getSomething(“hello”)”);换成webview.loadUrl(“javascript:window.jsi.a(“hello”)”);，把getSomething直接写成了a。。。但是由于我的实际JavascriptInterface类里面还有一些别的东西，有些东西也会被混淆成a，所以居然连狗屎运都没有。

后来我发现-useuniqueclassmembernames这个参数，顾名思义，可以让类成员使用唯一的名字，于是我给getSomething改成了后来混淆后的唯一的名字，终于在寻找getSomething的游戏中，找到了它，虽然它已经不叫getSomething了。。。

还是觉得这个方法太屎了，胜之不武。

关于keep有个复杂的语法，下面依然抄自ProGuard文档。

[@annotationtype] [[!]public|final|abstract|@ …] [!]interface|class|enum classname
[extends|implements [@annotationtype] classname]
[{
[@annotationtype] [[!]public|private|protected|static|volatile|transient …] |
(fieldtype fieldname);
[@annotationtype] [[!]public|private|protected|static|synchronized|native|abstract|strictfp …] |
(argumenttype,…) |
classname(argumenttype,…) |
(returntype methodname(argumenttype,…));
[@annotationtype] [[!]public|private|protected|static … ] *;
…
}]

。。。

我之前看了这段就跳过了。后来耐心看下还是很容易看懂的，而且这个部分后面有个说明。

这些符号其实很常见了，“|” 表示或关系，“!”表示非，“[]”表示可选，“…”代表等等，黑色的部分是关键字。

之前-keep public class yourpackagename.JavascriptInterface 这样写，注意语法有个花括号，里面是用来说明成员变量是否keep的，可以写一个范围，比如写就是所有字段不被混淆，就是所有方法不被混淆，＊就是所有都不被混淆。还可以单独指出哪个函数不被混淆，比如对于“寻找getSomething游戏”，可以这样写：

-keep public class yourpackagename.JavascriptInterface {
void getSomething(java.lang.String)
}

这样，getSomething函数就不会被混淆了。这里一个值得注意的问题是，所有类都要写全称，就是包名.类名，String要写成java.lang.String，我最开始就只写了String，结果是还别混淆了，郁闷了很久。

好了，“寻找getSomething游戏”完胜了。。。它再也不会找不到getSomething了。

1. Preverification

预验证，在载入类之前的验证，《Android前向兼容的几个问题》里面说的大概是这个，Android的ProGuard配置也没有开启这个，我也不是很清楚，就不说了。

还有很多选项，不在赘述，还是RTFM吧！

转自：http://blog.qhm123.com/2012/04/27/proguard-summary-some-problem-answer.html

user模式下编译android 代码被proguard优化导致类和变量丢失
分类： Google Android 2011-10-10 15:45 2145人阅读 评论(0) 收藏 举报
优化androiduserclassclassloaderjava
在Android项目中用到JNI，当用了proguard后，发现native方法找不到很多变量，原来是被produard优化掉了。所以，在JNI应用中该慎用progurad啊。

解决办法：
1、在Android.mk中加入一行：
LOCAL_PROGUARD_FLAGS := -include $(LOCAL_PATH)/proguard.flags
2、创建proguard.flag文件，里面写入不需要proguard优化的类和方法。例如：

-keep class oms.miracle.mobiletv.broadcast.ServiceContext {
*;
}

我的这个类是和JNI相关的，不想让proguard去优化而引起错误，向上面写就能实现。

———-下面是网上找到的一些proguard的资料，贴出来分享：
ProGuard是一个免费的java类文件压缩,优化,混淆器.它探测并删除没有使用的类,字段,方法和属性.它删除没有用的说明并使用字节码得到最大优化.它使用无意义的名字来重命名类,字段和方法.

ProGuard的使用是为了:

1.创建紧凑的代码文档是为了更快的网络传输,快速装载和更小的内存占用.
2.创建的程序和程序库很难使用反向工程.
3.所以它能删除来自源文件中的没有调用的代码
4.充分利用java6的快速加载的优点来提前检测和返回java6中存在的类文件.

参数：

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

因为我们开发的是webwork+spring+hibernate的架构的项目，所有需要很详细的配置。（经过n次失败后总结）

Example:
-injars .jar
-outjars _out.jar

-libraryjars <java.home>/lib/rt.jar 
-libraryjars <project.home>/webroot/WEB-INF/lib/webwork.jar 
....... 

# 保留实现Action接口类中的公有的，友好的，私有的属性 和 公有的，友好的方法。其它的全部压缩，优化，混淆。 
# 因为配置文件中的类名是一个完整的类名，如果经过处理后就有可能找不到这个类。 
# 属性是jsp页面所需要的，如果经过处理jsp页面就无法得到action中的数据。 
-keep public class * implements com.opensymphony.xwork.Action{ 
    public protected private <fields>; 
    public protected <methods>; 
} 

# 保留实现了Serializable接口类中的公有的，友好的，私有的成员（属性和方法） 
# 这个配置主要是对应实体类的配置。 
-keep public class * implements java.io.Serializable{ 
    public protected private *; 
} 

...... 

我们做java开发的一般都会遇到如何保护我们开发的代码问题。java语言由于是基于jvm上面，所以反编译class 文件很很容易。假如我们做了一个web程序，并把这个web程序发布给客户。实际上，客户是很容易反编译出我们的源代码出来，包括所有的src文件和 jsp文件等等。

那么，如何保护我们的源代码，实际上，应该有几种方法可以使用：1、使用代码混淆器 2、重载应用服务器的classloader

对于第一种方法来说，现在外面有很多开源工具可以使用，个人认为最好用的当属proguard莫属。proguard主要是易用易学。而且提供的功能也挺多。下面是个人一点使用心得

（1）、从网上download proguard工具，proguard工具主要包含是几个jar文件和一些example，下载地址http://proguard.sourceforge.net/

（2）、将里面的几个jar文件添加到类路径下面。当然，也可以不添加，但是下面在做混淆的时候，必须指定classpath，使在做混淆的过程中，能否访问该类

（3）、编写一个配置文件，主要是混淆器的一些参数。比如，下面是一个例子
-injars platform.jar
-outjars platform_out.jar
-libraryjars

Don’t obfuscate. We only need dead code striping.

-dontobfuscate（将该句加个#号注释掉）

好奇的同志还可以继续看看，为什么TARGET_BUILD_VARIANT := user和LOCAL_PROGUARD_ENABLED := full二选一即可，详见build/core/package.mk:

LOCAL_PROGUARD_ENABLED:=$(strip$(LOCAL_PROGUARD_ENABLED))
ifndef LOCAL_PROGUARD_ENABLED
ifneq ($(filter user userdebug,$(TARGET_BUILD_VARIANT)),)

turn on Proguard by default for user & userdebug build

LOCAL_PROGUARD_ENABLED :=full
endif
endif
ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)

the package explicitly request to disable proguard.

LOCAL_PROGUARD_ENABLED :=
endif
proguard_options_file :=
ifneq ($(LOCAL_PROGUARD_ENABLED),custom) ifneq ($(all_resources),)
proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options endif # all_resources endif # !custom LOCAL_PROGUARD_FLAGS :=$(addprefix -include ,$(proguard_options_file))$(LOCAL_PROGUARD_FLAGS)

3，如何书写proguard.flags文件

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

4，实例（SkyvideoPlayer）
-optimizationpasses 3
-dontusemixedcaseclassnames
-dontskipnonpubliclibraryclasses
-verbose
-dontpreverify
-verbose

The support library contains references to newer platform versions.

Don’t warn about those in case this app is linking against an older

platform version. We know about them, and they are safe.

-dontwarn
-optimizations !code/simplification/arithmetic,!field/,!class/merging/

by jiang

-dontoptimize #是否对类内部代码进行优化，默认优化

Don’t obfuscate. We only need dead code striping.

-dontobfuscate #不进行优化

项目使用到的第三方jar包

-libraryjars ../libs/fastjson-1.1.23.jar

removes such information by default, so configure it to keep all of it.

-keepattributes Signature #不优化泛型和反射

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.app.backup.BackupAgentHelper
-keep public class * extends android.preference.Preference
-keep public class com.android.vending.licensing.ILicensingService

for skyworth fastjson

-keep class com.alibaba.fastjson.* { ; }

以下为android默认项

-keepclasseswithmembernames class * {
native ;
}

-keepclasseswithmembernames class * {
public (android.content.Context, android.util.AttributeSet);
}

-keepclasseswithmembernames class * {
public (android.content.Context, android.util.AttributeSet, int);
}

-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}

-keep class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator *;
}

5，错误总结

问题一：使用gson包解析数据时，出现missing type parameter异常
程序中用到了gson的new typeToken，结果打包成apk发布时，发现抛出异常，但不通过打包apk时发现一切正常，百思不得其解，最初怀疑没有将gson-1.7.1.JAR打包进去，后来经过测试发现gson的其他方法经过打包也能正常运行，最后上网找了2天，终于在google gson论坛中找到了解决方法。
第一种：在 proguard.cfg中添加
-dontobfuscate
-dontoptimize

第二种：在 proguard.cfg中添加

removes such information by default, so configure it to keep all of it.

-keepattributes Signature

Gson specific classes

-keep class sun.misc.Unsafe { *; }

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

Application classes that will be serialized/deserialized over Gson

-keep class com.google.gson.examples.android.model.* { ; }
这两种方法都测试可行，第一个方法没有混淆编译，第二个方法能够混淆编译
问题二：
反射类不能进行混淆编译，需加入
-keep class com.test.model.response.* {;}
问题三：
android辅助jar包异常，在proguard.cfg中加入
-dontwarn android.support.v4.**
-keep class android.support.v4.* {;}
问题四：（同1）
类型转换错误，因为我用的泛型，所以在调用某些方法的时候，会出现这种错误，后面在混淆配置文件加了一个过滤泛型的语句，如下。

-keepattributes Signature
过后，就没有出现类似的类型转换错误。

问题五：空指针异常，这个错误是我对比前面的错误来说，所用的时间比较短，开始是找不到方法到底是哪个（原因是上面提到的混淆后方法名相同），所以就把这个类里面的所有方法都过滤掉，这样我没用多少时间，也就找到了具体的方法，可还是不明白原因，后面发现了其中的一个if判断，我利用反射筛选方法，关键字是“get”，突然我就震精了，大叫一声——soga，原来我 model的 set/get方法名全部都被混淆了，所以筛选不到方法，返回的也就是null值，自然下面用到这个方法的返回值就会抛出空指针异常。

解决方法：把 model包下面的所有类，全部过滤掉。

总结：如要用到反射，反射一般就会利用到泛型，所以必须要把泛型的全部过滤掉，如果有根据变量名或者方法名判断的，记得所在的类需过滤掉，之中还有用到 annotation的地方，要加入一行代码，如下：

-keepattributes Annotation
这样就能过滤掉所有的annotation，否则也会抛出空指针异常。

推荐文章,内容都是他们写的，我只是整理了一下，呵呵
http://blog.csdn.net/hehe9737/article/details/8152330

http://charles-tanchao.diandian.com/post/2012-05-24/20118715

http://www.cnitblog.com/zouzheng/archive/2011/01/12/72639.html

http://www.eoeandroid.com/thread-173733-1-1.html