Android-ProGuard 混淆

前言

现在写的app 基本都是经过混淆了的,如果不混淆, 发布出去,别人一反编译就可以直接看你的源码了

我现在用的AndroidStudio , 只需要在 build.grade 的配置文件中配置如下即可:

buildTypes {
    debug {
        debuggable "true"
        minifyEnabled "false"
    }
    release {
        debuggable false
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        signingConfig signingConfigs.release
    }
}

proguardFiles getDefaultProguardFile 就是制定混淆规则的文件, AndroidStudio默认生成了proguard-rules.pro 文件

image.png

以上示例代码表示对release版本就行混淆处理。下面我们先来简介下ProGuard的三大作用，并简要说明下它们常用的命令。

ProGuard作用

压缩（Shrinking）：默认开启，用以减小应用体积，移除未被使用的类和成员，并且会在优化动作执行之后再次执行（因为优化后可能会再次暴露一些未被使用的类和成员）。

-dontshrink 关闭压缩

优化（Optimization）：默认开启，在字节码级别执行优化，让应用运行的更快

-dontoptimize  关闭优化
-optimizationpasses n 表示proguard对代码进行迭代优化的次数，Android一般为5

混淆（Obfuscation）：默认开启，增大反编译难度，类和类成员会被随机命名，除非用keep保护。

-dontobfuscate 关闭混淆

混淆后默认会在工程目录app/build/outputs/mapping/release下生成一个mapping.txt文件，这就是混淆规则，我们可以根据这个文件把混淆后的代码反推回源本的代码，所以这个文件很重要，注意保护好。原则上，代码混淆后越乱越无规律越好，但有些地方我们是要避免混淆的，否则程序运行就会出错，所以就有了下面我们要教大家的，如何让自己的部分代码避免混淆从而防止出错。

混淆 ProGuard常用语法

命令	作用
-keep	防止类和成员被移除或者被重命名
-keepnames	防止类和成员被重命名
-keepclassmembers	防止成员被移除或者被重命名
-keepmembers	防止成员被重命名
-keepclasseswithmembers	防止拥有该成员的---类和成员被移除或者被重命名
-keepclasseswithmembernames	防止拥有该成员的类和成员被重命名
-dontwarn	不提示warnning

Android 不混淆原则:

不混淆的目标：是类名，成员方法名，成员变量名

四大组件： AndroidMainfest中的类不混淆，四大组件和Application的子类和Framework层下所有的类默认不会进行混淆,,自定义的View默认也不会被混淆；所以像网上贴的很多排除自定义View，或四大组件被混淆的规则在Android Studio中是无需加入的；
与服务端的交互：使用GSON、fastjson等框架时，所写的JSON对象类不混淆，否则无法将JSON解析成对应的对象
第三方库：使用第三方开源库或者引用其他第三方的SDK包时，如果有特别要求，也需要在混淆文件中加入对应的混淆规则，可在官网找，没有也可自己定义
Serialble的子类，Parcelable的子类和Creator静态成员变量不混淆，否则会产生android.os.BadParcelableException异常

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

枚举类Enum不混淆：使用enum类型时需要注意避免以下两个方法混淆，因为enum类的特殊性，以下两个方法会被反射调用，见第二条规则。

-keepclassmembers enum * {  
    public static **[] values();  
    public static ** valueOf(java.lang.String);  
}

有用到webView的JS调用也需要保证写的接口方法不混淆
反射用到的类不混淆
JNI方法不混淆
先看看google默认混淆文件: \sdk\tools\proguard\proguard-android.txt

-keepattributes *Annotation*//使用注解需要添加
-keep public class com.google.vending.licensing.ILicensingService
-keep public class com.android.vending.licensing.ILicensingService

# For native methods, see http://proguard.sourceforge.net/manual/examples.html#native
-keepclasseswithmembernames class * {//指定不混淆所有的JNI方法
    native ;
}

# keep setters in Views so that animations can still work.
# see http://proguard.sourceforge.net/manual/examples.html#beans
-keepclassmembers public class * extends android.view.View {//所有View的子类及其子类的get、set方法都不进行混淆,但是子类名会混淆，keepclassmembers 是不混淆类的成员变量
   void set*(***);
   *** get*();
}

