Android 混淆

一.混淆开启

混淆：是将计算机程序的代码，转换成一种功能上等价，但是难于阅读和理解的形式的行为。加代码混淆意义在于不想开源应用，为了加大反编译的成本，但是并不能彻底防止反编译

在Application主工程的build.gradle文件里面设置

• 开启混淆：minifyEnabled true
• 配置混淆文件：proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'

1. getDefaultProguardFile('proguard-android.txt') 是获取默认的 ProGuard 设置。proguard-android.txt描述了系统提供的基础混淆配置信息，文件所在路径为：...\sdk\tools\proguard\proguard-android.txt。

2.proguard-rules.pro 是我们自定义的混淆规则文件

完整代码如下：

buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }

二.proguard

1.proguard是什么，作用是什么

proguard官网

• Proguard是一个压缩、优化和混淆Java字节码文件的免费的工具
• 它能够检测并删除无用的类,变量,方法和属性
• 它能够优化字节码并删除无用的指令.
• 它能够通过将类名,变量名和方法名重命名为无意义的名称实现混淆效果.
• 最后它还能校验处理后的代码

2.proguard工作流程

proguard工作分为四个步骤

• 压缩（shrink）
  移除未使用的类、方法、字段等
• 优化（optimize）
  优化字节码，简化代码等操作
• 混淆（obfuscate）
  使用简短的，无意义的名称重命名类名，方法名，参数字段等
• 预校验（perverify）
  为class添加预校验消息
  关于proguard

3.proguard关键字

关键字	作用
dontwarn	忽略警告，通过用来忽略library警告
keep	保留类和类中的成员，防止被混淆或移除
keepnames	保留类和类中的成员，防止被混淆，成员没有引用会被移除
keepclassmembers	只保留类中的成员，防止被混淆或移除
keepclassmembernames	只保留类中的成员，防止被混淆，成员没有引用会被移除
keepclasseswithmembers	保留类和类中成员，防止被混淆或移除，保留指明的成员
keepclasseswithmembernames	保留类和类中成员，防止被混淆，保留指明的成员，成员没有引用会被移除

4.proguard通配符

通配符	作用
	匹配类中所有的成员变量
	匹配类中所有的方法
	匹配类中所有的构造函数
*	匹配任意长度字符，不包含包名分隔符(.)
**	匹配任意长度字符，包含包名分隔符(.)
***	匹配任意参数类型
...	匹配任意参数个数，任意参数类型

三.混淆基本规则

#不混淆某个类
-keep public class com.example.test.Test {*;}
#不混淆某个类的子类
-keep public class * extends com.example.test.Test {*;}
#不混淆使用类名中包含了"xxx"的类及其成员
-keep public class **.*xxx*.** {*;}
#不混淆某个接口的实现
-keep class *implements com.example.test.TestInterface {*;}
#不混淆某个类的构造方法
-keepclassmembers class com.example.test.Test {
    public ();
}
#不混淆某个类的特定方法
-keepclassmembers class com.example.test.Test {
    public void test(java.lang.String);
}
#不混淆某个类的内部类
-keep class com.example.test.Test$* {
    *;
}

#不混淆包下的所有类
#一颗星表示只保持该包下的类名，而子包下的类还是会被混淆；
#两颗星表示保持本包和其所包含的所有子包下的类名
#注意下面的方法只是不混淆类名，但是里面具体方法和变量名还是被混淆了
-keep class com.example.test.*
-keep class com.example.test.**

#不混淆包下的所有类（包括类的方法和变量名）
-keep clas com.example.test.** {*;}

四.Android中的不混淆类型

• 自定义控件不参与混淆
• 枚举不参与混淆
• 对第三方类库按照混淆说明，配置混淆规则
• 运用了反射的类不进行混淆
• 使用Gson之类的工具解析的实体类（可以使用@SerializedName注解让实体类也参与混淆）不参与混淆
• WebView 的 JS 调用，接口方法不混淆
• Parcelable 的子类和 Creator 静态成员变量不混淆，否则会产生 Android.os.BadParcelableException 异常
• 使用的四大组件，自定义的Application的子类
• JNI中调用的类
• Layout布局使用的View构造函数（自定义控件）、android:onClick等

五.混淆规则模板

# 指定代码的压缩级别 0 - 7(指定代码进行迭代优化的次数，在Android里面默认是5，这条指令也只有在可以优化时起作用。)
# 使用热修复的App，添加-dontoptimize配置
-optimizationpasses 5
# 混淆时不会产生形形色色的类名(混淆时不使用大小写混合类名)
-dontusemixedcaseclassnames
# 指定不去忽略非公共的库类(不跳过library中的非public的类)
-dontskipnonpubliclibraryclasses
# 指定不去忽略包可见的库类的成员
-dontskipnonpubliclibraryclassmembers
#不进行优化，建议使用此选项，
-dontoptimize
 # 不进行预校验,Android不需要,可加快混淆速度。
-dontpreverify
# 屏蔽警告
-ignorewarnings
# 指定混淆是采用的算法，后面的参数是一个过滤器
# 这个过滤器是谷歌推荐的算法，一般不做更改
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
# 保护代码中的Annotation不被混淆
-keepattributes *Annotation*
# 避免混淆泛型, 这在JSON实体映射时非常重要
-keepattributes Signature
# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable
 #优化时允许访问并修改有修饰符的类和类的成员，这可以提高优化步骤的结果。
