Android利用ProGuard进行代码混淆

简介

由于Android的代码大都是Java代码，所以挺容易被反编译的，好在Android ADT为我们集成了混淆代码的工具，一来可以混淆我们的代码，让程序被反编译后基本看不懂，另外还能起到代码优化的作用。发布项目前，建议打开Android的代码混淆功能。

Android ADT主要通过ProGuard工具来提供代码混淆，网上也有挺多博客文章讲这个的，但感觉很多都介绍得太过于复杂，这里我就以问答的方式来更加简洁地介绍下ProGuard吧。

---

介绍

1. ProGuard是什么

   ProGuard是一个工具，用来混淆和优化Java代码。

   工作方式：移除无效的代码，将代码中的类名、函数名替换为晦涩难懂的名字。

   注意，它只能混淆Java代码，Android工程中Native代码，资源文件（图片、xml），它是无法混淆的。

2. 如何开启ProGuard

   修改Android工程根目录下的project.properties文件，把proguard.config=….这一行前面的注释“#”去掉。这一行指定了系统默认的proguard配置文件，位于Android SDK/tools/proguard目录下。

   如果还有额外的配置，可以添加在 proguard-project.txt 文件中。

3. 需要手动配置内容

   系统默认的配置已经涵盖了大部分的内容，但是如果你的工程中有如下内容，则需要手动添加配置到proguard-project.txt文件中。

   • 只在 AndroidManifest.xml 引用的类

   • 通过JNI回调方式被调用的函数

   • 运行时动态调用的函数或者成员变量

   • 当然，如果你不确定哪些需要手动配置，可以以默认的配置生成程序，当运行中发现ClassNotFoundException异常时，即可找到哪个类不该被混淆

4. 手动配置的规则

   手动添加的配置，一般以“-keep”开头，常用的配置命令分别示例如下：

   假设Android工程中有一个接口和一个类:

   package com.ticktick.example;
   
   public interface TestInterface {
       public void test();
   }
   
   public class Test {
   
       private String mTestString;
       private final int mMinValue;
       private final int mMaxValue;
   
       public Test( int min, int max){
           mMinValue = min;
           mMaxValue = max;
       }
   
       public int getMinValue() {
           return mMinValue;
       }
   
       public int getMaxValue() {
           return mMaxValue;
       }
   
       public void setTestString(String testStr ) {
           mTestString = testStr;
       }
   }
   

   (1) 不混淆某个类的构造函数(例如：不混淆Test类的构造函数)

   -keepclassmembers class
   com.ticktick.example.Test {
       public <init>(int,int);
   }
   

   (2) 不混淆某个包所有的类或指定的类(例如：不混淆package com.ticktick.example下的所有类/接口)

   -keep class com.ticktick.example.** { * ; }
   // 不混淆Test类
   -keep class com.ticktick.example.Test { * ; }

   (3) 不混淆某个类的特定的函数

   -keepclassmembers class com.ticktick.example.Test {
       // 不混淆com.ticktick.example.Test类的setTestString函数
       public void setTestString(java.lang.String);
   }
   

   (4) 不混淆某个类的子类，某个接口的实现

   // 不混淆com.ticktick.example.Test类的子类
   -keep public class * extends com.ticktick.example.Test
   // 不混淆TestInterface的实现
   -keep class * implementscom.ticktick.example.TestInterface {
       public static final com.ticktick.example.TestInterface$Creator *;
   }

   (5) 添加第三方依赖包

   -libraryjars
   libs/android-support-v4.jar
   -dontwarn
   android.support.v4.**{*;}
   -keep class android.support.v4.**{*;}
   -keep interface android.support.v4.**{*;}

   注意： 需要添加dontwarn，因为默认情况下proguard会检查每一个引用是否正确，但是第三方库里往往有些不会用到的类，没有正确引用，所以如果不配置的话，系统会报错。

5. 混淆后的调试信息解析

   代码混淆之后，输出的Log信息也会带有混淆内容，比如函数名和类名会被替换为晦涩难懂的名字，而与代码中的不一致。

   因此，ProGuard工具还提供了恢复混淆内容的工具和文件。

   当你开启了ProGuard混淆后，每次生成release版的apk时，Andriod工程的根目录下会对应生成一个proguard文件夹，该文件夹下的mapping.txt文件记录了混淆后的名字与混淆前的名字的对应关系，通过该文件，我们反向得到恢复后的Log信息。

   假设Log文件名为log.txt，则恢复混淆的命令为：$retrace.sh -verbose mapping.txt log.txt

   注1：retrace.sh命令位于 /tools/proguard/目录下
   注2：你需要保存每一个release版本的mapping.txt，因为每一次release的混淆结果和映射关系都不一样。

6. 混淆后的调试信息解析(工具篇)

   到sdk/tools/proguard/bin目录下：

   

   双击打开proguardgui.bat文件：

   

   （3出是被混淆了的代码片段，com.fy.test.a.a(Unknow Source)）

   Unknow Souce的解决方法：

   -keepattributes SourceFile,LineNumberTable

7. ProGuard的常用语法

   -libraryjars class_path 应用的依赖包，如android-support-v4
   
   -keep [,modifier,...] class_specification 不混淆某些类
   
   -keepclassmembers [,modifier,...] class_specification 不混淆类的成员
   
   -keepclasseswithmembers [,modifier,...] class_specification 不混淆类及其成员
   
   -keepnames class_specification 不混淆类及其成员名
   
   -keepclassmembernames class_specification 不混淆类的成员名
   
   -keepclasseswithmembernames class_specification 不混淆类及其成员名
   
   -dontwarn [class_filter] 不提示warnning
   
   -assumenosideeffects class_specification 假设调用不产生任何影响，在proguard代码优化时会将该调用remove掉。如system.out.println和Log.v等等