ProGuard 配置使用笔记

1.基本指令

代码混淆压缩比,在0~7之间,默认为5,一般不需要改

-optimizationpasses 5

混淆时不使用大小写混合,混淆后的类名为小写

-dontusemixedcaseclassnames

指定不去忽略非公共的库的类

-dontskipnonpubliclibraryclasses

指定不去忽略非公共的库的类的成员

-dontskipnonpubliclibraryclassmembers

不做预校验, preverify是proguard的4个步骤之一
Android不需要preverify,去掉这一步可加快混淆速度

-dontpreverify

有了verbose这句话,混淆后就会生成映射文件
包含有类名->混淆后类名的映射关系
然后使用printmapping指定映射文件的名称

-verbose-printmapping proguardMapping.txt

指定混淆时采用的算法,后面的参数是一个过滤器
这个过滤器是谷歌推荐的算法,一般不改变

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

保护代码中的Annotation不被混淆
这在JSON实体映射时非常重要,比如 fastJson

-keepattributes Annotation

避免混淆泛型,
这在JSON实体映射时非常重要,比如 fastJson

-keepattributes Signature

//抛出异常时保留代码行号,在第6章异常分析中我们提到过-keepattributes SourceFile,LineNumberTable-dontskipnonpubliclibraryclasses用于告诉ProGuard,不要跳过对非公开类的处理。默认情况下是跳过的,因为程序中不会引用它们,有些情况下人们编写的代码与类库中的类在同一个包下,并且对包中内容加以引用,此时需要加入此条声明。

对于-dontusemixedcaseclassnames,Microsoft Windows用户请注意:默认情况下,ProGuard假定你使用的操作系统能够区分两个只是大小写不同的文件名(比如,A.java和a.java被认为是两个不同的文件)。显然Microsoft Windows不是这样的操作系统(Windows是对文件名是大小写不敏感的)。因此Windows用户必须为ProGurad指定-dontusemixedcaseclassnames选项。如果不这么做并且你的项目中有超过26个类的话,那么ProGuard就会默认混用大小写文件名,而导致class文件相互覆盖。安全起见,从0.9.0版本开始,EclipseME默认为ProGuard设置-dontusemixedcaseclassnames选项。项目中有很多类的UNIX用户可以删除这个选项,这样最终产生的JAR文件的大小可以进一步缩小。

2.需要保留的东西

保留所有的本地native方法不被混淆

-keepclasseswithmembernames class * {native ;}

保留了继承自Activity、Application这些类的子类
因为这些子类都有可能被外部调用
比如说,第一行就保证了所有Activity的子类不要被混淆

-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 * extends android.view.View-keep public class com.android.vending.licensing.ILicensingService

如果有引用android-support-v4.jar包,可以添加下面这行

-keep public class com.tuniu.app.ui.fragment.* {;}

保留在Activity中的方法参数是view的方法,
从而我们在layout里面编写onClick就不会被影响

-keepclassmembers class * extends android.app.Activity {public void *(android.view.View);}

枚举类不能被混淆

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

保留自定义控件(继承自View)不被混淆

-keep public class * extends android.view.View {* get*();void set*(*);public (android.content.Context);public (android.content.Context, android.util.AttributeSet);public (android.content.Context, android.util.AttributeSet, int);}

保留Parcelable序列化的类不被混淆

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

保留Serializable序列化的类不被混淆

-keepclassmembers class * implements java.io.Serializable {static final long serialVersionUID;private static final java.io.ObjectStreamField[] serialPersistentFields;private void writeObject(java.io.ObjectOutputStream);private void readObject(java.io.ObjectInputStream);java.lang.Object writeReplace();java.lang.Object readResolve();}

对于R(资源)下的所有类及其方法,都不能被混淆

-keep class *.R$ {*;}

对于带有回调函数onXXEvent的,不能被混淆

-keepclassmembers class * {void *(**On*Event);}

3.针对App的量身定制

1.保留实体类和成员不被混淆对于实体,要保留它们的set和get方法,对于boolean型get方法,有人喜欢命名为isXXX的方式,所以不要遗漏了。-keep public class com.youndheart.entity.** {public void set*(*);public * get*();public * is*();}一种好的做法是把所有实体都放在一个包下进行管理,这样只写一次混淆就够了。避免以后在别的包中新增的实体而忘记保留,代码在混淆后因为找不到相应的实体类而崩溃。

2.内嵌类内嵌类经常会被混淆,结果在调用的时候为空就崩溃了。最好的解决办法就是把这个内嵌类拿出来,单独成为一个类。如果一定要内置,那么这个类就必须在混淆时进行保留。比如说com.example.youngheart包下面的MainActivity,它有一些内嵌类,以下指令保留MainActivity的所有内嵌类:-keep class com.example.youngheart.MainActivity ∗∗; 这个符号就是用来分割内嵌类与其母体的标志。还记得4.1.2中保留R(资源)下面的所有类及其方法的指令吗?如出一辙:-keep class *.R$ {*;}

3.对WebView的处理如果项目中用到了WebView的复杂操作,请加入以下这两段代码:-keepclassmembers class *extends android.webkit.webViewClient {public void *(android.webkit.WebView,java.lang.String, android.graphics.Bitmap);public boolean *(android.webkit.WebView,java.lang.String);}-keepclassmembers class * extends android.webkit.webViewClient {public void *(android.webkit.webView,java.lang.String);}

