还是老外文章质量高:ProGuard 在 Android 上的使用姿势
progurad是对编译后的class字节码进行处理。
在android studio中通过一行代码设置混淆配置文件:
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
这行代码的意思是配置文件使用proguard-android.txt和proguard-rules.pro两个文件。从andrid gradle plugin2.2开始,proguard-android.txt文件runtime时生成。里面设置了一些基本配置。
proguard-android.txt文件中关闭了optimize,所以通常情况下progurad对android工程主要是两个功能shrink&obfuscate即压缩和混淆。压缩单纯是对代码压缩,移除未被使用的code,压缩之后再进行通过简化类名、变量、方法的形式进行代码混淆。
注意真正打到jar里面的类才会被混淆,android.jar这种东西是供我们调用的本身不会被打到我们的jar里,所以不会被混淆。library module中使用的第三方库由于最终打aar的时候不会被打进去所以也不会被混淆。所以你会看到我们代码中对这些类的使用和import都是正常类名。混淆是对Class、field进行重命名,同时import或者引用它的地方也会被新的名字替换。library module如果是做为一个module library被主工程引用,那么混淆规则也必须加到主工程里或者设置compileProgurad属性。如果是先打包出来aar,那么aar是会被混淆的,然后混淆后的aar被主工程引用。
另外说一下资源的问题,library module的资源R文件中的id不是final的,aapt在打包apk的时候会对资源进行merge,如果资源重名则会remove掉优先级低的模块的资源。最终apk包里每种类型的资源里,一个资源名字只有一份资源对应一个id。具体可以看下这个
默认配置文件proguard-android.txt并没有对android四大组件做keep,但是如果组件在androidmanifest中声明了就不会被混淆,未声明的会被混淆。
support库因为属于第三方库会被打到jar中(library module不会),所以如果没有设置keep也会被混淆。
混淆最大的好处是加密,最大的坏处是容易因为使用不当导致诸如ClassNoFound异常。因此以下几种场景需要设置keep防止发生这种异常:
- 需要提供给外部的接口肯定不能混淆,常见sdk。
- 第三方开源库通常不需要混淆,主要原因是没有必要,人家本来就开源,万一混淆自找麻烦。
- 自己代码中用到了反射,则不能混淆被你发射的类
- 其它
大坑(Instant Run)
看proguard这块东西的时候经常有提到InstantRun模式下proguard不生效但具体没理解也没去关注。直到一次很正常的debug模式下打开混淆后直接点击run按钮运行应用崩溃了,提示找不到activity。看混淆配置没啥问题,试了命令行安装运行应用正常才怀疑是不是InstantRun搞的鬼,关闭InstantRun后再点击run一切正常。发现开启InstantRun之后似乎编译的话会混淆但是忽略你的混淆设置。你反编译apk看不出来什么异常。
Android Studio build目录下有很多文件供我们了解proguard的情况,mapping目录的mapping.txt seeds.txt usage.txt以及intermediates目录下的proguard-rules/aapt_rules. 以及javac目录下可以方便查看混淆后的class文件。
proguard的shrink会对未使用的代码remove,最终可以在usage.txt看到哪些东西被remove掉了。正常在对代码shrink后可以通过设置shinkResources利用lint来移除未使用资源。但是对于library module是不支持这个属性的,所以可以手动通过as的inspect对module进行check,手动remove掉lint result中提示的unused resource。lint本身包含非常多的项目,unused resource只是其中一项而已。
build这个task包括assemble&check,如果在build.gradle中设置了lintOption{abortOnerror true}那么执行build如果遇到lint的error则build会被中断,这通常可以用来设置一些大家遵守的规则,不遵守则不让编译通过。但是如果直接assemble则不会因为lint的error而中断。
使用apktool d解压apk得到的value目录中又一个public.xml这个就是merge后的资源表,里面每一行包括type、name、id三部分,是最终的结果,apk具体使用哪个资源都是从这里面确定的。