iOS內存泄漏自動檢測工具PLeakSniffer

新款objective-C內存泄漏自動檢測工具PLeakSniffer遥赚,GitHub地址蚯嫌。

背景

前些天讀到WeRead團隊分享的一款內存泄漏檢測工具MLeaksFinder胁后,恍惚想起早些時候自己也有過編寫這樣一個小工具的想法,不知道由于什么原因把這事給忘記了详恼。在仔細讀過MLeaksFinder源碼默刚,了解實現思路之后,發(fā)現和自己最初的想法并不相同芭毙,終于在上個周末戰(zhàn)勝拖延癥將之前的想法付諸于代碼筋蓖,也就誕生了這款功能類似的內存泄漏檢測工具PLeakSniffer。建議讀者先詳細閱讀下MLeaksFinder這篇博客退敦。

為什么要再造輪子

我在公司的項目里實際試用了MLeaksFinder粘咖,還查處了2處泄漏??。根據MLeaksFinder代碼文件中日期推測侈百,這個項目至少已開始半年有余瓮下,并在微信讀書上得到了實踐驗證,在功能性和穩(wěn)定性上都應該有不錯的表現钝域。

在編寫完PLeakSniffer之后讽坏,查出了與MLeaksFinder相同的內存泄漏,思路迥異的代碼抵達了相同的終點例证,寫代碼的樂趣莫過于此路呜。新的思路或許還能拋磚引玉,如果激發(fā)更多的創(chuàng)意战虏,也算是對iOS開發(fā)社區(qū)的一點小貢獻拣宰。

MLeaksFinder現階段能查處UIViewController和UIView的泄漏党涕,我早先的想法還能遞歸的查出UIViewController之下所有Property的泄漏烦感,并在PLeakSniffer及公司項目中得到了初步的驗證,這算是對MLeaksFinder功能的一個小補充膛堤。

這類工具的意義

在我們討論這類工具的意義之前手趣,我們先得明確一點:

如果不使用Instrument當中的Leak檢測工具,并沒有什么輕易的100%精準的內存泄漏檢測方式。

但這類工具還是有其存在價值的绿渣,內存泄漏的危害不用贅述朝群,如果有一款工具能在80%的場景下檢測出可能的內存泄漏,而且這種檢測并不會帶來任何副作用(不影響生產環(huán)境代碼)中符,為什么不使用它呢姜胖。

大部分人都低估了他們寫代碼時導致意外內存泄漏的可能性。Retain Cycle淀散,Block強引用右莱,NSTimer釋放不當,這些常見的錯誤還是很容易出現在我們的代碼里档插,Instrument每使用一次要費些精力慢蜓,適合做定期的大排查。平常時候就更適合用MLeaksFinder郭膛,PLeakSniffer這類工具來做實時監(jiān)控晨抡,提供免費建議。

PLeakSniffer實現思路

我們絕大部分時候都是在編寫UIViewController则剃,UIViewController就像一個根節(jié)點耘柱,持有并管理著很多的子節(jié)點對象,這些子節(jié)點的生命周期都依賴于Controller棍现,Controller釋放的時候帆谍,他們也隨之釋放。用一張圖簡單的描述他們的關系:

根據各個應用使用的設計模式不同(MVC轴咱,MVP汛蝙,MVVM等),Controller所持有的Property也不相同朴肺。這里我們使用MVP作為例子窖剑,Controller所包含的對象就包括各種View對象,和Presenter戈稿,Model對象西土。當然每個對象又有可能持有更多的子對象。

PLeakSniffer基于這樣一個假設: > 如果Controller被釋放了鞍盗,但其曾經持有過的子對象如果還存在需了,那么這些子對象就是泄漏的可疑目標。

當然這個假設并不是一個100%適用的真理般甲,不同工程師編寫代碼的方式風格差別很大肋乍,有些會把某些UIViewController做成單例(個人覺得這不是個好主意。敷存。)墓造,有些會把某些View緩存起來(即使Controller已被釋放),還會有其他考慮不到的場景。但在80%以上的場景觅闽,我們在Controller結束生命周期之后會將其持有的資源一并釋放帝雇。這時候PLeakSniffer可以發(fā)揮用處,給你一些免費的泄漏建議蛉拙。

那么怎么在Controller被釋放之后尸闸,知道其持有的對象沒有被釋放呢?

一個小技巧可以達成這個目標:子對象(比如view)建立一個對controller的weak引用孕锄,如果Controller被釋放夏伊,這個weak引用也隨之置為nil闹获。那怎么知道子對象沒有被釋放呢呻顽?用一個單例對象每個一小段時間發(fā)出一個ping通知去ping這個子對象敞斋,如果子對象還活著就會一個pong通知。所以結論就是:如果子對象的controller已不存在恼除,但還能響應這個ping通知踪旷,那么這個對象就是可疑的泄漏對象。完整的結構可以用下圖表示:

