Android混淆打包那些事儿

ProGuard简介

在Android中一提起ProGuard，我们就会认为他是用来混淆代码的，殊不知ProGuard一共包括以下4个功能。

• 压缩(Shrink):侦测并移除代码中无用的类、字段、方法、和特性(Attribute)。
• 优化(OPtimize):对字节码进行优化，移除无用指令。
• 混淆(Obfuscate):使用a、b、c、d这样简短而无意义的名称，对类、字段和方法进行重命名。
• 预检(Preveirfy): 在java平台上对处理后的代码进行预检。

提示:如果仅仅是为了代码混淆，ProGuard有一个兄弟产品DexGuard可以试试，地址点击这里。

ProGuard是一个开源项目在SourceForge上进行维护，地址点击这里。

从上述地址下载ProGuard之后，能同时看到官方文档和示例，不过是英文的，目前市面上没有相应的中文翻译版，也没有一片详尽的介绍文章。
　　如果你的项目已经使用了摸个版本的ProGuard，比如，现在市面上最流行的是4.7版本，我建议不要进行升级。一切以稳定为首，如果一定要升级到最新版本，请在使用ProGuard后，对项目的所有模块进行全功能的回归测试。

ProGuard工作原理

ProGuard由shrink、optimize、obfuscate和preverify四个步骤组成，每个步骤都是可选的，需要那些步骤都可以在脚本中配置。流程图如下:

Input jars、Library jars-shrink->Shrunk code-optimize->Optim.code-obfuscate->Obfusc.code-preverify->Output >jars、Library jars

这里我们引入Entry Point的概念。Entry Point实在ProGuard过程中不会被处理的类或方法。再压缩的步骤中，ProGuard或从上述的EntryPoint开始递归遍历，搜索那些类和类成员在使用。对于没有被使用的类和类的成员，就会在压缩阶段丢弃。
　　接下来优化的步骤中，那些非EntryPoint的类、方法都会被设置为private、static或final，不使用的参数会被移除，此外，有些方法会被标记为内联的。在混淆的步骤中，ProGuard会对非EntryPoint的类和方法进行重命名。

如何写一个ProGuard文件

下面介绍ProGuard.cfg混淆文件怎么写。这是一个三步走的过程。

基本混淆

以下是混淆最基本的配置信息，在任何App都要使用，可以作为模板使用，我为每行代码都增加了注释:

1.基本指令

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

# 混淆时不使用大小写混合，混淆后的类名为小写
# windows下的同学还是加入这个选项吧(windows大小写不敏感)
-dontusemixedcaseclassnames

# 指定不去忽略非公共的库的类
# 默认跳过，有些情况下编写的代码与类库中的类在同一个包下，并且持有包中内容的引用，此时就需要加入此条声明
-dontskipnonpubliclibraryclasses

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

# 不做预检验，preverify是proguard的四个步骤之一
# Android不需要preverify，去掉这一步可以加快混淆速度
-dontpreverify

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

# 指定混淆时采用的算法，后面的参数是一个过滤器
# 这个过滤器是谷歌推荐的算法，一般不改变
-optimizations !code/simplification/artithmetic,!field/*,!class/merging/*

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

# 避免混淆泛型
# 这在JSON实体映射时非常重要，比如fastJson
-keepattributes Signature

# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable

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.null.test.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 {
    public (android.content.Context);
    public (android.content.Context, android.util.AttributeSet);
    public (android.content.Context, android.util.AttributeSet, int);
    public void set*(***);
    *** get* ();
}

# 保留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;
   !static !transient ;
   private void writeObject(java.io.ObjectOutputStream);
   private void readObject(java.io.ObjectInputStream);
   java.lang.Object writeReplace();
   java.lang.Object readResolve();
}

# 对R文件下的所有类及其方法，都不能被混淆
-keepclassmembers class **.R$* {
    *；
}

# 对于带有回调函数onXXEvent的，不能混淆
-keepclassmembers class * {
    void *(**On*Event);
}

针对App的量身定制

1.保留实体类和成员不被混淆
　　对于实体，要保留它们的get和set方法，对于boolean型get方法有的命名是isXXX类型，不要遗漏

-keep class com.null.test.entities.** {
    //全部忽略
    *;
}
-keep class com.null.test.entities.** {
    //忽略get和set方法
    public void set*(***);
    public *** get*();
    public *** is*();
}
//以上两种任意一种都行

一个项目中最好把所有的实体都放到同一个包下，这样针对包混淆就行了，避免了实体混淆遗漏而造成的崩溃

2.内嵌类
　　内嵌类经常容易被混淆，结果调用的时候为空就崩溃了。最好的办法就是不用内嵌类(有点扯淡)，如果MainActivity中使用了，就用如下代码

-keep class com.null.test.MainActivity$* {
    *;
}

$这个符号就是用来分割内嵌类与其母体的标志

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的处理

-keepclassmembers class com.null.test.MainActivity$JSInterfacel {
    ;
}

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

一般来说第三方的SDK都是经过ProGuard混淆了的。我们要做的就是避免其再次在我们的App混淆。
1.针对andoid-support-v4.jar的解决方案

-libraryjars ./libs/android-support-v4.jar
-dontwarn android.support.v4.** 
-dontwarn **CompatHoneycomb
-dontwarn **CompatHoneycombMR2
-dontwarn **CompatCreatorHoneycombMR2
-keep interface android.support.v4.app.** { *; }
-keep class android.support.v4.** { *; }
-keep public class * extends android.support.v4.**
-keep public class * extends android.app.Fragment

这里注意一个问题就是，很有可能在我们引用的其他包里面也会依赖v4包，因两个(或者以上)v4的版本是不一样的，在运行期间抛出NoClassDefFoundError异常。相应的解决办法就是都依赖同一个v4包就行了。

2.其他第三方的jar包的解决方案
　　这个要取决第三方jar包的混淆策略了。一般在其官方文档上面都有混淆说明。比如支付宝相应的混淆规则就是:

-libraryjars ./libs/alipaysdk.jar
-dontwarn com.alipay.android.app.** 
-keep public class com.alipay.** {*;}

其他注意事项

1.确保混淆不会对项目造成影响

• 测试要基于混淆包进行
• 冒烟测试也要基于混淆包进行
• 发版本前，要额外测试正式版的推送、分享、打点、二维码扫描等功能

2.打包时忽略警告
　　当在导出时，发现很多could not reference class之类的warning信息，如果确认app运行中和那些引用没有什么关系的话，就可以添加-dontwarn标签，就不会在提示这些warning信息了。如-dontwarn org.apache.**。

3.对于自定义类库的混淆处理
　　对于自定义的类库，我们一般是保留类和类的成员。

4.使用annotation避免混淆

@Keep
@KeepPublicGettersSetters
public class Bean {
    public boolean booleanProperty;
    public int intProperty;
    public String stringProperty;
    public boolean isBooleanProperty() {
        return booleanProperty;
    }
}
//其中@KeepPublicGettersSetters我没找到，大家慎用

5.在项目中制定混淆文件
eclipse是在project.properties文件最后加上proguard.config = proguard.cfg
android studio 是在build.gradle修改buildTypes如下：

buildTypes {
    release {
        minifyEnabled true
        shrinkResources true
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
    }
}