4.对JavaScript的处理[注释]App应用要经常与HTML5页面的JavaScript进行交互,如下所示:class JSInteface1 {@JavascriptInterfacepublic void callAndroidMethod(int a, fioat b, String c, boolean d) {if (d) {String strMessage = “-” + (a + 1) + “-” + (b + 1) + “-” + c+ “-” + d;new AlertDialog.Builder(MainActivity.this).setTitle(“title”).setMessage(strMessage).show();}}}这个例子参见第3章中3.4节介绍的App与HTML5之间的交互。我接下来要讨论的是,如何确保这些js要调用的原生方法不被混淆。JSInterface是MainActivity的子类,所以保留指令要这么写:-keepclassmembersclass com.example.youngheart.MainActivity$JSInterface1 {;}请在项目中搜索addJavascriptInterface,我们要对所有使用的地方设置保留指令。

5.处理反射也许有人会问,在程序中使用SomeClass.class.method1这样的静态方法,ProGuard如何处理?答案是,被引用的类,如SomeClass,肯定会在压缩过程中被保留。那么对于Class.forName(“SomeClass”)呢?SomeClass不会在压缩过程中被移除,ProGuard在这点上还是蛮聪明的,它会检查程序中使用的Class.forName方法,对参数SomeClass这样的字符串则法外开恩,不会移除。但是,在混淆过程中,无论是Class.forName(“SomeClass”),还是SomeClass.class,就都不能蒙混过关了。SomeClass这个类的名称会被混淆。因此,我们要在ProGuard.cfg文件中,保留这个类名称。不光是Class.forName(“SomeClass”),以下方法也同样适用:·SomeClass.class.getField(“someField”)·SomeClass.class.getDeclaredField(“someField”)

6.对于自定义View的解决方案但凡是在layout目录下的xml布局文件中配置的自定义View,都不能进行混淆。为此要遍历layout下所有的xml布局文件,找到那些自定义View,然后确认其是否在proguard文件中保留了。另一种查找思路是,在使用我们的自定义View时,前面都必须加上我们自己的包名,例如com.a.b.customeview,我们可以遍历所有layout下的xml布局文件,查找所有匹配com.a.b的标签即可。

4 针对第三方jar包的解决方案

我们在Android项目中不可避免地要使用到很多第三方提供的SDK。一般而言,这些SDK都是经过ProGuard混淆了的。而我们所要做的,是避免这些SDK的类和方法在我们的App中被混淆。

1.针对android-support-v4.jar的解决方案-libraryjars libs/android-support-v4.jar-dontwarn android.support.v4.**-keep class android.support.v4.* { ; }-keep interface android.support.v4.app.* { ; }-keep public class * extends android.support.v4.**-keep public class * extends android.app.Fragment这里介绍一下android-support-v4.jar[注释]。由于我们一直使用eclipse之类的IDE进行Android开发,IDE会自动帮我们把android-support-v4.jar这个jar添加到lib目录下并进行引用,以致很多开发人员搞不清这个jar到底是用来干嘛的。其实这个jar包是google提供的,全称是Android Support Library package,它有v4、v7和v13一共3个版本v4这个包是为了照顾Android 1.6及更高版本而设计的,这个包是使用最广泛的,eclipse新建工程时,都默认带有这个包。而v7和v13这两个版本向下兼容的版本很高,所以用的人不多。android-support-v4.jar这个jar包有不同的版本,所以我们在使用一些第三方jar包时,因为它们也用到了android-support-v4.jar,但是版本不一样,就会在运行期抛出NoClassDef-FoundError异常:相应的解决办法就是将两个android-support-v4.jar都用一个就行了。

2.其他的第三方jar包的解决方案这个就要取决于第三方jar包的混淆策略了。它们会在各自的SDK中有关于混淆的说明文字。比如支付宝,相应的混淆规则是:-libraryjars libs/alipaysdk.jar-dontwarn com.alipay.android.app.**-keep public class com.alipay.* { ; }不胜枚举,为了避免有SDK遗漏没有进行混淆处理,一个好的做法是,打开libs目录,看看有多少个jar包,每个都进行类似的处理。值得注意的是,不是每个第三方SDK都需要-dontwarn指令,这取决于混淆时第三方SDK是否会出现警告。需要的时候再加上。

5 其他注意事项

接下来介绍一些使用ProGuard过程中需要注意的事项。

1.如何确保混淆不会对项目产生影响如果一个Android项目从一开始就进行了混淆工作,那么:·测试工作要基于混淆包进行,才能尽早发现问题。·每天开发团队的冒烟测试,也要基于混淆包进行。·发版前,要额外测试正式版的推送、分享、打点、二维码扫描等功能。

2.打包时忽略警告当在导出时,发现很多could not reference class之类的warning信息,如果确认App在运行中和那些引用没有什么关系的话,可以添加-dontwarn标签,就不会再提示这些warning信息了。如:-dontwarn org.apache.**。不要使用-ignorewarnings语句,它会忽略所有警告,这会有很大的潜在风险。

3.对于自定义类库的混淆处理如果我们编写了一个AndroidLib类库,我们的App应用要引用这个类库。我们努力在做的是,把业务无关的逻辑抽离到AndroidLib类库中,而在App应用中只关心业务逻辑。我们需要对Lib也进行混淆,然后在主项目的混淆文件中保留AndroidLib中的类和类的成员。

4.使用annotation避免混淆另一种避免类或者属性被混淆的方式是,使用annotation。在需要保留的类中加上如下语法:@aliyunzixun@xxx.com class Bean {public boolean booleanProperty;public int intProperty;public String stringProperty;public boolean isBooleanProperty() {return booleanProperty;}}这种使用方式多出现在fastJSON的使用上。

6.在项目中指定混淆文件

说到最后,发现没有介绍如何在项目中指定混淆文件。在项目中有一个project.properties文件,在其中写这么一句话,就可以确保每次手动打包生成的apk是混淆过的:proguard.config = proguard.cfg其中,proguard.cfg是混淆文件的名称。