在日常开发中进行打包apk的一些往事,打包测试、打包上传应用商店,这些都避免不了。当然在这过程中,除了签名打包,当然少不了代码的混淆了。代码混淆,说白了就是代码压缩、代码混淆以及资源压缩的优化。依靠 ProGuard,将所有类名、方法名重命名为无意义的简单名称,增加了逆向工程难度。依靠Gradle插件,移除了没有使用的资源,减少了apk大小 。

一、Android Gradle 混淆中的配置

一般,在我们的application moudle中的gradle配置项buildTypes中,例如如下:

<pre class=”hljs java” data-original-code=”” release=”” {=”” release类型”=”” data-snippet-id=”ext.1744a3506a70e65a40398e84a3d3b3d4″ data-snippet-saved=”false” data-codota-status=”done”>

  1. release { //release类型
  2. minifyEnabled false
  3. // 启用混淆
  4. proguardFiles getDefaultProguardFile(‘proguard-android.txt’), ‘proguard-rules.pro’
  5. }

这里minifyEnabled表示启动混淆,一般启动混淆编译速度会比较慢,因此在编译debug版本的时候一般默认不开启。proguard-rules.pro这个表示该module默认的混淆文件,我们可以直接将混淆内容写在这里。另外,这里也要说下**shrinkResources **这个字段,当为true的时候,表示打开资源压缩,编译时会去掉没被使用的资源文件。

修改后的配置代码如下:

  1. buildTypes {//表示构建类型 一般有release debug 两种
  2. debug{
  3. buildConfigField 'String','STATE_TEST','"debug"'//buildConfigField
  4. resValue "string", "test_value", "AGradle_debug"//resValue
  5. }
  6. release { //release类型
  7. minifyEnabled true // 启用混淆
  8. shrinkResources true // 资源压缩
  9. proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
  10. buildConfigField 'String','STATE_TEST','"release"' //buildConfigField
  11. resValue "string", "test_value", "AGradle_release" //resValue
  12. }
  13. }

二、混淆规则举例

这里贴下网上认为比较”通用”的混淆规则如下:

  1. #指定压缩级别
  2. -optimizationpasses 5
  3. #不跳过非公共的库的类成员
  4. -dontskipnonpubliclibraryclassmembers
  5. #混淆时采用的算法
  6. -optimizations !code/simplification/arithmetic,!field/*,!class/merging/*
  7. #把混淆类中的方法名也混淆了
  8. -useuniqueclassmembernames
  9. #优化时允许访问并修改有修饰符的类和类的成员
  10. -allowaccessmodification
  11. #将文件来源重命名为“SourceFile”字符串
  12. -renamesourcefileattribute SourceFile
  13. #保留行号
  14. -keepattributes SourceFile,LineNumberTable
  15. #保持所有实现 Serializable 接口的类成员
  16. -keepclassmembers class * implements java.io.Serializable {
  17. static final long serialVersionUID;
  18. private static final java.io.ObjectStreamField[] serialPersistentFields;
  19. private void writeObject(java.io.ObjectOutputStream);
  20. private void readObject(java.io.ObjectInputStream);
  21. java.lang.Object writeReplace();
  22. java.lang.Object readResolve();
  23. }
  24. #Fragment不需要在AndroidManifest.xml中注册,需要额外保护下
  25. -keep public class * extends android.support.v4.app.Fragment
  26. -keep public class * extends android.app.Fragment
  27. # 保持测试相关的代码
  28. -dontnote junit.framework.**
  29. -dontnote junit.runner.**
  30. -dontwarn android.test.**
  31. -dontwarn android.support.test.**
  32. -dontwarn org.junit.**

“通用”,当然真正实现通用,除了上面的混淆规则,需要根据项目需要添加自定义的混淆规则

例如:

  • 第三方库混淆规则。这个比较常见,直接接入官方说明文档。
  • model实体类,典型在转化json的时候,必须保证model不被混淆,因此需加入–keep public class

JNI中调用的类以及方法不可被混淆

  • WebView中JavaScript调用的接口不混淆
  • AndroidMainfest、四大组件以及Application的子类不混淆
  • Parcelable的子类和Creator静态成员变量不混淆,否则会产生Android.os.BadParcelableException异常
  • Layout布局使用的View构造函数、android:onClick等。

三、混淆结果的检测

在开启混淆后,通过混淆配置打包后,会在目录:

  1. <module>/outputs/mapping/<渠道名>/<编译类型>/..

如图所示:

%title插图%num
gradle.png

下面大概说明下:

  • dump.txt :描述APK文件中所有类的内部结构
  • mapping.txt :提供混淆前后类、方法、类成员等的对照表
  • seeds.txt:列出没有被混淆的类和成员

usage.txt: 列出被移除的代码

我们可以根据 seeds.txt 文件检查未被混淆的类和成员中是否已包含所有期望保留的,再根据 usage.txt 文件查看是否有被误移除的代码。建议读者都试下去查看下,必须有收获~

四、自定义混淆规则

(一) proguard 参数
  • include {filename} 从给定的文件中读取配置参数
  • basedirectory {directoryname} 指定基础目录为以后相对的档案名称
  • injars {class_path} 指定要处理的应用程序jar,war,ear和目录
  • outjars {class_path} 指定处理完后要输出的jar,war,ear和目录的名称
  • libraryjars {classpath} 指定要处理的应用程序jar,war,ear和目录所需要的程序库文件
  • dontskipnonpubliclibraryclasses 指定不去忽略非公共的库类。
  • dontskipnonpubliclibraryclassmembers 不跳过非公共的库的类成员

上面部分参数,日常移动开发的应用混淆中也不是经常使用到的,如果读者想进一步深入了解每个参数实际作用,可以去官网进行查阅,这里笔者不做太多说明哈。

(二)keep 参数
  • keep {Modifier(属性,例如public,以下说明一致)} {class_specification(具体类或者成员的位置,以下说明一致)} 防止类和成员被移除或者被重命名
  • keepclassmembers {modifier} {class_specification} 防止成员被移除或者被重命名
  • keepnames {class_specification} 防止成员被重命名)
  • keepclassmembernames {class_specification} 防止拥有该成员的类和成员被移除或者被重命名
  • keepclasseswithmembernames {class_specification} 防止拥有该成员的类和成员被重命名
(三)混淆的必须知道的一些规则

1、一般规则形式:

  1. [命令] [类] {
  2. [成员]
  3. }

:代表相关指定条件的类,例如

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

成员:代表指定类后符合指定条件的成员变量,例如

  • 匹配所有构造器
  • 匹配所有域
  • 匹配所有方法
  • 通配符*,匹配任意长度字符,但不含包名分隔符(.)
  • 通配符**,匹配任意长度字符,并且包含包名分隔符(.)
  • 通配符***,匹配任意参数类型
  • ,匹配任意长度的任意类型参数。比如void test(…)就能匹配任意 void test(String a) 或者是 void test(int a, String b) 这些方法。
  • 访问修饰符(publicprotectedprivate

举个例子,假如需要将name.huihui.test包下所有继承Activitypublic类及其构造函数都保持住,可以这样写:

  1. -keep public class name.huihui.test.** extends Android.app.Activity {
  2. <init>
  3. }

2、常用自定义混淆规则

  • 不混淆某个类
  1. -keep public class name.huihui.example.Test { *; }
  • 不混淆某个包所有的类
  1. -keep class name.huihui.test.** { *; }
  • 不混淆某个类的子类
  1. -keep public class * extends name.huihui.example.Test { *; }
  • 不混淆所有类名中包含了“model”的类及其成员
  1. -keep public class **.*model*.** {*;}
  • 不混淆某个接口的实现
  1. -keep class * implements name.huihui.example.TestInterface { *; }
  • 不混淆某个类的构造方法
  1. -keepclassmembers class name.huihui.example.Test {
  2. public <init>();
  3. }
  • 不混淆某个类的特定的方法
  1. -keepclassmembers class name.huihui.example.Test {
  2. public void test(java.lang.String);
  3. }

五、自定义资源保持规则

前面说的通过shrinkResources true开启资源压缩后,未被使用的资源默认不会被打包进去。如果开发者是自定义保留指定的资源文件,可以在res/raw/ 路径下创建一个 xml 文件,例如 keep.xml,进行自定义混淆规则。

一般属性有:

  • tools:keep 定义哪些资源需要被保留(资源之间用“,”隔开)
  • tools:discard 定义哪些资源需要被移除(资源之间用“,”隔开)
  • tools:shrinkMode 开启严格模式

例如:

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <resources xmlns:tools="http://schemas.android.com/tools"
  3. tools:keep="@layout/l_used*_c,@layout/l_used_a,@layout/l_used_b*"
  4. tools:discard="@layout/unused2"
  5. tools:shrinkMode="strict"/>