浅析混淆

序言

当应用开启混淆,gradle会提供一个默认的混淆规则模板,但这些规则往往不够,所以我们需
要自定义混淆规则.最近遇到两个项目,都被混淆(debug包没问题,release必现bug,大概
率是混淆的问题)坑了一天,所以整体系统的学习一下混淆知识

混淆的优点和缺点

优点:

• 会将方法名,类名,包名,参数名进行混淆,使用简单字符替代,对于反编译阅读产生一定的困扰,一定程度上的保护了我们的源码
• 打包时,会进行代码压缩,资源压缩,会大大缩减我们的apk包体积,关于代码压缩和资源压缩下面会讨论.问题可能也会出现在这里.

缺点:

• 首先,其实缺点和优点比起来,还是不值一提的,还是建议默认开启混淆.
• 在混淆之后的apk中,我们可能会遇到一些代码之外的错误而导致崩溃或者程序没有按照预期执行,比如native没有keep住,那么在jni调用时,会报NoSuchMethodException,又或者方法如果是反射调用,那么即使我们keep了类,而方法没有被检测到有使用(代码压缩),那么方法在release包中会被优化删除.

混淆基本知识

首先,我们确定一点,混淆不仅仅只有代码名称的混淆,还有代码压缩,资源压缩,和代码优化.

• 代码压缩(如果将 minifyEnabled 属性设为 true，默认情况下会启用 R8 代码压缩。)

也称为“摇树优化”
会检测并安全删除(库)中未使用的api,优点,如果引用一个库,而只使用了少量的api,开启代
码压缩会删除多余未使用api
minifyEnabled true 代表开启代码压缩,默认使用R8压缩代码 如果使用的了大量的库,
而只使用了一小部分代码,会大大减小应用体积
R8会检查应用代码,生成一张引用图,列出可能访问的代码和方法,未检查到的可能会被移除,所
以native方法必须keep住,不然很可能会被移除掉

代码压缩

• 资源压缩(shrinkResources)

  会删除未使用的资源文件
  使用方法,创建一个带有<resources>标记的xml文件,使用tools:keep 保留需要的资源
  tools:discard 丢弃不需要的资源 将此文件保存在项目资源中，例如，保存在 res/
  raw/keep.xml。编译系统不会将此文件打包到 APK 中。

  下面引自谷歌文档
  指定要舍弃的资源可能看似愚蠢，因为您本可将它们删除，但在使用编译变体时，这样做可
  能很有用。例如，如果您知道给定的资源好像会在代码中使用（因此不会被压缩器移除），
  但实际上它不会用于给定的编译变体，那么就可以将所有资源放入通用项目目录，然后为每
  个编译变体创建一个不同的 keep.xml 文件。编译工具也可能会将某个资源错误地识别为
  需要的资源，之所以可能发生这种情况是因为，编译器会以内嵌方式添加资源 ID，如果真
  正引用的资源与代码中的某个整数值恰巧具有相同的值，资源分析器可能不知道这两者之间
  的差别。

  利用resConfigs移除未使用的资源,可以使用这个编译出不同配置的apk

• 代码混淆

  会使用简单字符替代方法名和变量名,减小代码的体积,也对反编译阅读源码产生了一定的困
  难,进而一定程度上保护了源码

• 优化

  R8会检查并优化代码结构,比如检查到从未使用的else,便会删除,进一步的减小的dex的大小.

• 字节对齐(zipAlignEnabled)

  我们经常可以听到一个叫字节对齐的名词,作用就是将各种类型的数据按照一定的规则排列,而不是顺序排放,对于我们访问数据速率会有很大提升.Android studio会自动帮我们对齐.

混淆中的关键字

我们先学习一下基本的关键字,学会了基本的关键字我们就可以写出我们需要的自定义规则了

• 作用于file

  • * 匹配文件名中不包含目录分隔符的任何部分。
  • ** 匹配文件名的任何部分，可能包含任意数量的目录分隔符。
  • ? 表示任意一个字符

• 作用于class内

  • <init> 匹配任何构造函数。
  • <fields> 匹配任何字段。
  • <methods> 匹配任何方法。
  • * 匹配任何字段或方法。
  • ** 匹配类名的任何部分，可能包含任意数量的包分隔符。
  • *** 匹配任何类型（原始或非原始，数组或非数组）。
  • ... 匹配任意数量的任何类型的参数。
  • <n> 在相同选项中匹配第n个匹配的通配符。

-dontoptimize 
#我们知道,当我们开启代码压缩试,gradle会帮助我们删除没有被引用的类,
#但是这样有时候往往会导致我们出现NoSuchMethod异常,我们可以使用这个配置来不优化某个类

上面的关键字可以用于我们来写匹配规则时,匹配更广泛的范围

混淆基本语法

-skipnonpubliclibraryclasses
#读取library调过非公开类

-dontskipnonpubliclibraryclasses
#不跳过library中非公开类名,从4.5版本开始 是默认设置

-dontskipnonpubliclibraryclassmembers
#指定不忽略非公开类中的成员变量和方法名

-keep [,modifier,...] class_specification
#keep基本语法

-keepclassmembers [,modifier] class_specification
#保护指定的类变量不被混淆

-printusage [filename]
#打印出被优化删除的元素,可以帮助我们进行问题定位,在最新的R8编译里面,
#这项属性需要显示的设置.仅在shrink阶段有效

assumenosideeffects class_specification 
#指定删除一些方法,这个方法可以帮助我们删除log日志
#E.g
-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(...);
}

-printmapping [filename] 
#打印出映射文件

includedescriptorclasses
#它是用来声明描述目标成员的元素也应当被保护,它在保护native方法时特别有效。
#因为它可以同时保证参数类型，返回类型不被混淆。保证最终的方法签名保持一致
-keepclasseswithmembernames,includedescriptorclasses class * {
    native <methods>;
}

举个栗子🌰

-keep class com.nj.dsg.**
-keep class com.nj.dsg.*
-keep class com.nj.dsg.** {*;}
上面三种都有一点区别,第一个和第二个的区别是,第二种只会混淆当前包下的类名,
第一种会混淆当前包和子包下的所有类名
第三种和上面两种的区别是,上面两种只能混淆包名,而方法名和参数名还是会被混淆
当然我们可以不用*而使用具体的类名

-keep * extends com.nj.dsg.ExtraActivity {*;}
继承自ExtraActivity不混淆

-keep interface com.nj.dsg.Callback {*;}
指定接口不混淆

-keep * implements com.nj.dsg.Callback {*;}
接口的实现类不混淆

-keep class com.nj.dsg.ExtraActivity {
  public <init>();
}
构造方法不混淆

-keep class com.nj.dsg.ExtraActivity {
public <init>( android.content.Context );
}
参数为Context的构造方法不混淆

-keep class com.nj.dsg.ExtraActivity{
public static final int 常量名 ;
}
指定常量不混淆

-keep class com.nj.dsg.ExtraActivity{
 public static int 方法名(android.content.Context);
 }
 指定方法不混淆

 -keep class com.nj.dsg.ExtraActivity{
    public <methods>;
}
指定所有的public方法不混淆

-keep class com.nj.dsg.ExtraActivity{
   <init>(***) ;
   <init>(*** , *** ) ;
}
不混淆一个参数和两个参数构造方法

-keep class com.nj.dsg.Bean{
  void set*( *** ) ;
   *** get*() ;
}
不混淆get和set方法

参考

谷歌文档

ProGuard文档