android:APK混淆中proguard.cfg/proguard-project.text脚本文件的编写知识

一个开发者辛辛苦苦将自己的应用开发出来被别人一反编译轻轻松松便成为了他自己的东西......不混淆很不爽。

  在Android 2.3以前，混淆Android代码只能手动添加proguard来实现代码混淆，非常不方便。而2.3以后，Google已经将这个工具加入到了SDK的工具集里。具体路径：SDK\tools\proguard。当创建一个新的Android工程时，在工程目录的根路径下，会出现一个proguard的配置文件proguard.cfg。也就是说，我们可以通过简单的配置，在我们的elipse工程中直接使用ProGuard混淆Android工程。在工程描述文件project.properties中，添加一句话，启用ProGuard。

  在新版本的ADT创建项目时，混码的文件不再是proguard.cfg，而是project.properties和proguard-project.txt。在工程描述文件project.properties中，把自带的一行代码取消注释，移动到target=android-X 下面(否则会报错)，启用ProGuard。

  这样，Proguard就可以使用了。当我们正常通过android tools到处application package时，Proguard会自动启用，混淆代码。

导出成功后，你可以反编译看看混淆的效果。一些类名、方法名和变量名等，都变成了一些无意义的字母或者数字。证明混淆成功！

ProGuard的常用语法

-libraryjars class_path 应用的依赖包，如 android-support-v4                          

-keep [,modifier,...] class_specification 不混淆某些类                                           

-keepclassmembers [,modifier,...] class_specification 不混淆类的成员               

-keepclasseswithmembers [,modifier,...] class_specification 不混淆类及其成员

-keepnames class_specification 不混淆类及其成员名                                           

-keepclassmembernames class_specification 不混淆类的成员名

-keepclasseswithmembernames class_specification 不混淆类及其成员名             -assumenosideeffects class_specification 假设调用不产生任何影响， 在prog u a-

rd 代码优化时会将该调用remove掉。如system.out.println和Log.v等等

-dontwarn [class_filter] 不提示warnning                                                                 

-dontwarn 表示忽略警告的类。

-keep 表示不需要混淆的类；如：Activity四大组件，混淆后配置文件就无法识别活动类，程序无法正常运行。

更多：

-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}   
-dontwarn   如果有警告也不终止  
-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}    设置源文件中给定的字符串常量  

实例：

-optimizationpasses 5  #指定代码的压缩级别 0 - 5  
-dontusemixedcaseclassnames  #是否使用大小写混合  
-dontskipnonpubliclibraryclasses  #如果应用程序引入的有jar包，并且想混淆jar包里面的class  
-dontpreverify  #混淆时是否做预校验（可去掉加快混淆速度）  
-verbose #混淆时是否记录日志（混淆后生产映射文件 map 类名 -> 转化后类名的映射  
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*  #淆采用的算法  
  
-keep public class * extends android.app.Activity  #所有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 #指定具体类不要去混淆  
  
-keepclasseswithmembernames class * {  
    native <methods>;  #保持 native 的方法不去混淆  
}  
  
-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); #保持指定规则的方法不被混淆（Android layout 布局文件中为控件配置的onClick方法不能混淆）  
}  
  
-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*(...);  
}  
  
-keepclassmembers enum * {  #保持枚举 enum 不被混淆  
    public static **[] values();  
    public static ** valueOf(java.lang.String);  
}  
  
-keep class * implements android.os.Parcelable {  #保持 Parcelable 不被混淆（aidl文件不能去混淆）  
    public static final android.os.Parcelable$Creator *;  
}  
  
-keepnames class * implements java.io.Serializable #需要序列化和反序列化的类不能被混淆（注：Java反射用到的类也不能被混淆）  
  
