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 {
@JavascriptInterface
public 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的子类，因此保留指令要这么写：
-keepclassmembers
class 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，它有v四、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。在须要保留的类中加上以下语法：
@Keep
@KeepPublicGettersSetters
public 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是混淆文件的名称。