LeakCanary源碼解讀

版權(quán)聲明:本文為原創(chuàng)文章续语,未經(jīng)允許不得轉(zhuǎn)載弃酌。

LeakCanary是一個(gè)安卓的性能統(tǒng)計(jì)工具,想必大家都有使用锦积,工具出自大名鼎鼎的Jake Wharton大神,截止目前為止其在GitHub的star數(shù)目已達(dá)到15.4k歉嗓,可見其受到的歡迎程度丰介,下面我將通過UML類圖以及流程圖,最后配上部分源碼對(duì)源碼進(jìn)行解析鉴分。

一哮幢、LeakCanary流程圖

LeakCanary的代碼風(fēng)格主要使用的是Builder建造者模式,其主要的思想也就是監(jiān)聽Activity的銷毀志珍,然后進(jìn)行性能統(tǒng)計(jì)橙垢,目前其僅支持SDK14版本及以上,不過已覆蓋絕大多數(shù)手機(jī)伦糯。其流程圖很簡(jiǎn)單柜某,如下:

LeakCanary流程圖.png

如圖可見,直到執(zhí)行buildAndInstall()之前都是搜集所需屬性敛纲,然后通過buildAndInstall()方法執(zhí)行安卓統(tǒng)計(jì)喂击。這里僅僅是讓大家有個(gè)整體的執(zhí)行流程的了解。

二载慈、LeakCanary類圖

LeakCanary類圖.png

如開頭所說惭等,LeakCanary的代碼風(fēng)格以Builder建造者為主,在該類圖中可見建造者為AndroidRefWatcherBuilder办铡,其繼承于父類RefWatcherBuilder辞做。

三琳要、LeakCanary源碼執(zhí)行流程

AndroidRefWatcherBuilder作為整個(gè)庫(kù)的核心建造者,其屬性如下:

private ExcludedRefs excludedRefs;
private Listener heapDumpListener;
private DebuggerControl debuggerControl;
private HeapDumper heapDumper;
private WatchExecutor watchExecutor;
private GcTrigger gcTrigger;

下面再來看下LeakCanary執(zhí)行的入口方法install源碼:

public staticRefWatcher install(Application application) {
   return((AndroidRefWatcherBuilder)refWatcher(application)
       .listenerServiceClass(DisplayLeakService.class)
       .excludedRefs(AndroidExcludedRefs.createAppDefaults().build()))
       .buildAndInstall();
}

繼續(xù)跟進(jìn)listenerServiceClass方法:

public AndroidRefWatcherBuilder listenerServiceClass(Class listenerServiceClass) {
   return (AndroidRefWatcherBuilder)this.heapDumpListener(new ServiceHeapDumpListener(this.context, listenerServiceClass));
}

通過該兩種方法發(fā)現(xiàn)秤茅,AndroidRefWatcherBuilder默認(rèn)已實(shí)現(xiàn)了heapDumpListener和excludedRefs稚补。
最后再來看看AndroidRefWatcherBuilder的buildAndInstall方法,也就是入口install方法最終執(zhí)行的方法:

public RefWatcher buildAndInstall() {
   RefWatcher refWatcher = this.build();
   if(refWatcher != RefWatcher.DISABLED) {
       LeakCanary.enableDisplayLeakActivity(this.context);
       ActivityRefWatcher.installOnIcsPlus((Application)this.context,refWatcher);
   }
   return refWatcher;
}

該方法主要做了3件事情:build框喳;注冊(cè)DisplayLeakActivity课幕,用于顯示性能統(tǒng)計(jì)結(jié)果;以及安裝LeakCanary五垮。
繼續(xù)跟進(jìn)installOnlcsPlus乍惊,最終執(zhí)行了如下方法:

private final ActivityLifecycleCallbacks lifecycleCallbacks = new ActivityLifecycleCallbacks() {
    ......
    public void onActivityDestroyed(Activity activity) {
        ActivityRefWatcher.this.onActivityDestroyed(activity);
    }
};
public void watchActivities() {
    this.stopWatchingActivities();
    this.application.registerActivityLifecycleCallbacks(this.lifecycleCallbacks);
}

由此可以得出一個(gè)結(jié)論,LeakCanary性能統(tǒng)計(jì)的原理就是通過監(jiān)聽每個(gè)Activity的銷毀放仗,在銷毀過程中統(tǒng)計(jì)該頁面的性能情況润绎。
我們?cè)賮砝^續(xù)跟進(jìn)ActivityRefWatcher.this.onActivityDestroyed(activity)方法,最終執(zhí)行了如下代碼片段:

Result ensureGone(KeyedWeakReference reference, long watchStartNanoTime) {
    ......
    this.gcTrigger.runGc();
    ......
    File heapDumpFile =this.heapDumper.dumpHeap();
    ......
    this.heapdumpListener.analyze(newHeapDump(heapDumpFile,reference.key,reference.name, this.excludedRefs,watchDurationMs,gcDurationMs,heapDumpDurationMs));
    return Result.DONE;
}

該方法主要做了兩件事情:
1诞挨,生成性能統(tǒng)計(jì)文件.hprof莉撇,關(guān)鍵代碼如下:

Debug.dumpHprofData(heapDumpFile.getAbsolutePath());

2,分析文件惶傻。分析文件的過程在service服務(wù)當(dāng)中棍郎,該服務(wù)正是入口方法放進(jìn)去的DisplayLeakService,最終將生成的.hprof文件通過通知的形式呈現(xiàn)出來:

protected final void onHeapAnalyzed(HeapDump heapDump, AnalysisResult result) {
    ......
    LeakCanaryInternals.showNotification(this, contentTitle, contentText, pendingIntent, notificationId1);
}

