ProGuard 代码混淆

Posted 2020-06-26

简介

Java代码是非常容易反编译的。为了很好的保护Java源代码，我们往往会对编译好的class文件进行混淆处理。

ProGuard是一个混淆代码的开源项目。它的主要作用就是混淆，当然它还能对字节码进行缩减体积、优化等，但那些对于我们来说都算是次要的功能。

引用ProGuard官方的一段话来介绍就是：

       ProGuard is a free Java class file shrinker, optimizer, obfuscator, and preverifier. It detects and removes unused classes, fields, methods, and attributes. It optimizes bytecode and removes unused instructions. It renames the remaining classes, fields, and methods using short meaningless names. Finally, it preverifies the processed code for Java 6 or for Java Micro Edition.

       官网：http://proguard.sourceforge.net/

Java 是一种跨平台的、解释型语言，Java 源代码编译成中间"字节码"存储于 class 文件中。由于跨平台的需要，Java 字节码中包括了很多源代码信息，如变量名、方法名，并且通过这些名称来访问变量和方法，这些符号带有许多语义信息，很容易被反编译成 Java 源代码。为了防止这种现象，我们可以使用 Java 混淆器对 Java 字节码进行混淆。

 

混淆就是对发布出去的程序进行重新组织和处理，使得处理后的代码与处理前代码完成相同的功能，而混淆后的代码很难被反编译，即使反编译成功也很难得出程序的真正语义。被混淆过的程序代码，仍然遵照原来的档案格式和指令集，执行结果也与混淆前一样，只是混淆器将代码中的所有变量、函数、类的名称变为简短的英文字母代号，在缺乏相应的函数名和程序注释的况下，即使被反编译，也将难以阅读。同时混淆是不可逆的，在混淆的过程中一些不影响正常运行的信息将永久丢失，这些信息的丢失使程序变得更加难以理解。

 

混淆器的作用不仅仅是保护代码，它也有精简编译后程序大小的作用。由于以上介绍的缩短变量和函数名以及丢失部分信息的原因， 编译后 jar 文件体积大约能减少25% 。

混淆步骤

而2.3以后，Google将这个工具加入到了SDK的工具集里。具体路径：SDK\tools\proguard。当创建一个新的android工程时，在工程目录的根路径下，会出现一个proguard的配置文件proguard.cfg。我们只需通过简单的配置，就能在我们的elipse工程中直接使用ProGuard。

        

步骤

• 1、在project.properties中的最后添加【proguard.config=proguard.cfg】或【proguard.config=proguard-project.txt】或者使用SDK中的默认文件【 proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt】
          
• 2、不要通过Run As的方式生成APK，而通过 android tools->export signed(unsigned) application package 方式生成apk。

只需这两部操作，Proguard就能自动优化混淆你的代码。  

混淆后生成的文件

如果用eclipse export命令打包，会在/proguard文件夹内生成以下文件：

    

• mapping.txt    表示混淆前后代码的对照表(主要是类名、方法名、变量常量名等的对照表)，这个文件非常重要。
      如果你的代码混淆后会产生bug的话，log提示中是混淆后的代码，希望定位到源代码的话就可以根据mapping.txt反推（例如修复友盟中记录的错误日志时就需要上传此文件）。
      ProGuard会在每次运行时覆盖原来的文件，所以每次发布前请保存 mapping.txt，方便该版本出现问题时调出日志进行排查。mapping.txt 可以根据版本号或是发布时间命名来保存，或放进代码版本控制中。
     如下为部分内容的截图：
          
• dump.txt    描述apk内所有class文件的内部结构。
  
• seeds.txt    列出了没有被混淆的类（被各种 -keep 选项保留的类）和成员变量。
  
• usage.txt    列出了源代码中被删除的在apk中不存在的代码（unused or dead code）。

不能混淆的代码

1、反射用到的类

2、在AndroidManifest中配置的类
3、Jni中调用的类

        如果一些提供给外部的类、方法、变量等名字被改变了，那么程序本身的功能就无法正常实现。Proguard通过proguard.cfg来进行配置哪些东西是可以改名，而哪些是不能改变的。

     Android工程中默认自动生成的proguard.cfg已经针对Android的一般情况进行了配置，它主要保留了在AndroidManifest中配置的类（Activity、Application、Service、BroadcastReceiver、ContentProvider、BackupAgentHelper、Preference和ILicensingService的子类及Framework类）。因为这些子类，都是可能被外部调用的。

        另外，它还保留了含有native方法的类、构造函数从xml构造的类（一般为View的子类）、枚举类型中的values和valueOf静态方法、继承Parcelable的跨进程数据类。

Proguard.cfg文件配置

• -include {filename}    从给定的文件中读取配置参数
  
• -basedirectory {directoryname}    指定基础目录为以后相对的档案名称
  
• -injars {class_path}    指定要处理的应用程序jar,war,ear和目录
  
