iOS:项目中无用类检测和无用图片检测汇总_xcode 检测未使用的文件

前言

在涉及到项目大改版，或者涉及到某个功能模块大变更，就会涉及到图片废弃和文件废弃的情况。
但是这时候就会遗留下一个很大的问题，没有将废弃的、无用的文件类或资源删除干净。而这次需要对工程代码的无用资源和无用文件进行删除处理，感触颇多，故在此笔记。
首先，感觉很多人的代码习惯还是恶待提高。比如我发现一些人的代码操作习惯，从好到次，可以大略分以下情况。

编码习惯问题：
1、有良好的代码习惯的程序猿就能够在边开发边删除那些无用的文件或资源，但是如果涉及面广的资源，总会有些遗落的没有处理掉。
2、那些代码习惯比较一般的，有一部分只删除没有用的当前类，就不去关注已经他的子类，如其对应的view类、model类，甚至对应的图标，也是留下了不少垃圾文件。
3、对一些代码习惯不好的，有的只会注释关键入口，不去了解对应需求以后还用不用，其他一概不处理，美其名曰以后如果以后还有用的话，一句代码还原回来就可以了，此为最次，不可原谅。

如何保持良好习惯：
在这里我已经不想多说了，我提到很多次了。上链接：
1、程序员的自我修养：论代码规范的重要性
2、如何让自己的代码更整洁

以上仅为个人认知总结，不是核心内容。
好了，上干货：

一、无效图片资源检测

1.1、LSUnusedResources

1.1.1、插件下载

LSUnusedResources，用【My Mac】模拟器运行,如下图：

1.1.2、检测范围

• a、检测不到的图片
  （1）xib, storyboard里面设置的图片
  （2）项目中使用@"image_%02d"代码设置加载的图片
  （3）项目中宏定义使用到的图片。
  （4）图片保存在本地,需要服务器返回字段名, 本地根据返回的字符串,记载图片的。此最为奇葩，应该是很老的代码，或者有什么特殊要需求吧，建议能不用就不用。这是恨不规范的写法（这种方式根本就是无迹可查，如果有用到，而且没有记录过有哪些，那么图片资源文件的瘦身就结束了吧）。

1.1.3、检测结果处理

通过检测工具发现了无用的图片，请不要点击该工具的删除按钮,这是不可恢复的，垃圾篓里也不会出现已删除的图片。要删除图片的话还是到项目中搜索这些检测出来的图片进行排查，不属于第1、第2点情况后,在进行手动删除。

1.1.4、奇淫巧技

1、第一次检索时，先打钩忽略最后带数字的图片，即上面的图片步骤2。
2、待图片处理完一遍之后，再把打钩去掉检索。
这样检索出来的结果就不会那么杂。

二、无效文件检测

这里我找了两个插件，各有千秋，但是两个都需要用到。先上干货，后面再进行比对。

2.1、XcodeProjectArrangementTool

2.1.1、插件下载

XcodeProjectArrangementTool，用【My Mac】模拟器运行,如下图：

2.1.2、检测范围说明

• a、检测不涉及范围：
  （1）资源类文件不检测

• b、检测到确实是没有用到的情况
  （1）文件存在，有关联到项目的，且该项目也没有被引用到的。

• c、检测到显示没用的，但实际是有用的
  （1）单元测试的文件
  （2）只通过+load方法实现业务逻辑的（因为不需要文件导入）
  （3）接口c++语言实现，外部调用不需要导入该文件的

2.1.3、检测结果处理

对检测到的unused文件，还是需要一个个去排查，要根据项目实际情况处理，不知道的最好和小伙伴之间多沟通，总是没有坏处的

2.2、WHC_ScanUnusedClass

2.2.1、插件下载

WHC_ScanUnusedClass，用【My Mac】模拟器运行,如下图：

功能点说明：

• 扫描速度:快速扫描 > 常规扫描 > 深度扫描

