iOS 脚本查看项目未使用到的方法

背景:

日常的项目经过长时间的迭代,优化,重构之后,一些方法可能已经用不到了,但是并未及时删除,长久下去,会影响我们的包大小。
如果你近期有进行代码瘦身的打算,可以看一下。

脚本使用方式

FindSelectorsUnrefs.py 脚本地址

 python FindSelectorsUnrefs.py -a /Users/a58/Library/Developer/Xcode/DerivedData/XXX-bqqoxganvkvgwuefbskxsbvnxlnn/Build/Products/Debug-iphonesimulator/XXX.app -p /Users/a58/Desktop/ProjectPath -w WB,JD

参数说明:
-a Xcode运行之后的,项目Product路径
-p 项目的地址
-w 结果白名单处理,检测结果,只想要以什么开头的类的方法,多个用逗号隔开,比如JD,BD,AL
-b 结果黑名单处理,检测结果,不想要以什么开头的类的方法,多个用逗号隔开,比如Pod,AF,SD
-w 和 -b 不能共存,共存会报错

-a的存储路径

image.png

运行结果

获取所有的protocol中的方法...
获取所有被调用的方法...
获取所有的方法,除了setter and getter方法...


查找到未被使用的方法: 170个

1 : +[WBNotificationProxy getNotifyListWithPageNum:success:failure:]
2 : -[AJKActionSheetBackgroundView touchesCancelled:withEvent:]
3 : +[WBPageRouteConfig getRequestRouteModeltWithClassName:params:]
。。。。。。。。
166 : -[WBLaunchAdManager batchDownloadVideoAndCache]
167 : -[AJKPopupView initWithPopSize:]
168 : -[WBWebViewViewController gobackAction:]
169 : -[WBFaceIDCardLiveStillTool startDetect:imageURLPathHost:imageURLShortPath:viewController:]
170 : -[WBRunLog uploadReportBackCatch]

项目中未使用方法检测完毕,相关结果存储到当前目录 selector_unrefs.txt 中
请在项目中进行二次确认后处理

流程结果图

image.png

详细工作流程:

查看项目未使用方法 .png

实现分析

通过使用otool工具对编译产生的Mach-O文件,结合项目源码进行分析。

第一步:
找到项目中所有的protocol中的方法<包括系统<UITabaleViewDelegate>的和项目的>

第二步:
通过Mach-O,找到项目中所有被引用的方法

第三步:
通过Mach-O,找到项目中所有的方法

第四步:
遍历第三步查出的所有方法,如果当前方法不在代理方法集合,也不在引用方法集合中,那么就认为是没有用到的方法。


原理篇

Mach-O简介

Mach-O文件结构.png

关于Mach-O更详细的每一部分的介绍可以参考
https://www.cnblogs.com/dengzhuli/p/9952202.html

otool简介

otool可以提取并显示iOSMach-O的相关信息,包括头部,加载命令,各个段,共享库,动态库等等。它拥有大量的命令选项,是一个功能强大的分析工具,当然还可以做反汇编的工具使用。
比如:

# 获取项目中已经使用的方法
otool -v -s __DATA __objc_selrefs SelectorsUnrefs
image.png

接下来按照上面流程图的顺序进行回顾

1、找到项目中所有的protocol中的方法<包括系统<UITabaleViewDelegate>的和项目的>

1.1、获取当前项目引用的所有的Libraries
mach-o path 是当前mach-o文件路径

otool -L mach-o path
otool -L SelectorsUnrefs
SelectorsUnrefs:
    /System/Library/Frameworks/ImageIO.framework/ImageIO (compatibility version 1.0.0, current version 0.0.0)
    /System/Library/Frameworks/Foundation.framework/Foundation (compatibility version 300.0.0, current version 1676.104.0)
    /usr/lib/libobjc.A.dylib (compatibility version 1.0.0, current version 228.0.0)
    /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1281.100.1)
    /System/Library/Frameworks/CoreFoundation.framework/CoreFoundation (compatibility version 150.0.0, current version 1676.104.0)
    /System/Library/Frameworks/UIKit.framework/UIKit (compatibility version 1.0.0, current version 61000.0.0)

1.2、获取所有Libraries中的.h文件目录

