Android 使用 ProGuard 进行代码混淆和优化

1. 什么是 ProGuard?

ProGuard 是一个压缩、优化和混淆 Java 字节码文件的免费的工具,它可以删除无用的类、字段、方法和属性。可以删除没用的注释,最大限度地优化字节码文件。它还可以使用简短的无意义的名称来重命名已经存在的类、字段、方法和属性。常常用于 Android 开发用于混淆最终的项目,增加项目被反编译的难度。

2. 为什么要压缩?

Java 源代码(.java文件)通常被编译为字节码(.class文件)。而完整的程序或程序库通常被压缩和发布成 Java 文档(.jar文件)。字节码比 Java 源文件更简洁,但是它仍然包含大量的无用代码,尤其它是一个程序库的时候。ProGuard 的压缩程序操作能分析字节码,并删除无用的类、字段和方法。程序只保留功能上的等价,包括异常堆栈描述所需要的信息。

3. 为什么要混淆?

通常情况下,编译后的字节码仍然包含了大量的调试信息:源文件名,行号,字段名,方法名,参数名,变量名等等。这些信息使得它很容易被反编译和通过逆向工程获得完整的程序。

不过像 ProGuard 这样的混淆器就能删除这些调试信息,并用无意义的字符序列来替换所有名字,使得它很难进行逆向工程,它进一步地精简代码。除了异常堆栈信息所需要的类名,方法名和行号外,程序只会保留功能上的等价。

PrgGuard 环境配置和使用

运行 PrgGuard 需要以下依赖:

  • proguard.jar 或者 proguardgui.jar。proguardgui 提供了一个简单的配置界面(如下图),可以在上面进行配置,而 progua.jar 则是使用配置文件进行处理
  • Java运行环境

如何运行 ProGuard

ProGuard 可以通过命令行调用,如:

  • java -jar proguardgui.jar:启动图形化配置界面
  • java -jar proguard.jar @config.file –options …:通过配置文件进行 ProGuard 处理

执行成功后,用 jd-gui 打开处理后的 jar文件:

可以发现,类已经被混淆处理了。

4. ProGuard 工作原理

ProGuard 由 shrink、optimize、obfuscate 和 preveirfy 四个步骤组成,每个步骤都是可选的,我们可以通过配置脚本来决定执行其中的哪几个步骤。

  • 压缩(Shrink):检测并移除代码中无用的类、字段、方法和特性(Attribute);

  • 优化(Optimize):对字节码进行优化,移除无用的指令;

  • 混淆(Obfuscate):使用 a,b,c,d 这样简短而无意义的名称,对类、字段和方法进行重命名;

  • 预检(Preveirfy):在 Java 平台上对处理后的代码进行预检,确保加载的 class 文件是可执行的。

混淆就是移除没有用到的代码,然后对代码里面的类、变量、方法重命名为对人来说可读性很差的简短名字。

那么有一个问题,

ProGuard 怎么知道这个代码没有被用到呢?

这里引入一个 Entry Point(入口点)概念。

Entry Point 是在 ProGuard 工作过程中不会被处理的类或方法。在压缩的步骤中,ProGuard 会从上述的 Entry Point 开始递归遍历,搜索哪些类和类的成员在使用,对于没有被使用的类和类的成员,就会在压缩时丢弃,在接下来的优化过程中,那些非 Entry Point 的类、方法都会被设置为 private、static 或 final,不使用的参数会被移除,此外,有些方法会被标记为内联的,在混淆的步骤中,ProGuard 会对非 Entry Point 的类和方法进行重命名。

那么这个 Enter Point(入口点)怎么确定呢?

就是从 ProGuard 的配置文件中确定,只要在配置文件中配置了,那么就不会被移除。

5. 如何编写一个 ProGuard 文件呢?

一般来讲有三个过程:

  • 基本混淆
  • 针对 APP 的量身定制
  • 针对第三方 jar 包的解决方案

5.1 基本混淆

混淆文件的基本配置信息,任何 App 都要使用,可以作为模板使用,具体如下。

5.1.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
 
# 抛出异常时保留代码行号,在异常分析中可以方便定位
-keepattributes SourceFile,LineNumberTable

# 用于告诉ProGuard,不要跳过对非公开类的处理。
默认情况下是跳过的,因为程序中不会引用它们,
有些情况下人们编写的代码与类库中的类在同一个包下,
并且对包中内容加以引用,此时需要加入此条声明。
-dontskipnonpubliclibraryclasses

# 这个是给Microsoft Windows用户的,
因为ProGuard假定使用的操作系统是能区分两个只是大小写不同的文件名,
但是Microsoft Windows不是这样的操作系统,
所以必须为ProGuard指定-dontusemixedcaseclassnames选项
-dontusemixedcaseclassnames

5.1.2 需要保留的东西

# 保留所有的本地native方法不被混淆
-keepclasseswithmembernames class * {
    native <methods>;
}
 
