Android代码混淆

前言

1.混淆的意义在于增加apk被破解的成本，混淆之后反编译出来的代码都是一些a、b、c可读性比较差，提高安全性。
2.删除无用代码、压缩、优化class文件，缩减apk体积。

android代码混淆分两步走，第一步gradle文件混淆配置，第二步混淆规则的编写。

1.混淆配置

android{
	buildTypes {
        release {
            minifyEnabled true //true代表打开混淆
            shrinkResources true  //true代表打开资源压缩
            zipAlignEnabled true //zipAlign可以让安装包中的资源按4字节对齐，这样可以减少应用在运行时的内存消耗
             // 前一部分代表系统默认的android程序的混淆文件，该文件已经包含了基本的混淆声明，后一个文件是自己的定义混淆文件
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
}

2.混淆规则

1.通用的混淆规则

	-dontusemixedcaseclassnames          #混淆时不使用大小写混合类名
	-dontskipnonpubliclibraryclasses     #不跳过library中的非public的类
	-verbose                             #打印混淆的详细信息
	-dontoptimize                        #不进行优化，建议使用此选项，
	-dontpreverify                       #不进行预校验,Android不需要,可加快混淆速度。
	-ignorewarnings                      #忽略警告
	-optimizationpasses 5               #代码混淆压缩比，在0~7之间，默认为5，一般不做修改
	//-optimizations !code/simplification/arithmetic,!code/simplification/cast,!field/*,!class/merging/*  #混淆时采用的算法
	-renamesourcefileattribute SourceFile # 重命名抛出异常时的文件名称
	-keepattributes SourceFile,LineNumberTable#抛出异常时保留代码行号
	-keepattributes *Annotation*,InnerClasses# 保留Annotation不混淆
	-keepattributes Signature# 避免混淆泛型

2.常用的混淆规则

处理support包

-dontnote android.support.**  #指定不去输出打印该类产生的错误或遗漏
-dontwarn android.support.**  #指定不去warn unresolved references和其他重要的problem

保留继承的

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

保留R下面的资源

-keep class **.R$* {*;}

保留四大组件，自定义的Application等这些类不被混淆

-keep public class * extends android.app.Activity
-keep public class * extends android.app.Appliction
-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.preference.Preference

保留在Activity中的方法参数是view的方法，这样以来我们在layout中写的onClick就不会被影响（为什么？）

 -keepclassmembers class * extends android.app.Activity{
  	public void *(android.view.View);
 }

对于带有回调函数的onXXEvent、**On*Listener的，不能被混淆（为什么？）

-keepclassmembers class * {
   void *(**On*Event);
   void *(**On*Listener);
}

保留本地native方法不被混淆

-keepclasseswithmembernames class * {
    native <methods>;
}

保留枚举类不被混淆（为什么？）

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

保留Parcelable序列化类不被混淆

-keep class * implements android.os.Parcelable {
    public static final android.os.Parcelable$Creator *;
}
-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();
}

3.常见的一些自定义混淆规则

不混淆某个类

-keep public class com.xxx.xxx.ClassName { *; }

不混淆某个包所有的类(package包下有子包也不被混淆)

-keep class com.xxx.package.**{ *; }

不混淆某个类的子类

-keep public class * extends com.xxx.package.ClassName{ *; }

不混淆某个接口的实现

-keep class * implements com.xxx.package.Interface{ *; }

不混淆某个类的构造方法

-keepclassmembers class com.xxx.package.ClassName{
 	public <init>(); 
 }

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

-keepclassmembers class com.xxx.package.ClassName{
 	public void method(java.lang.String); 
 }

不混淆某个类的内部类

-keep class com.xxx.package.ClassName$*{ *; }

不混淆所有类名中包含了“model”的类

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

使用enum类型时需要注意避免以下两个方法混淆

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

4.第三方框架一般都有写好的混淆规则搬过来就可以了

3 .不能混淆的情况总结

• Java的反射，为什么不能混淆呢？因为代码混淆，类名、方法名、属性名都改变了，而反射它还是按照原来的名字去反射，结果程序崩溃
• 注解用了反射，所以不能混淆。
• JNI方法不可混淆，因为这个方法需要和native方法保持一致，否则找不到方法
• AndroidMainfest中的类不混淆，所以四大组件和Application的子类和Framework层下所有的类默认不会进行混淆
• 自定义view也是带了包名写在xml布局中，不能混淆
• 与服务端交互时，使用GSON、fastjson等框架解析服务端数据时，所写的JSON对象类不混淆，否则无法将JSON解析成对应的对象
• Parcelable的子类和Creator静态成员变量不混淆，否则会产生Android.os.BadParcelableException异常
• 使用enum类型时需要注意避免以下两个方法混淆，因为enum类的特殊性，以下两个方法会被反射调用

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

• WebView的JS调用需要保证写的接口方法不混淆，否则找不到方法
• R.java文件不能混淆，混淆之后找不到资源
• 泛型不能混淆，不然会报类型转换错误

4 .检查混淆结果

使用混淆配置打包完成之后会在/build/outputs/mapping/渠道/release/目录下生成一下几个文件

1. mapping.txt 描提供混淆前后类、方法、类成员等的对照表
2. resources.txt
3. seeds.txt 列出没有被混淆的类和成员
4. usage.txt 列出被移除的代码

我们可以根据 seeds.txt 文件检查未被混淆的类和成员中是否已包含所有期望保留的，再根据 usage.txt文件查看是否有被误移除的代码，当然运行测试是少不了的。

5.异常信息反解

1. 在 sdk/tools/proguard/bin/路径下有附带的的反解工具，proguardgui.bat (Windows) 或 proguardgui.sh(Linux和Mac)，点击retrace
2. 或者sdk/tools/proguard/bin/retrace.bat，把文件拷到此目录下，或者加上文件完整路径

   retrace.bat -verbose mapping.txt stacktrace.txt

参考文章

https://blog.csdn.net/Love667767/article/details/84313487
https://www.jianshu.com/p/e9d3c57ab92f?utm_campaign=haruki&utm_content=note&utm_medium=reader_share&utm_source=qq