无效资源清理实践
前言
在实际的项目中随着APP地迭代在新功能的不断添加的同时也会有一些功能废弃了或者是伴随着UI的改版我们在疲于应付产品的各种需求的同时很难保证每次UI改版或者功能废弃时去完整的删除所有的无效的代码以及清除这些模块引用的各种失效的资源。
因此随着APP的不断迭代，功能越来越多Apk的大小是不以我们程序猿的意志而不断增长的。虽然我们不能阻止APK不断增长的大势，但是我们可以放缓增长的速度，因此在Apk瘦身这一块也有很多我们程序猿们发挥的空间。
对于APK瘦身包括代码混淆减少未引用的代码以及简化命名，图片压缩使用Webp适当合理适配，引入的各种第三库的权衡等等。 限于篇幅和本文目的不会面面俱到。
本文目的
这篇文章主要是介绍利用Lint扫描项目中失效的各种String、layout、drawable、dimen等资源以及图片资源。 虽然在AndroidStudio中为我们提供了一键扫描一键清理的功能。在我们实际的一个比较大的项目中想必大家不敢直接这么简单粗暴的操作吧。毕竟lint无法发现我们动态的访问资源的方式，更麻烦的是编译虽然能够通过，但是运行时去访问这些被删的资源轻则做了异常处理就是各种显示异常重则就是各种Crash。这时除了在心里默默的吐槽哪个队友这样子访问资源而不是直接引用呢?我们能做的就是增加一些自定义去解决这种问题咯。这里我就像大家介绍我们项目中结合Lint扫描发现无效资源，然后利用自己开发的java小程序 对扫描的资源添加白名单，备份 删除功能。 这样可以在一键清除和手动一个个查找之间寻找到一个平衡。
清理资源实践步骤
- 在AndroidStudio的terminal中执行gradlew lint 生成lint-results-debug.xml分析结果文件。
- 开启备份模式 执行UnUsedResourceCleanUtil 清理资源Java Application 对资源进行清理; (这一步只是列出项目中无效资源的清单不会执行删除操作)
- 找出动态引用的资源加入白名单的配置中，避免误删除(这一步第一次执行资源清理会比较麻烦，特别是工程规模比较大历史悠久的项目 很难完全确定哪些扫描出的无效资源是被动态引用的，一般一堆命名为abc_1 abc_2 这样一组图片极有可能在代码中是动态引用的，因此对于扫描出的这种资源需要在代码中确认是否有被动态访问。 第一遍后有了白名单就要轻松一些了； 对于第一次执行 最好是让QA注意全回归 不然某些边边角角的功能出现crash就麻烦了)
- 执行实际的删除资源的操作(建议第一次执行时 每个module分别执行 然后自测 毕竟一个大的项目一起执行完 自测会hold不住的)
- 重复步骤1 (一般执行一次资源清理 后再次扫描 又会有新的资源成为了无效资源 因此一般需要重复个2到3次直到没有扫描出新的无效资源为止
UnUsedResourceCleanUtil Java小程序简介
1.整体功能：UnUsedResourceCleanUtil 主要是对lint生成的xml文件进行处理对xml文件中的UnusedResourcestag的数据进行处理，资源文件分为两种 一种是比如图片 以及drawable、 anim、layout等整个文件为单位进行备份和删除而values 目录下的string、dimens、corlors等以文件中每一行定义的字符串 、颜色等为单位进行备份和删除
2.基本配置
- 首先要配置项目的路径: 在项目入口类UnUsedResourceCleanUtil中配置PROJECT_ROOT_PATH字段为你项目的根地址例如“C:/project_solution/trunk/”；
- 扫描出的无效资源清单以及备份文件目录 DES_DIR 这个可以配置电脑上你觉得方便的地方就好例如“D:/UnUsedResourceBackup”
- 指定白名单文件 IGNORE_FILE_NAME字段例如 ignore_delete_resource.txt
对于不能删的文件比如一些图片 就在此txt文件中添加一行例如{module}\src\main\res\drawable-hdpi\abc_ 那么该路径下abc_*的图片均不会被删除
-备份模式以及实际删除模式配置：UnUsedResourceCleanUtil.cleanUnUseResourceByModuleName(String moduleName, boolean isDelete)第二个参数重点注意 传FALSE仅仅只是列出无效资源清单 以及备份 true时才会实际执行删除 - 模块配置 MODULE_NAMES数组列出Android Studio工程中需要清理资源的模块名称清单{"module1", "module2", "module23"}
- 完成上面一些主要和本地环境路径相关的配置和白名单清单的配置就可以之间run UnUsedResourceCleanUtil 小程序就可以对项目中的各种无效资源进行清理啦。
END
小程序代码量也比较小，功能也比较简单 so 在利用我提供的这个工具对实际项目进行资源清理前还是务必先read the fucking soure code
奉上 GitHub地址
最后的最后 其实清理资源最麻烦的还是 资源误删 不好测试的问题； 我这里主要是通过第一次吃螃蟹后整理出项目中动态引用资源的白名单，然后有了白名单工作就要轻松一些了。 至于大家还有什么其它的妙招，还请不吝赐教
也非常欢迎大家看看源码提出您宝贵的意见和issue 好让我对UnUsedResourceCleanUtil的代码和功能进一步进行完善。
