ProGuard介绍——《App研发录—架构设计,Crash分析和竞品技术分析》

ProGuard介绍

简介

ProGuard一共包括4个功能

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

编写一个ProGuard文件

• 基本混淆

  • 1.基本指令

    # 代码混淆压缩比，在0-7之间，默认为5，一般不需要改
    -optimizationpasses 5
    
    # 混淆时不使用大小写混合，混淆后的类名为小写
    -dontusemixedcaseclassnames
    
    # 指定不去忽略非公共的库的类
    -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，Windows用户必须指定，因为Windows对文件名大小写不敏感，可能对导致class文件相互覆盖
    

  • 2.需要保留的东西

    # 保留所有的本地native方法不被混淆
    -keepclasseswithmembernames class * {
        native <methods>;
    }
    
    # 保留继承自Activity、Application这些类的子类
    # 因为这些子类都有可能被外部调用
    -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 <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);
    }
    

• 针对App的量身定制

  1.保留实体类和成员不被混淆
  对于实体，要保留它们的set和get方法，以及boolean型的get方法

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

  2.内嵌类
  内嵌类经常会被混淆，结果在调用的时候为空就崩溃了，在混淆时必须要进行保留，如保留MainActivity的所有内嵌类：

  -keep class com.yourpackage.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调用的原生方法不被混淆（JSInterface1是MainActivity的子类）

  -keepclassmembers class com.yourpackage.MainActivity$JSInterface1 {
      <methods>;
  }
  

  5.处理反射
  对于Class.forName(“SomeClass”)这样的方法，在混淆过程中，就要保留这个类的名称不被混淆

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

  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
  

  2.其他的第三方jar包的解决方案
  将第三方jar包中有关于混淆的说明添加上去