• -outjars {class_path}    指定处理完后要输出的jar,war,ear和目录的名称
  
• -libraryjars {classpath}    指定要处理的应用程序jar,war,ear和目录所需要的程序库文件
  
• -dontskipnonpubliclibraryclasses    指定不去忽略非公共的库类。
  
• -dontskipnonpubliclibraryclassmembers    指定不去忽略包可见的库类的成员。

保留选项

• -keep {Modifier} {class_specification}    保护指定的类文件和类的成员
  
• -keepclassmembers {modifier} {class_specification}    保护指定类的成员，如果此类受到保护他们会保护的更好
  
• -keepclasseswithmembers {class_specification}    保护指定的类和类的成员，但条件是所有指定的类和类成员是要存在。
  
• -keepnames {class_specification}    保护指定的类和类的成员的名称（如果他们不会压缩步骤中删除）
  
• -keepclassmembernames {class_specification}    保护指定的类的成员的名称（如果他们不会压缩步骤中删除）
  
• -keepclasseswithmembernames {class_specification}    保护指定的类和类的成员的名称，如果所有指定的类成员出席（在压缩步骤之后）
  
• -printseeds {filename}    列出类和类的成员-keep选项的清单，标准输出到给定的文件

压缩

• -dontshrink    不压缩输入的类文件
  
• -printusage {filename}
  
• -whyareyoukeeping {class_specification}    

优化

• -dontoptimize    不优化输入的类文件
  
• -assumenosideeffects {class_specification}    优化时假设指定的方法，没有任何副作用
  
• -allowaccessmodification    优化时允许访问并修改有修饰符的类和类的成员

混淆

• -dontobfuscate    不混淆输入的类文件
  
• -printmapping {filename}
  
• -applymapping {filename}    重用映射增加混淆
  
• -obfuscationdictionary {filename}    使用给定文件中的关键字作为要混淆方法的名称
  
• -overloadaggressively    混淆时应用侵入式重载
  
• -useuniqueclassmembernames    确定统一的混淆类的成员名称来增加混淆
  
• -flattenpackagehierarchy {package_name}    重新包装所有重命名的包并放在给定的单一包中
  
• -repackageclass {package_name}    重新包装所有重命名的类文件中放在给定的单一包中
  
• -dontusemixedcaseclassnames    混淆时不会产生形形色色的类名
  
• -keepattributes {attribute_name,...}    保护给定的可选属性，例如LineNumberTable, LocalVariableTable, SourceFile, Deprecated, Synthetic, Signature, and InnerClasses.
  
• -renamesourcefileattribute {string}    设置源文件中给定的字符串常量

Proguard.cfg文件示例

-ignorewarnings                     # 忽略警告，避免打包时某些警告出现 

-optimizationpasses 5               # 指定代码的压缩级别 

-dontusemixedcaseclassnames         # 是否使用大小写混合 

-dontskipnonpubliclibraryclasses    # 是否混淆第三方jar 

-dontpreverify                      # 混淆时是否做预校验 

-verbose                            # 混淆时是否记录日志 

-dontskipnonpubliclibraryclassmembers  #指定不去忽略包可见的库类的成员。

-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*  # 混淆时所采用的算法  

---

-libraryjars   libs/treecore.jar

-dontwarn android.support.v4.**     //缺省proguard 会检查每一个引用是否正确，但是第三方库里面往往有些不会用到的类，没有正确引用。如果不配置的话，系统就会报错。

-dontwarn android.os.**

---

-keep class android.support.v4.** { *; }         // 保持哪些类不被混淆

-keep class com.baidu.** { *; }

-keep class vi.com.gdi.bgl.android.**{*;}

-keep class android.os.**{*;}

-keep interface android.support.v4.app.** { *; }

-keep public class * extends android.support.v4.**

-keep public class * extends android.app.Fragment

-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 BroadcastReceiver

-keep public class * extends ContentProvider

-keep public class * extends android.support.v4.widget

-keep public class * extends com.sqlcrypt.database

-keep public class * extends com.sqlcrypt.database.sqlite

-keep public class * extends com.treecore.**

-keep public class * extends de.greenrobot.dao.**

---

-keepclasseswithmembernames class * {native <methods>;}//保持 native 方法不被混淆

-keepclasseswithmembers class * { public <init>(Context, AttributeSet);}//保持自定义控件类不被混淆

-keepclasseswithmembers class * { public <init>(Context, AttributeSet, int);}//保持自定义控件类不被混淆

-keepclassmembers class * extends android.app.Activity {public void *(android.view.View);}//保持类成员

-keepclassmembers enum * {public static **[] values();  public static ** valueOf(String);}// 保持枚举 enum 类不被混淆

-keep class * implements android.os.Parcelable { public static final Parcelable$Creator *;}// 保持 Parcelable 不被混淆

-keep class MyClass;  // 保持自己定义的类不被混淆

来自为知笔记(Wiz)