ProGuard技术详解

目录

目录.png

一.简介

ProGuard是一个开源的Java代码混淆器，在Android中一提起ProGuard,我们通常第一想到的是用来混淆代码的，其实它的功能并不仅限于此，有以下四个功能：
（1）压缩(Shrink):侦测并移除代码中无用的类、字段、方法和特性
（2）优化(Optimize):对字节码进行优化，移除无用的指令
（3）混淆(Obfuscate):使用a,b,c,d这样简短而无意义的名称，对类、字段和方法进行重命名
（4）预检(Preverify):在Java平台上对处理后的代码进行预检
总结：
ProGuard是一个Java类文件收缩器，优化器，混淆器和预校验器。 收缩步骤检测并删除未使用的类，字段，方法和属性。 优化步骤分析和优化方法的字节码。 混淆步骤使用短无意义的名称重命名剩余的类，字段和方法。

二.工作原理

ProGuard由Shrink、Optimize、Obfuscate、Preverify四个步骤组成，每个步骤都是可选的，我们可以通过配置脚本决定执行其中的哪几个步骤

proguard工作原理.png

官网上介绍：为了能够确定哪些代码必须被保留以及哪些代码可以被丢弃或模糊处理，就必须指定一个或多个代码入口点。
这个入口点就是Entry Point.Entry Point 是在ProGuard过程中不会被处理的类或方法。在压缩的步骤中，ProGuard会从上述的Entry Point开始递归遍历，搜索哪些类和类的成员在使用。对于没有被使用的类和类的成员，就会在压缩阶段丢弃。在优化阶段，那些非EntryPoint的类、方法都会被设置为private、static或final，不使用的参数会被移除。在混淆的阶段，ProGuard会对非EntryPoint的类和方法进行重命名。

三.如何编写ProGuard文件

3.1 基本混淆

基本混淆是指任何APP都会使用，可以直接拿来做模板使用

3.1.1基本指令

# 代码混淆压缩比，在0和7之间，默认为5，一般不需要改
-optimizationpasses 5
 
# 混淆时不使用大小写混合，混淆后的类名为小写，Windows用户必须指定，否则当你的项目中有超过26个类的
#话，ProGuard就会默认混用大小写文件名，而导致class文件相互覆盖。
-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

3.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);
}

3.2 针对App的量身定制

3.2.1 保留类和成员不被混淆

实体类要保留set 和get方法，boolean 类型的get方法，有的是isXXX方法，不要遗漏了

-keep public class com.xxxx.entity.** {
    public void set*(***);
    public *** get*();
    public *** is*();
}

Tip：最好是把多有的实体都放在一个包下进行管理，这样只写一次混淆就可以了，避免在别的包中新增的实体而忘记保留，如果忘记保留就会因找不到相应的实体类而崩溃。

3.2.2 内嵌类

内嵌类经常被混淆，结果在调用的时候为空就崩溃了。最好是把这个内嵌类拿出来，单独成为一个类。
如果一定要内置，那么这个类就必须在混淆时进行保留，比如com.example.xxx包下的MainActivity,它有一些内嵌类，以下指令保留MainActivity的所有内嵌类：

-keep class com.example.xxx.MainActivity$* { *; }

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

3.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)
}

3.2.4 对JavaScript的处理

-keepclassmembers class com.example.xxx.MainActivity$JSInterface {
    <methods>;
}

其中JSInterface是MainActivity内嵌的js方法类

3.2.5 处理反射

在程序中使用SomeClass.class.method这样的静态方法，SomeClass会在压缩过程中被保留。对于Class.forName("SomeClass") ,SomeClass不会在压缩过程中被移除，ProGuard会检查程序中使用的Class.forName方法，对参数SomeClass这样的字符串不会移除。但是在混淆阶段，无论是Class.forName("SomeClass"),还是SomeClass.class,就都不能蒙混过关了。因此要在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")

在混淆的时候，将项目中以上相应的类或方法的名称进行保留而不被混淆

3.2.6 自定义view

对于在layout目录下的xml布局文件中配置的自定义view,都不能进行混淆，要遍历layout下所有的xml布局文件，找到自定义view,然后确认其是否在proguard文件中保留了。

3.3 针对第三方jar包的解决方法

一般而言，第三方提供的sdk都是经过混淆的了，我们要做的是避免这些sdk的类和方法在我们的app中被混淆。

3.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

3.3.2 其他第三方jar包的解决方案

一般第三方的sdk中有关于混淆的说明文字。如支付宝相关混淆规则：

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

这里不做过多描述，为了避免有SDK遗漏，没有进行混淆处理，一个好的办法是 打开libs目录，看看有多少个jar包，每个都进行类似的处理，需要注意的是，不是每个第三方SDK都需要 -dontwarn指令，这取决于混淆时第三方SDK是否会出现警告，需要的时候再加上。

3.4 其他注意事项

3.4.1 如何确保混淆不会对项目产生影响

如果在项目的一开始就进行了混淆工作，那么
（1）测试工作要基于混淆包进行，才能尽早发现问题
（2）每天开发团队的冒烟测试，也要基于混淆包
（3）发布前，重点的功能和模块要额外的测试，包括推送，分享，打赏

3.4.2 打包时忽略警告

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

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

我们需要对自定义的类库进行混淆，然后在主项目的混淆文件中保留自定义类库中的类和类的成员

3.4.4 使用annotation避免混淆

另一种避免类或者属性被混淆的方式是使用annotation,在需要保留的类上加如下语法：

@keep
@keepPublicGetterSetters
public class Bean{
}

这种方式多出现在fastJSON的使用上。

3.4.5 在项目中指定混淆文件

在项目中有一个project.properties文件，其中有写下面一句话，就可以确保每次手动打包生成的apk是混淆过的：proguard.config = proguard.cfg ，其中proguard.cfg是混淆文件的名称

四.总结

本文介绍了proguard的工作原理，基本设置及其他情况下的设置，有不足之处可以提出来，希望我们一起进步。

头条号申请者 :飞奔的小付