find /System/Library/Frameworks/** -name \"*.h\"
image.png

1.3、获取项目中的所有.h文件目录

find 项目地址 -name \"*.h\"
project_path == /Users/a58/Desktop/smallDemo/SelectorsUnrefs
/Users/a58/Desktop/smallDemo/SelectorsUnrefs/SelectorsUnrefs/AppDelegate.h
/Users/a58/Desktop/smallDemo/SelectorsUnrefs/SelectorsUnrefs/Dog.h
/Users/a58/Desktop/smallDemo/SelectorsUnrefs/SelectorsUnrefs/ClickView.h
/Users/a58/Desktop/smallDemo/SelectorsUnrefs/SelectorsUnrefs/ShowView.h
/Users/a58/Desktop/smallDemo/SelectorsUnrefs/SelectorsUnrefs/ViewController.h

1.4、取合集
获取当前项目中所有的.h文件目录
将上面两部分.h路径合并为一个集合

1.5、通过正则找到.h中所有的@protocol下面的方法

image.png

image.png

1.6、生成集合protocol_sels
protocol_sels集合中包含了所有的代理方法

2、获取项目所有的引用方法

2.1、获取项目所有被引用的方法

otool -v -s __DATA __objc_selrefs
SelectorsUnrefs:
Contents of (__DATA,__objc_selrefs) section
0000000100006000  __TEXT:__objc_methname:viewDidLoad
0000000100006008  __TEXT:__objc_methname:initWithFrame:
0000000100006010  __TEXT:__objc_methname:redColor
。。。。。。
0000000100006098  __TEXT:__objc_methname:addGestureRecognizer:
00000001000060a0  __TEXT:__objc_methname:clickBlock
00000001000060a8  __TEXT:__objc_methname:setClickBlock:

2.2、整理成ref_sels

viewDidLoad
initWithFrame:
redColor
setBackgroundColor:
setDelegate:
view
。。。。。
clickBlock
setClickBlock:

3、获取项目所有的方法

3.1、使用otool获取项目所有的方法

otool -oV mach-o path
image.png

3.2、一块干掉所有属性的get和set方法
这里不过滤setter和getter,因为作为属性,可能会被YYModel之类的进行解析

3.3、删除 load.cxx_destruct等方法
load方法不用说,肯定会被调用的
.cxx_destruct方法原本是为了C++对象析构的,ARC借用了这个方法插入代码实现了自动内存释放的工作

3.4、整理成imp_sels
imp_sels 包含了项目中所有的方法,除了loadsettergetter方法

4、遍历imp_sels

如果方法不在protocol_sels也不在ref_sels中认为没有被用到

5、黑白名单过滤
黑名单过滤:
我们在查找完毕之后,可能会有很多的类的方法,有些类的方法我们没必要修改也修改不了,比如Pods中的类,比如MJRefresh中检测出一个无用类方法,我们也不能删除,作为工具类多余的方法在以后不一定没用。
我们可以选择不看,比如,输入参数 -b MJ,AF

python FindSelectorsUnrefs.py -a /Users/a58/Library/SelectorsUnrefs.app -p  /Users/a58/Desktop/smallDemo/SelectorsUnrefs -b MJ,AF

那么我们的结果中会把MJAF开头的干掉,方便查看

白名单:
我们只想看我们自己的类中的方法,一般项目的类都会有固定的开头,方便管理
比如,我们的类名都是以WB开头的,输入参数 -w WB,那么结果只会显示WB开头的未使用类的方法

6、检测结果写入日志文件
结果可能过多,终端显示不开,将结果写入文件,方便阅读

7、根据检测结果,在项目中二次确认后处理
检测结果是有偏差的,有些已使用的类方法仍然不太好检测。
已知的情况:
1、如果两个类中的方法名称一样,如果其中一个类的方法使用了,可能会影响另外一个类中的方法检测结果。因为在获取已用方法列表的时候,只获取到了一个方法,如果其中一个类的方法使用了,另一个可能会被误判使用。不过一般情况下,这种情况比较少。

image.png

检测不到的情况

1、方法1调用方法2,但是没有类调用方法1。
只能检测出方法1
将方法1删除之后才会检测出方法2,所以需要检测多次
2、Swift检测不到
3、C语言方法检测不到,会被认为是已使用方法
4、通过字符串转化成Selector检测不到,会被认为是为被调用的方法<后期可以考虑添加策略>

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容