Android代码混淆ProGuard

Android ADT主要通过ProGuard工具来提供代码混淆.

1. ProGuard是什么

ProGuard是一个工具，用来混淆和优化Java代码。
工作方式：移除无效的代码，将代码中的类名、函数名替换为晦涩难懂的名字。
注意:它只能混淆Java代码，Android工程中Native代码，资源文件（图片、xml），它是无法混淆的。

2. 如何开启ProGuard

修改Android工程根目录下的project.properties文件，把proguard.config=....这一行前面的注释“#”去掉。

proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt

系统默认的配置已经涵盖了许多通用的细节，如果你还有额外的配置，可以添加在 proguard-project.txt 文件中。

注意： 只有在生成release版本的apk时，混淆配置才会起作用，debug版本的apk不会进行混淆。

3. 哪些内容需要手动配置

（1） 只在 AndroidManifest.xml 引用的类
（2） 通过JNI回调方式被调用的函数
（3） 运行时动态调用的函数或者成员变量
（4） 当然，如果你不确定哪些需要手动配置，可以以默认的配置生成程序，当运行中发现ClassNotFoundException异常时，即可找到哪个类不该被混淆。

4. 手动配置的规则

EXAMPLE:假设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;
    }
}

不混淆某个类

例如：不混淆Test类：

-keep public class com.ticktick.example.Test

不混淆某个类的构造函数

例如：不混淆Test类的构造函数：

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

不混淆某个包所有的类或指定的类

例如，不混淆package com.ticktick.example下的所有类/接口

-keep class com.ticktick.example.** { * ; }

例如，不混淆com.ticktick.example.Test类

-keep class com.ticktick.example.Test { * ; }

不混淆某个类的特定的函数

例如：不混淆com.ticktick.example.Test类的setTestString函数

-keepclassmembers class
com.ticktick.example.Test {
    public void setTestString(java.lang.String);
}

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

例如：不混淆com.ticktick.example.Test类的子类

-keep public class * extends com.ticktick.example.Test

例如：不混淆com.ticktick.example.TestInterface的实现

-keep class * implementscom.ticktick.example.TestInterface {
    public static final com.ticktick.example.TestInterface$Creator *;
}

添加第三方依赖包

例如：添加android-support-v4.jar依赖包

-libraryjars ./libs/android-support-v4.jar  #声明lib文件
-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. 需要做混淆保护的内容

一般四大组件都会默认不被混淆

-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 com.android.vending.licensing.ILicensingService 

自定义组件的类也要设置为不被混淆，否则找不到控件

方案一、直接保护view的子类，因为自定义控件都是继承view

-keep public class * extends android.app.Dialog
-keep public class * extends android.view

方案二、具体保护某个自定义控件

-keep public class com.viewpagerindicator.TitlePageIndicator

被调用的第三方jar包的类等

如果你使用了第三方的包，你需要使用一下配置，让ProGuard知道库中的一些类并不是在所有的API中可用：

xml-libraryjars   libs/roboguice-2.0.jar 
-dontwarn roboguice.**  

7.需要特别处理的第三方包

• GSON
  (http://google-gson.googlecode.com/svn/trunk/examples/android-proguard-example/proguard.cfg)
• butterknife
• dontwarn butterknife.internal.**
• keep class **$$ViewInjector { *; }
• keepnames class * { @butterknife.InjectView *;}