• 扫描准确性:快速扫描 < 常规扫描 < 深度扫描
  快速扫描: 主要针对高编码质量项目(命名规范,无垃圾注释…),扫描速度最快
  常规扫描: 主要针对一般编码质量项目(命名规范一般,少量垃圾注释…),扫描速度一般
  深度扫描: 主要针对编码质量比较差的项目(命名不规范,大量垃圾注释…),扫描速度比较慢

• 设置扫描线程的数量不宜过大一般5个线程左右足以(设置太大内存承受压力大)

2.2.2、检测范围

• a、检测不涉及范围：
  （1）单元测试文件不检测。
  （2）资源类文件不检测

• b、检测到确实是没有用到的情况
  （1）文件存在但没有关联到项目的。这种情况在项目里全局搜索是无法搜索到的，只能在项目目录中找到，知道到可以将之删除。
  （2）文件存在并关联到项目的。这个情况又分几个小类：仅仅存在，文件不被引用的；文件有被引用过，但是没有被实现的，这类也不少。

• c、检测到显示没用的，但实际是有用的
  （1）只通过+load方法实现业务逻辑的（因为不需要文件导入）
  （2）只在xxx.xib中使用的文件类
  （3）只实现枚举配置的文件类
  （4）通过NSClassFromString(@“xxx”)获取文件类的
  （5）通过键值对建立关联关系配置的，如下：

- (NSDictionary *)itemContentViewMapperWithScrollViewManager:(SZYEditorScrollViewManager *)scrollViewManager {
    return @{
             @"SZYEditorScrollViewItem":@"SZYEditorScrollContentView",
             };
}
1
2
3
4
5

（6）请求响应模型子模型，检测不出来(这种最多)，如下：

@interface ZTGPicParamEnvelop : SZYJsonModel
// 发布最多图片数
@property (nonatomic, assign) NSInteger maxPicForRecipes;
// 最多推荐选中图片数
@property (nonatomic, assign) NSInteger maxRecommendSelectPhotoCount;
@end

@interface ZTGResponseTeacherBaseConfigEnvelop : SZYJsonModel

@property (nonatomic, strong) ZTGPicParamEnvelop *picParam;

@end
1
2
3
4
5
6
7
8
9
10
11
12

2.2.3、检测结果处理

对检测到的unused文件，还是需要一个个去排查。项目越大，出现的检测没有用，但实际有应用的还是不少的，所以还需要特别注意。

三、两个检索文件的插件比对与应用

通过以上的说明可以，处理检索范围不一致，其他的基本一致。但正是因为检索范围不一致，直接导致了两个插件之间检索效率的极大差异。

• 差异：
  1、插件XcodeProjectArrangementTool检索比较简单，一个大项目检索下来也就几分钟搞定，而插件WHC_ScanUnusedClass，一个大项目检索下来要几个小时（我的项目花了十个小时左右）。
  2、两个插件都存在在检索的时候，不能对项目操作处理，不然都会出现奔溃的情况。

• 应用：
  1、根据以上两个差异，我们可以先使用插件XcodeProjectArrangementTool初步检索，将无用的文件删除。由于在删除的时候，会出现其导入文件子类无用并且没有删除干净，那么，建议要多关注我们要删除文件，其引用的文件，查看是否可以一并删除。项目比较大的情况下，建议最少重复执行三遍，才能将项目中无用的文件删除的相对干净。
  2、然后再使用插件WHC_ScanUnusedClass进行深度扫描查询（一个大的项目，10多年的代码，我才不相信所有的代码都能按实现，所以老实点吧，就选深度扫描，既然都是慢的了，再慢一点又如何）。然后把检索出来的认为貌似没有用的，全部查看一遍，再做删除与否处理。执行三遍，还是一样的逻辑。

3、也是最后一点，无用资源文件删除，这个检索还是很快的。但是为什么放在最后呢？因为只有把无用文件删除干净了，这时候差不多也把其中引用的资源文件也删除了一遍。这样的话，可以避免出现无用功。

---

---

参考：

1、LSUnusedResources
2、XcodeProjectArrangementTool
3、WHC_Scan