通知移除需要一個時機豁辉,這里我們使用Associated Object機制給每一個子對象再生成一個Proxy對象令野,在Proxy對象的dealloc里面移除通知。

當然什么時候去判斷一個對象的生命周期開始徽级,什么時候判斷為結束气破,需要一個精挑細選的機制。View餐抢,Controller现使,Property各不相同。

PLeakSniffer采取保守的策略旷痕,通過Objective C的runtime機制碳锈,遞歸的將一個Controller所有強引用的property找出,并安裝proxy監(jiān)聽Ping通知欺抗。在我的測試下售碳,基本上能將property泄漏的場景找出。

PLeakSniffer的使用方式很簡答绞呈,通過Pod安裝后贸人,通過以下代碼激活即可。

#if MY_DEBUG_ENV

[[PLeakSniffer sharedInstance] installLeakSniffer];

[[PLeakSniffer sharedInstance] addIgnoreList:@[@"MySingletonController"]];

#endif

addIgnoreList可以添加一些特殊的忽略名單佃声,比如單例這種無法正確預測泄漏的對象艺智。切記用Debug的宏將上述代碼包住,不要把這些檢測泄漏的代碼帶進線上環(huán)境秉溉。

如果檢測到可疑泄漏力惯,PLeakSniffer會在控制臺打印一條日志:

Controller泄漏:Detect Possible Controller Leak: %@

其他對象泄漏:Detect Possible Leak: %@

更多的細節(jié)請查閱代碼:GitHub地址碗誉。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末召嘶,一起剝皮案震驚了整個濱河市父晶,隨后出現的幾起案子,更是在濱河造成了極大的恐慌弄跌,老刑警劉巖甲喝,帶你破解...
    沈念sama閱讀 216,591評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現場離奇詭異铛只,居然都是意外死亡埠胖,警方通過查閱死者的電腦和手機,發(fā)現死者居然都...
    沈念sama閱讀 92,448評論 3 392
  • 文/潘曉璐 我一進店門淳玩,熙熙樓的掌柜王于貴愁眉苦臉地迎上來直撤,“玉大人,你說我怎么就攤上這事蜕着∧笔” “怎么了?”我有些...
    開封第一講書人閱讀 162,823評論 0 353
  • 文/不壞的土叔 我叫張陵承匣,是天一觀的道長蓖乘。 經常有香客問我,道長韧骗,這世上最難降的妖魔是什么嘉抒? 我笑而不...
    開封第一講書人閱讀 58,204評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮袍暴,結果婚禮上些侍,老公的妹妹穿的比我還像新娘。我一直安慰自己政模,他們只是感情好娩梨,可當我...
    茶點故事閱讀 67,228評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著览徒,像睡著了一般狈定。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上习蓬,一...
    開封第一講書人閱讀 51,190評論 1 299
  • 那天纽什,我揣著相機與錄音,去河邊找鬼躲叼。 笑死芦缰,一個胖子當著我的面吹牛,可吹牛的內容都是我干的枫慷。 我是一名探鬼主播让蕾,決...
    沈念sama閱讀 40,078評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼浪规,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了探孝?” 一聲冷哼從身側響起笋婿,我...
    開封第一講書人閱讀 38,923評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎顿颅,沒想到半個月后缸濒,有當地人在樹林里發(fā)現了一具尸體,經...
    沈念sama閱讀 45,334評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡粱腻,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,550評論 2 333
  • 正文 我和宋清朗相戀三年庇配,在試婚紗的時候發(fā)現自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片绍些。...
    茶點故事閱讀 39,727評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡捞慌,死狀恐怖,靈堂內的尸體忽然破棺而出柬批,到底是詐尸還是另有隱情啸澡,我是刑警寧澤,帶...
    沈念sama閱讀 35,428評論 5 343
  • 正文 年R本政府宣布萝快,位于F島的核電站锻霎,受9級特大地震影響,放射性物質發(fā)生泄漏揪漩。R本人自食惡果不足惜旋恼,卻給世界環(huán)境...
    茶點故事閱讀 41,022評論 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望奄容。 院中可真熱鬧冰更,春花似錦、人聲如沸昂勒。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,672評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽戈盈。三九已至奠衔,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間塘娶,已是汗流浹背归斤。 一陣腳步聲響...
    開封第一講書人閱讀 32,826評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留刁岸,地道東北人脏里。 一個月前我還...
    沈念sama閱讀 47,734評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像虹曙,于是被迫代替她去往敵國和親迫横。 傳聞我的和親對象是個殘疾皇子番舆,可洞房花燭夜當晚...
    茶點故事閱讀 44,619評論 2 354

推薦閱讀更多精彩內容