Android混淆

 

Eclipse中的Android项目默认使用Proguard（http://proguard.sourceforge.net/）混淆项目代码文件。

具体使用方法很简单：
1. 在default.properties文件中增加一句proguard.config=proguard.cfg
2. 在proguard.cfg中配置Proguard的参数（如果没有这个文件，在src目录中创建一个即可。）
3. 导出apk文件，即可得到混淆后的文件了。
上面说的使用方法很简单，简单设置即可以使用了。

如果混淆项目以后，发现应用的某些功能无法正常使用了，就要去仔细的找原因，看看为什么混淆后无法使用了，再去配置Proguard的参数文件。

举几个例子。
比如项目中用到了映射，这时就要用到-keep参数，对于映射用到的类保持原状，不让这些类被混淆，否则混淆后就找不到这些类了。
再比如项目中用到了Annotation，这时就要-keepattributes *Annotation*保留Annotation，否则混淆后项目中的某些代码无法使用。

还有一个经验。
Proguard的参数非常复杂，有时候无法有一个很直观的理解。这时可以使用Proguard提供的GUI程序，在GUI界面中配置各个参数后，导出为配置文件。然后以文本的方式打开该文件，即可看到各个参数的写法了。

新建一个 2.3.3的项目，你会看到 项目 文件里 有一个 proguard.cfg 文件？

好吧，伟大的 google 已经帮我们做了这么多事儿了，可惜是从2.3开始的，

那我 悲催的 项目(基于2.2的sdk) 该如何 是好？（非得 残忍的把 项目属性设置为 2.3的么？

其实即使你该了，google 也不会为你把 proguard.cfg文件补上的）

呵呵，其实不用，你只要 把 proguard.cfg 文件 拷贝到 你的 旧项目里就好了，

当然这样还不够，因为 google是默认不混淆项目的

To enable ProGuard so that it runs as

set the proguard.config property in the <project_root>/default.properties file.

The path can be an absolute path or a path relative to the project's root.

google 告诉我们 还要 配置 default.properties

嗯，

把 proguard.config=proguard.cfg 加上

 

 

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

-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。上面的配置文件参数可以在这里查阅。
升级办法很简单，就是把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.**

 

 

1.在default.properties文件中加入下面两句，但是我们的项目是在project.properties中设置的:

target=android-7
 proguard.config=proguard.cfg

2.<!--级别从5修改到7 -->

-optimizationpasses 7
 -dontusemixedcaseclassnames
 -dontskipnonpubliclibraryclasses
 -dontpreverify
 -verbose
 -optimizations !code/simplification/arithmetic,!field/*,!class/merging/*

3.对于使用了注解的类要特别注意，否则混淆后，可能造成功能不可用。
在这个路径下：android-sdk\tools\proguard\examples\annotations 有个例子可以参看，它是这么处理的：
# Preserve all annotations themselves.
-keepattributes *Annotation*

4.混淆中保留了继承自Activity、Service、Application、BroadcastReceiver、ContentProvider等基本组件。
并保留了所有的Native变量名及类名，所有类中部分以设定了固定参数格式的构造函数，枚举等等。(详细信息请参考<proguard_path>/examples中的例子及注释。)

5.有反射之类的java文件不能混淆

6.使用了第三方的jar包，混淆后容易报空指针错误，要特别注意混淆的方式，具体方法见后续。。。

7.使用了android.support.v4.jar包也要特别注意，容易出问题

 

android 混淆配置（这篇总结的不错）
http://www.eoeandroid.com/forum.php?mod=viewthread&tid=209210&fromuid=511991

 dump.txt 32.35 MB  
 mapping.txt 1.41 MB  
 obfuscated.jar 2.28 MB  
 original.jar 2.71 MB 
 seeds.txt 454.81 KB

 

 

 2013-1-8号续：

1.-keep选项

The various -keep options for shrinking and obfuscation may seem a bit confusing at first, but there's actually a pattern behind them. The following table summarizes how they are related:

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

Each of these -keep options is of course followed by a specification of the classes and class members (fields and methods) to which it should be applied.

If you're not sure which option you need, you should probably simply use -keep. It will make sure the specified classes and class members are not removed in the shrinking step, and not renamed in the obfuscation step.

Always remember:

  • Specifying a class without class members only preserves the class as an entry point — any class members may then still be removed, optimized, or obfuscated.
  • Specifying a class member only preserves the class member as an entry point — any associated code may still be optimized and adapted.

 

 来自sdk - D:\android\android-sdk\tools\proguard\docs

<init>matches any constructor.
<fields>matches any field.
<methods>matches any method.
*matches any field or method.

 

Proguard的参数非常复杂，有时候无法有一个很直观的理解。这时可以使用Proguard提供的GUI程序，在GUI界面中配置各个参数后，导出为配置文件。然后以文本的方式打开该文件，即可看到各个参数的写法了。但是百度了下，没看到具体的这个GUI到底怎么使用。知道的朋友可以留言告之，特此感谢。

 

 参考链接：


2.http://huangyuan.iteye.com/blog/1472732