# 比如，当内联一个公共的getter方法时，这也可能需要外地公共访问。
# 虽然java二进制规范不需要这个，要不然有的虚拟机处理这些代码会有问题。当有优化和使用-repackageclasses时才适用。
#指示语：不能用这个指令处理库中的代码，因为有的类和类成员没有设计成public ,而在api中可能变成public
-allowaccessmodification
#当有优化和使用-repackageclasses时才适用。
-repackageclasses ''
 # 混淆时记录日志(打印混淆的详细信息)
 # 这句话能够使我们的项目混淆后产生映射文件
 # 包含有类名->混淆后类名的映射关系
-verbose

#
# ----------------------------- 默认保留 -----------------------------
#
#----------------------------------------------------
# 保持哪些类不被混淆
#继承activity,application,service,broadcastReceiver,contentprovider....不进行混淆
-keep public class * extends android.app.Activity
-keep public class * extends android.support.v4.app.FragmentActivity
-keep public class * extends android.app.Application
-keep public class * extends android.support.multidex.MultiDexApplication
-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
#-keep public class * extends android.view.View
-keep class android.support.** {*;}## 保留support下的所有类及其内部类

-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService
#表示不混淆上面声明的类，最后这两个类我们基本也用不上，是接入Google原生的一些服务时使用的。
#----------------------------------------------------

# 保留继承的
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**


#表示不混淆任何包含native方法的类的类名以及native方法名
-keepclasseswithmembernames class * {
    native ;
}


#这个主要是在layout 中写的onclick方法android:onclick="onClick"，不进行混淆
#表示不混淆Activity中参数是View的方法，因为有这样一种用法，在XML中配置android:onClick=”buttonClick”属性，
#当用户点击该按钮时就会调用Activity中的buttonClick(View view)方法，如果这个方法被混淆的话就找不到了
-keepclassmembers class * extends android.app.Activity{
    public void *(android.view.View);
}

#表示不混淆枚举中的values()和valueOf()方法
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

#表示不混淆任何一个View中的setXxx()和getXxx()方法，
#因为属性动画需要有相应的setter和getter的方法实现，混淆了就无法工作了。
# 保留我们自定义控件（继承自View）不被混淆
-keep public class * extends android.view.View{
    *** get*();
    void set*(***);
    public (android.content.Context);
    public (android.content.Context, android.util.AttributeSet);
    public (android.content.Context, android.util.AttributeSet, int);
}
-keepclasseswithmembers class * {
    public (android.content.Context, android.util.AttributeSet);
    public (android.content.Context, android.util.AttributeSet, int);
}

#表示不混淆Parcelable实现类中的CREATOR字段，
#毫无疑问，CREATOR字段是绝对不能改变的，包括大小写都不能变，不然整个Parcelable工作机制都会失败。
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}
# 这指定了继承Serizalizable的类的如下成员不被移除混淆
-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$* {
# *;
#}
#不混淆资源类下static的
-keepclassmembers class **.R$* {
    public static ;
}

# 对于带有回调函数的onXXEvent、**On*Listener的，不能被混淆
-keepclassmembers class * {
    void *(**On*Event);
    void *(**On*Listener);
}

#
#----------------------------- WebView(项目中没有可以忽略) -----------------------------
#
#webView需要进行特殊处理
-keepclassmembers class fqcn.of.javascript.interface.for.Webview {
   public *;
}
-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, jav.lang.String);
}
#在app中与HTML5的JavaScript的交互进行特殊处理
#我们需要确保这些js要调用的原生方法不能够被混淆，于是我们需要做如下处理示例#（根据自己的类修改包名和类名）：
-keepclassmembers class com.example.JSInterface {
    ;
}

#
#---------------------------------实体类---------------------------------
#--------(实体Model不能混淆，否则找不到对应的属性获取不到值)-----
#示例：
#-keep class com.bean.**{*;}
#对含有反射类的处理
#-keep class com.reflect.** { *; }
#
# ----------------------------- 其他的 -----------------------------
#
# 删除代码中Log相关的代码
-assumenosideeffects class android.util.Log {
    public static boolean isLoggable(java.lang.String, int);
    public static int v(...);
    public static int i(...);
    public static int w(...);
    public static int d(...);
    public static int e(...);
}

# 保持测试相关的代码
-dontnote junit.framework.**
-dontnote junit.runner.**
-dontwarn android.test.**
-dontwarn android.support.test.**
-dontwarn org.junit.**


#
# ----------------------------- 第三方 -----------------------------
#
#示例：
-dontwarn com.orhanobut.logger.**
-keep class com.orhanobut.logger.**{*;}
-keep interface com.orhanobut.logger.**{*;}

-dontwarn com.google.gson.**
-keep class com.google.gson.**{*;}
-keep interface com.google.gson.**{*;}

六.mapping文件

构建时Proguard都会输出下列文件:

• dump.txt(说明APK中所有类文件的内部结构)、
• mapping.txt(提供原始与混淆过的类、方法和字段名称之间的转换)
• seeds.txt(列出未进行混淆的类和成员)
• usage.txt(列出从APK移除的代码)
  输出路径：...\app\build\outputs\mapping
  

参考：

Android混淆
Android混淆（ProGuard）从0到1

其他

关于shrinkResources 移除资源的使用（目录四）