-keepclassmembers class * implements java.io.Serializable { #保护实现接口Serializable的类中，指定规则的类成员不被混淆  
    static final long serialVersionUID;  
    private static final java.io.ObjectStreamField[] serialPersistentFields;  
    !static !transient <fields>;  
    private void writeObject(java.io.ObjectOutputStream);  
    private void readObject(java.io.ObjectInputStream);  
    java.lang.Object writeReplace();  
    java.lang.Object readResolve();  
}  
  
-keepattributes Signature  #过滤泛型（不写可能会出现类型转换错误，一般情况把这个加上就是了）  
  
-keepattributes *Annotation*  #假如项目中有用到注解，应加入这行配置  
  
-keep class **.R$* { *; }  #保持R文件不被混淆，否则，你的反射是获取不到资源id的  
  
-keep class **.Webview2JsInterface { *; }  #保护WebView对HTML页面的API不被混淆  
-keepclassmembers class * extends android.webkit.WebViewClient {  #如果你的项目中用到了webview的复杂操作 ，最好加入  
     public void *(android.webkit.WebView,java.lang.String,android.graphics.Bitmap);  
     public boolean *(android.webkit.WebView,java.lang.String);  
}  
-keepclassmembers class * extends android.webkit.WebChromeClient {  #如果你的项目中用到了webview的复杂操作 ，最好加入  
     public void *(android.webkit.WebView,java.lang.String);  
}  
#对WebView的简单说明下：经过实战检验,做腾讯QQ登录，如果引用他们提供的jar，若不加防止WebChromeClient混淆的代码，oauth认证无法回调，反编译基代码后可看到他们有用到WebChromeClient，加入此代码即可。  
  
-keepclassmembernames class com.cgv.cn.movie.common.bean.** { *; }  #转换JSON的JavaBean，类成员名称保护，使其不被混淆  
  
##################################################################  
# 下面都是项目中引入的第三方 jar 包。第三方 jar 包中的代码不是我们的目标和关心的对象，故而对此我们全部忽略不进行混淆。  
##################################################################  
-libraryjars  libs/android-support-v4.jar  
-dontwarn android.support.v4.**  
-keep class android.support.v4.** { *; }    
-keep interface android.support.v4.** { *; }  
-keep public class * extends android.support.v4.**   
-keep public class * extends android.app.Fragment  
  
-libraryjars libs/gson-2.3.1-sources.jar  
-libraryjars libs/gson-2.3.1.jar  
-dontwarn com.google.gson.**      
-keep class sun.misc.Unsafe { *; }  
-keep class com.google.gson.** { *; }  
  
-libraryjars libs/alipaySDK-20150602.jar  
-dontwarn com.alipay.**      
-dontwarn com.ta.utdid2.**      
-dontwarn com.ut.device.**      
-keep class com.alipay.** { *; }  
-keep class com.ta.utdid2.** { *; }  
-keep class com.ut.device.** { *; }  
  
-libraryjars libs/android-async-http-1.4.6.jar  
-dontwarn com.loopj.android.http.**  
-keep class com.loopj.android.http.** { *; }  
  
-libraryjars libs/baidumapapi_v2_4_1.jar  
-dontwarn com.baidu.**  
-keep class com.baidu.** {*; }  
-keep class assets.** {*; }  
-keep class vi.com.gdi.bgl.** {*; }  
  
-libraryjars libs/libammsdk.jar  
-dontwarn com.tencent.**  
-keep class com.tencent.** { *; }  
  
-libraryjars libs/locSDK_4.1.jar  
-dontwarn com.baidu.location.**  
-keep class com.baidu.location.** { *; }  
  
-libraryjars libs/mframework.jar  
-dontwarn m.framework.**  
-keep class m.framework.** { *; }  
  
-libraryjars libs/mta-sdk-1.6.2.jar  
-dontwarn com.tencent.stat.**  
-keep class com.tencent.stat.** { *; }  
  
-libraryjars libs/nineoldandroids-library-2.4.0.jar  
-dontwarn com.nineoldandroids.**  
-keep class com.nineoldandroids.** { *; }  
  