# We want to keep methods in Activity that could be used in the XML attribute onClick
-keepclassmembers class * extends android.app.Activity {//不混淆Activity中参数类型为View的所有方法
   public void *(android.view.View);
}

# For enumeration classes, see http://proguard.sourceforge.net/manual/examples.html#enumerations
-keepclassmembers enum * {//不混淆Enum类型的指定方法
    public static **[] values();
    public static ** valueOf(java.lang.String);
}
//不混淆Parcelable和它的子类，还有Creator成员变量
-keep class * implements android.os.Parcelable {
  public static final android.os.Parcelable$Creator *;
}
//不混淆R类里及其所有内部static类中的所有static变量字段
-keepclassmembers class **.R$* {
    public static ;
}

# The support library contains references to newer platform versions.
# Don't warn about those in case this app is linking against an older
# platform version.  We know about them, and they are safe.
-dontwarn android.support.**//不提示兼容库的错误警告

如果加入一些自己的混淆规则只需要在 proguard-rules.pro 中文件加入自己的混淆规则即可

保持元素不参与混淆的规则

[保持命令] [类] {
    [成员] 
}

"类”代表类相关的限定条件，它将最终定位到某些符合该限定条件的类。它的内容可以使用：

具体的类
访问修饰符（public、protected、private）
通配符*，匹配任意长度字符，但不含包名分隔符(.)
通配符**，匹配任意长度字符，并且包含包名分隔符(.)
extends，即可以指定类的基类
implement，匹配实现了某接口的类
$，内部类

"成员”代表类成员相关的限定条件，它将最终定位到某些符合该限定条件的类成员。它的内容可以使用：

匹配所有构造器
匹配所有域
匹配所有方法
通配符*，匹配任意长度字符，但不含包名分隔符(.)
通配符**，匹配任意长度字符，并且包含包名分隔符(.)
通配符***，匹配任意参数类型
"…"，匹配任意长度的任意类型参数。比如void test(…)就能匹配任意 void test(String a) 或者是 void
test(int a, String b) 这些方法。
访问修饰符（public、protected、private）
举个例子，假如需要将name.huihui.test包下所有继承Activity的public类及其构造函数都保持住，可以这样写：

-keep public class name.huihui.test.** extends Android.app.Activity {
    
}

常用的自定义混淆规则

不混淆某个类

-keep public class name.huihui.example.Test { *; }

不混淆某个包所有的类

-keep class name.huihui.test.** { *; }

不混淆某个类的子类

-keep public class * extends name.huihui.example.Test { *; }

不混淆所有类名中包含了“model”的类及其成员

-keep public class **.*model*.** {*;}

不混淆某个接口的实现

-keep class * implements name.huihui.example.TestInterface { *; }

不混淆某个类的特定的方法

-keepclassmembers class name.huihui.example.Test { 
  public void test(java.lang.String); 
}

不混淆某个类的内部类

-keep class name.huihui.example.Test$* {
      *;
}

-keep class cn.hadcn.test.**
-keep class cn.hadcn.test.*

一颗星表示只是保持该包下的类名，而子包下的类名还是会被混淆；
两颗星表示把本包和所含子包下的类名都保持；

用以上方法保持类后，你会发现类名虽然未混淆，但里面的具体方法和变量命名还是变了，这时如果既想保持类名，又想保持里面的内容不被混淆，我们就需要以下方法了

-keep class cn.hadcn.test.* {*;}

表示cn.hadcn.test包下的类(不包括子包，子包在加个)的类名和所有的成员名都不被混淆，{}里的，可以换成指定的成员变量名和方法名

在此基础上，我们也可以使用Java的基本规则来保护特定类不被混淆，比如我们可以用extend，implement等这些Java规则。如下例子就避免所有继承Activity的类被混淆

-keep public class * extends android.app.Activity

如果我们要保留一个类中的内部类不被混淆则需要用$符号，如下例子表示保持ScriptFragment内部类JavaScriptInterface中的所有public内容不被混淆。

-keepclassmembers class cc.ninty.chat.ui.fragment.ScriptFragment$JavaScriptInterface {
   public *;
}

参考链接

https://www.jianshu.com/p/7436a1a32891
http://blog.csdn.net/chen930724/article/details/49687067
http://blog.csdn.net/qq_24671941/article/details/54865282