其中AnalysisResult是.hprof的分析結(jié)果银室。

講到這里涂佃,可能某些讀者仍有些疑問,到底.hprof文件是如何解析成信息的蜈敢?源碼的處理的關(guān)鍵語句是這樣的:

AnalysisResult result = heapAnalyzer.checkForLeak(heapDump.heapDumpFile, heapDump.referenceKey);

沒錯(cuò)巡李,性能統(tǒng)計(jì)文件轉(zhuǎn)化為信息的代碼正是checkForLeak,具體實(shí)現(xiàn)邏輯在HeapAnalyzer里面:

public AnalysisResult checkForLeak(File heapDumpFile, String referenceKey) {
    ......
    MemoryMappedFileBuffer e = new MemoryMappedFileBuffer(heapDumpFile);
    HprofParser parser = new HprofParser(e);
    Snapshot snapshot = parser.parse();
    this.deduplicateGcRoots(snapshot);
    Instance leakingRef = this.findLeakingReference(referenceKey, snapshot);
    return leakingRef == null ? AnalysisResult.noLeak(this.since(analysisStartNanoTime)) : this.findLeakTrace(analysisStartNanoTime, snapshot, leakingRef);
}

這里扶认,執(zhí)行轉(zhuǎn)化的方法為HprofParser的parse方法,然后再將轉(zhuǎn)化的信息封裝成AnalysisResult對(duì)象殊橙,其中HprofParser也是自定義的類辐宾,里面有一定的篇幅解析.hprof文件,感興趣的同學(xué)可以繼續(xù)深入研究膨蛮。

至此叠纹,整個(gè)LeakCanary的建造以及執(zhí)行流程已梳理完畢。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末敞葛,一起剝皮案震驚了整個(gè)濱河市誉察,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌惹谐,老刑警劉巖持偏,帶你破解...
    沈念sama閱讀 223,002評(píng)論 6 519
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件驼卖,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡鸿秆,警方通過查閱死者的電腦和手機(jī)酌畜,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,357評(píng)論 3 400
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來卿叽,“玉大人桥胞,你說我怎么就攤上這事】加ぃ” “怎么了贩虾?”我有些...
    開封第一講書人閱讀 169,787評(píng)論 0 365
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)沥阱。 經(jīng)常有香客問我缎罢,道長(zhǎng),這世上最難降的妖魔是什么喳钟? 我笑而不...
    開封第一講書人閱讀 60,237評(píng)論 1 300
  • 正文 為了忘掉前任屁使,我火速辦了婚禮,結(jié)果婚禮上奔则,老公的妹妹穿的比我還像新娘蛮寂。我一直安慰自己,他們只是感情好易茬,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,237評(píng)論 6 398
  • 文/花漫 我一把揭開白布酬蹋。 她就那樣靜靜地躺著,像睡著了一般抽莱。 火紅的嫁衣襯著肌膚如雪范抓。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,821評(píng)論 1 314
  • 那天食铐,我揣著相機(jī)與錄音匕垫,去河邊找鬼。 笑死虐呻,一個(gè)胖子當(dāng)著我的面吹牛象泵,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播斟叼,決...
    沈念sama閱讀 41,236評(píng)論 3 424
  • 文/蒼蘭香墨 我猛地睜開眼偶惠,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了朗涩?” 一聲冷哼從身側(cè)響起忽孽,我...
    開封第一講書人閱讀 40,196評(píng)論 0 277
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后兄一,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體厘线,經(jīng)...
    沈念sama閱讀 46,716評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,794評(píng)論 3 343
  • 正文 我和宋清朗相戀三年瘾腰,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了皆的。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,928評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡蹋盆,死狀恐怖费薄,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情栖雾,我是刑警寧澤楞抡,帶...
    沈念sama閱讀 36,583評(píng)論 5 351
  • 正文 年R本政府宣布,位于F島的核電站析藕,受9級(jí)特大地震影響召廷,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜账胧,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,264評(píng)論 3 336
  • 文/蒙蒙 一竞慢、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧治泥,春花似錦筹煮、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,755評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至准脂,卻和暖如春劫扒,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背狸膏。 一陣腳步聲響...
    開封第一講書人閱讀 33,869評(píng)論 1 274
  • 我被黑心中介騙來泰國(guó)打工沟饥, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人湾戳。 一個(gè)月前我還...
    沈念sama閱讀 49,378評(píng)論 3 379
  • 正文 我出身青樓闷板,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親院塞。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,937評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,343評(píng)論 25 707
  • 1. Java基礎(chǔ)部分 基礎(chǔ)部分的順序:基本語法性昭,類相關(guān)的語法拦止,內(nèi)部類的語法,繼承相關(guān)的語法,異常的語法汹族,線程的語...
    子非魚_t_閱讀 31,669評(píng)論 18 399
  • 男生二號(hào)宿舍萧求,臟亂差、物品擺放不合格 男生五號(hào)宿舍物品擺放不規(guī)范顶瞒,電源沒關(guān) 男生七號(hào)宿舍物品擺放不規(guī)范夸政,有店內(nèi)物品...
    工作文件閱讀 634評(píng)論 0 0
  • 1. 最近《歡樂頌》熱播,很多人都在大批特批樊勝美榴徐,覺得她太貪錢守问,尤其是對(duì)待感情太物質(zhì)。我覺得恰恰相反坑资,樊勝美的可...
    顧盼生思閱讀 244評(píng)論 2 1
  • 親愛的yo: 今天一天大雨耗帕,爸爸一早去了崇明,我們兩個(gè)窩在家里沒有出門袱贮。本來計(jì)劃要和你一起開始期末復(fù)習(xí)的仿便,可惜我沒...
    mycarolrong閱讀 84評(píng)論 0 0