-libraryjars libs/open_sdk_r4889.jar  
-dontwarn com.tencent.**  
-keep class com.tencent.** { *; }   
  
-libraryjars libs/ShareSDK-Core-2.5.9.jar  
-dontwarn cn.sharesdk.framework.**  
-keep class cn.sharesdk.framework.** { *; }   
  
-libraryjars libs/ShareSDK-ShortMessage-2.5.9.jar  
-dontwarn cn.sharesdk.system.text.**  
-keep class cn.sharesdk.system.text.** { *; }   
  
-libraryjars libs/ShareSDK-SinaWeibo-2.5.9.jar  
-dontwarn cn.sharesdk.sina.weibo.**  
-keep class cn.sharesdk.sina.weibo.** { *; }   
  
-libraryjars libs/ShareSDK-Wechat-2.5.9.jar  
-dontwarn cn.sharesdk.wechat.friends.**  
-keep class cn.sharesdk.wechat.friends.** { *; }   
  
-libraryjars libs/ShareSDK-Wechat-Core-2.5.9.jar  
-dontwarn cn.sharesdk.wechat.utils.**  
-keep class cn.sharesdk.wechat.utils.** { *; }   
  
-libraryjars libs/ShareSDK-Wechat-Favorite-2.5.9.jar  
-dontwarn cn.sharesdk.wechat.favorite.**  
-keep class cn.sharesdk.wechat.favorite.** { *; }   
  
-libraryjars libs/ShareSDK-Wechat-Moments-2.5.9.jar  
-dontwarn cn.sharesdk.wechat.moments.**  
-keep class cn.sharesdk.wechat.moments.** { *; }   
  
-libraryjars libs/universal-image-loader-1.9.2-SNAPSHOT-with-sources.jar  
-dontwarn com.nostra13.universalimageloader.**  
-keep class com.nostra13.universalimageloader.** { *; }   
  
-libraryjars libs/weibosdkcore.jar  
-dontwarn com.sina.weibo.sdk.**  
-keep class com.sina.weibo.sdk.** { *; }  

关于如何配置忽略第三方jar，附上一个图进行说明。

常见错误：

1) Proguard returned with error code 1. See console
  > 更新proguard版本
  > android-support-v4 不进行混淆
  > 添加缺少相应的库

proguard returned with error code 1.See console

 情况1：

Proguard returned with error code 1. See console 
 Error: C:/Documents (系统找不到指定文件) 
后来发现是因为将整个工程放到了桌面上，而桌面的目录是C:/Documents and Settings/Administrator/桌面，在这里面有空格，而proguard进行发编译的时候是不允许有空格的，如果换了正确路径还不好用的话，直接删除proguard就好了

注意：SDK和程序路径最好不要有空格符

情况2：

Proguard returned with error code 1. See console 
异常：java.lang.ArrayIndexOutOfBoundsException

解决办法：将proguard.cfg中的"-dontpreverify"改成“-dontoptimize”

情况3：

Proguard returned with error code 1. See console

java.io.IOException: Can't read [XXXXXXX.XXX.XXX.jar] (No such file or directory)

抛出这样的异常的原因是第三方jar的引用路径不对，没有找到这个需要忽略混淆的jar包

2) 使用gson包解析数据时，出现 missing type parameter 异常

  > 在 proguard-project.txt 中添加
    -dontobfuscate
    -dontoptimize
  > 在 proguard-project.txt 中添加
    # 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.** { *; }
3) 类型转换错误
  > 在 proguard-project.txt 中添加
    -keepattributes Signature
4) 空指针异常
  > 混淆过滤掉相关类与方法
5) java.lang.reflect.UndeclaredThrowableException
  > -keep interface com.dev.impl.**
6) Error: Unable to access jarfile ..libproguard.jar
  > 路径问题
7) java.lang.NoSuchMethodError
  > 这也是最常见的问题，因为找不到相关方法，方法被混淆了，混淆过滤掉相关方法便可。

参考：http://blog.csdn.net/catoop/article/details/47208833