一、混淆的概念
将Android项目进行打包之时,可以将项目里的包名、类名、变量名进行更改,使得代码不容易泄露,类似于对其apk中的文件加密。
二、混淆的作用
首先,大家要知道,Android项目直接打成apk包之后,其实是可以通过一定的反编译技术手段看到apk中的源码,这对于一些商业项目(非开源项目)来说,肯定是不合适的,而“混淆”可以一定程度的避免apk被简单的反编译,从而被其他人窥视到apk包中的奥秘。
所以,简而言之,混淆的作用:
1. 代码混淆后阅读性降低,反编译后破译程序难度提高;
2. 混淆后字节数减少,减少了应用了体积
三、什么是混淆,什么是避混
Android SDK 本身就提供混淆的功能,将混淆开关进行开启后(下文会举例说明如何开启),开发者需要做的是对Android Studio工程项目中的proguard-rules.pro文件进行混淆白名单的配置,也就是所谓的将某个或某些指定文件进行避混处理。
那么什么是混淆白名单呢?其实就是指定一些包名、类名、变量等不可以被混淆。假设没指定白名单就进行混淆打包,而某某类的类名被混淆了(假设变成了a),那么可能其他引用或使用该类的类就找不到该类,说不定应用就会因此崩溃或是导致相应的功能无法使用。
比如端内直连Jira的SDK提供给外部调用的类A和方法fun,是在DevConfig文件中通过反射的方式调用的,如果SDK提供的这些类和方法被混淆了,那么类A和方法fun的名字就被改变了,导致反射的时候,找不到指定的类A和方法fun了。所以要对SDK中需要提供给外部操作的类A和方法fun进行避混处理。
所以所谓的混淆也就是配置混淆白名单。
四、ProGuard文件
在Android中,混淆的内容被写在了ProGuard文件中,例如:
ProGuard里一共可以做三件事:
1.压缩(Shrinking):默认开启,用以减小应用体积,移除未被使用的类和成员,并且会在优化动作执行之后再次执行(因为优化后可能会再次暴露一些未被使用的类和成员)。
关闭压缩的方法:-dontshrink
公司App中,采用的是开启压缩。
2.优化(Optimization):默认开启,在字节码级别执行优化,让应用运行的更快。
关闭优化的方法:-dontoptimize 关闭优化
使用方法:-optimizationpasses n 表示proguard对代码进行迭代优化的次数,Android一般为5
公司App中,采用了优化,且该值为5。
3.混淆(Obfuscation):默认开启,增大反编译难度,类和类成员会被随机命名,除非用keep保护。
关闭混淆的方法:-dontobfuscate 关闭混淆
公司App中,开启了混淆,混淆的具体内容,就在proguard-project.txt中。
本文主要针对混淆进行简单讲解。
五、怎么实现混淆
以公司App举例说明。
首先,在appmodule的build.gradle文件中,能看到:
说明一下:
1. 此处的release代表打release包时用的配置内容,debug为打debug包时用的配置内容,dev为打dev包时用到的配置内容。
2.minifyEnabled false 代表不开启混淆;minifyEnabled true 代表开启混淆
开启混淆后,可以添加:shrinkResources true 代表去掉没有引用的资源,可以减少应用的体积,但这个只有在混淆开启后才有效。
从图中可以明显看到,debug虽然配置了混淆文件,但没有开启混淆;release、dev都开启了混淆,且混淆文件都为同一份:proguard-project.txt,该文件在上面的(二)中,已经截图给出来了。打开文件就能看到具体的内容。
另外再做个说明,大家如果细心的话,应该会发现在上面(二)的截图中,能看到不仅有proguard-project.txt,还有proguard-gen.txt、proguard-rn.txt,其实这2个文件都被包含在了proguard-project.txt中:
打开这两个文件,会发现文件内容的格式与proguard-project.txt文件一致,不用怀疑,这两个其实也是混淆文件。公司App根据各类和包的不同作用,将内容写在了不同的proguard文件中。
项目编译的时候,会先找到proguard-project.txt执行,之后执行的过程中,会将include进来的2个proguard文件一并做处理。
混淆后默认会在工程目录app/build/outputs/mapping/release下生成一个mapping.txt文件,这就是混淆规则,我们可以根据这个文件把混淆后的代码反推回源本的代码,所以这个文件很重要,注意保护好。原则上,代码混淆后越乱越无规律越好,但有些地方我们是要避免混淆的,否则程序运行就会出错,所以就有了下面要说的:如何让自己的部分代码避免混淆从而防止出错。
六、如何避混
需要避混的文件都需要一一添加到proguard文件中,先给出两份比较全的混淆指令相关博客链接:
http://blog.csdn.net/yk377657321/article/details/60501880
http://blog.csdn.net/maxwell_nc/article/details/51998766
针对公司App中用到的语法,进行简单说明:
1、# 代表行注释符
2、- 表示一条规则的开始
3、keep 保留,例如keepattributes:表示保留属性
4、dont 不要,例如dontwarn:表示不要提示警告
5、ignore 忽略,例如ignorewarning:表示忽略警告
6、-dontoptimize不优化 ,值得注意的是默认混淆配置文件开启了-dontoptimize
7、-assumenosideeffects 关闭log
8、一般混淆规则都要加入,其中前两个在默认文件中已经配置:
8.1、-dontusemixedcaseclassnames 包名不使用大小写混合 aA Aa 公司App中未开启
8.2、-dontskipnonpubliclibraryclasses不混淆第三方引用的库 公司App中未开启
8.3、-dontpreverify不做预校验公司App中已开启
8.4、 -ignorewarning忽略警告公司App中未开启
9、输出混淆记录:
9.1、-verbose混淆后生产映射文件 map 类名->转化后类名的映射,存放在app\build\outputs\mapping\release中
9.2、-printmapping混淆前后的映射,公司App中是:out.map
10、保留原代码行号:-keepattributes 抛出异常时保留代码行号,这个最后release的时候关闭掉,公司App中是:Exceptions,SourceFile,Signature,LineNumberTable
混淆配置文件不检查规则是否重复,如果两条规则冲突,则采用白名单的,比如设置了开启优化和不优化两个选项后,无论顺序,最终都会执行不优化的操作。
举例说明:端内直连jira提bug的避混处理:
其中:-dontwarn 不提示指定包名下的所有类的警告
-keep 保留指定包名下所有类,不做混淆处理(这些类就是需要被避混的类,需要被避混的方法也都在这些类中,可以看到这里我对2个不同的包下的所有文件进行了避混处理)