Android面向面试复习----Proguard混淆技术详解

时间:2022-12-03 04:38:41

Proguard混淆技术详解

1. Proguard是什么?

Proguard是一个压缩、优化和混淆java字节码的免费工具。

它有以下几个作用:

  1. 压缩(Shrink):检测并移除代码中无用的类、字段、方法和属性。
  2. 优化(Optimize):对字节码进行优化,移除无用的指令。
  3. 混淆(Obfuscate):使用a,b,c这样简短无意义的名称,对类、字段和方法进行重命名
  4. 预检(Preveirfy):在java平台上对处理后的代码进行预检,确保加载的class文件是可执行的。

2. Proguard的工作原理?

Proguard由shrink、optimize、obfuscate和preverify四个步骤注册,每个步骤都是可选的,可以通过配置来决定是否启用它。具体流程如下:

Android面向面试复习----Proguard混淆技术详解

混淆就是移除没用的代码,对代码中的类、变量、方法名重命名为可读性比较差的简短的名字。那Proguard是怎么知道哪些代码没有被用到呢?

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

Entry Point就是Proguard文件中的配置不被混淆的那些文件。

3. 如何编写一个Proguard文件?

编写混淆文件三步走:

  1. 基本的混淆
  2. 针对App的量身定制
  3. 针对jar包的混淆逻辑

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

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

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

2. 针对App量身定制的部分

  1. 保留实体类和成员不被混淆
    对于实体,保留它们的set和get方法,对于boolean型get方法,有人喜欢命名isXXX的方式,所以不要遗漏。如下:

    一种好的做法是把所有实体都放在一个包下进行管理,这样只写一次混淆就够了,避免以后在别的包中新增的实体而忘记保留,代码在混淆后因为找不到相应的实体类而崩溃。(使用AS插件创建的实体类,包含static则不需要添加混淆保护

    # 保留实体类和成员不被混淆
    -keep public class com.xxxx.entity.** {
    public void set*(***);
    public *** get*();
    public *** is*();
    }
  2. 内嵌类
    内嵌类经常会被混淆,结果在调用的时候为空就崩溃了,最好的解决方法就是把这个内嵌类拿出来,单独成为一个类。如果一定要内置,那么这个类就必须在混淆的时候保留,比如如下:

    # 保留内嵌类不被混淆
    -keep class com.example.xxx.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处理

    # 保留JS方法不被混淆
    -keepclassmembers class com.example.xxx.MainActivity$JSInterface1 {
    <methods>;
    }
    # 其中JSInterface是MainActivity的子类
  5. 针对反射的类处理

    -keep class 类所在的包.** { *; }
  6. xml中使用的自定义view需要保持不混淆

3. 三方jar的混淆配置

  1. 使用 了support-v4的包

    # 针对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
  2. 其他三方jar的混淆

    使用三方jar给的配置,copy进来即可。

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

4. 其他注意事项

  1. 所有的测试包都要混淆,避免上线前才发现有混淆问题,手忙脚乱

  2. 每次添加和删除jar的同时添加或者移除相关的混淆配置。

  3. ProGuard代码混淆技术详解

  4. 本文是在复习,所以大部分内容都是网上的博文,介意的话请移步原文。