# 保留了继承自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.xxxx.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 <init>(android.content.Context);
    public <init>(android.content.Context, android.util.AttributeSet);
    public <init>(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);
}

5.2 针对APP的量身定制

5.2.1 保留实体类和成员不被混淆

对于实体,保留它们的 set 和 get 方法,对于 boolean 型 get 方法,有人喜欢命名 isxxx 的方式,所以不要遗漏。如下:

# 保留实体类和成员不被混淆
-keep public class com.xxxx.entity.** {
    public void set*(***);
    public *** get*();
    public *** is*();
}

一种好的做法是把所有实体都放在一个包下进行管理,这样只写一次混淆就够了,避免以后在别的包中新增的实体而忘记保留,代码在混淆后因为找不到相应的实体类而崩溃。

5.2.2 内嵌类

内嵌类经常会被混淆,结果在调用的时候为空就崩溃了,最好的解决方法就是把这个内嵌类拿出来,单独成为一个类。如果一定要内置,那么这个类就必须在混淆的时候保留,比如如下:

# 保留内嵌类不被混淆
-keep class com.example.xxx.MainActivity$* { *; }
这个$符号就是用来分割内嵌类与其母体的标志。
5.2.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)
}
5.2.4 对JavaScript的处理
# 保留JS方法不被混淆
-keepclassmembers class com.example.xxx.MainActivity$JSInterface1 {
    <methods>;
}

其中 JSInterface 是 MainActivity 的子类

5.2.5 处理反射

在程序中使用 SomeClass.class.method 这样的静态方法,在 ProGuard 中是在压缩过程中被保留的,那么对于 Class.forName("SomeClass") 呢,SomeClass 不会被压缩过程中移除,它会检查程序中使用的 Class.forName 方法,对参数 SomeClass 法外开恩,不会被移除。但是在混淆过程中,无论是 Class.forName("SomeClass"),还是 SomeClass.class,都不能蒙混过关,SomeClass 这个类名称会被混淆,因此,我们要在 ProGuard.cfg 文件中保留这个类名称。

Class.forName("SomeClass")

SomeClass.class

SomeClass.class.getField("someField")

SomeClass.class.getDeclaredField("someField")

SomeClass.class.getMethod("someMethod", new Class[] {})

SomeClass.class.getMethod("someMethod", new Class[] { A.class })

SomeClass.class.getMethod("someMethod", new Class[] { A.class, B.class })

SomeClass.class.getDeclaredMethod("someMethod", new Class[] {})

SomeClass.class.getDeclaredMethod("someMethod", new Class[] { A.class })

SomeClass.class.getDeclaredMethod("someMethod", new Class[] { A.class, B.class })

AtomicIntegerFieldUpdater.newUpdater(SomeClass.class, "someField")

AtomicLongFieldUpdater.newUpdater(SomeClass.class, "someField")

AtomicReferenceFieldUpdater.newUpdater(SomeClass.class, SomeType.class, "someField")

在混淆的时候,要在项目中搜索一下上述方法,将相应的类或者方法的名称进行保留而不被混淆。

5.2.6 对于自定义 View 的解决方案

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

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

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

5.3.1,针对 android-support-v4.jar 的解决方案
# 针对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
5.3.2 其他的第三方 jar 包的解决方案

这个就取决于第三方包的混淆策略了,一般都有在各自的 SDK 中有关于混淆的说明文字,比如支付宝如下:

# 对alipay的混淆处理
-libraryjars libs/alipaysdk.jar
-dontwarn com.alipay.android.app.**
-keep public class com.alipay.**  { *; }

值得注意的是,不是每个第三方 SDK 都需要 -dontwarn 指令,这取决于混淆时第三方 SDK 是否出现警告,需要的时候再加上。

5.4 其他注意事项

当然在使用 ProGuard 过程中,还有一些注意的事项,如下:

5.4.1 如何确保混淆不会对项目产生影响
  • 测试工作要基于混淆包进行,才能尽早发现问题

  • 每天开发团队的冒烟测试,也要基于混淆包

  • 发版前,重点的功能和模块要额外的测试,包括推送,分享,打赏。

5.4.2 打包时忽略警告

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

5.4.3 对于自定义类库的混淆处理

比如我们引用了一个叫做 AndroidLib 的类库,我们需要对 Lib 也进行混淆,然后在主项目的混淆文件中保留 AndroidLib 中的类和类的成员。

5.4.4 使用 annotation 避免混淆

另一种类或者属性被混淆的方式是,使用annotation,比如这样:

@keep
@keepPublicGetterSetters
public class Bean{
    public  boolean booleanProperty;
    public  int intProperty;
    public  String stringProperty;
}
5.4.5 在项目中指定混淆文件

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

proguard.config=proguard.cfg

其中,proguard.cfg 是混淆文件的名称。

推荐阅读更多精彩内容