LeakCanary源码解读

版权声明:本文为原创文章,未经允许不得转载。

LeakCanary是一个安卓的性能统计工具,想必大家都有使用,工具出自大名鼎鼎的Jake Wharton大神,截止目前为止其在GitHub的star数目已达到15.4k,可见其受到的欢迎程度,下面我将通过UML类图以及流程图,最后配上部分源码对源码进行解析。

一、LeakCanary流程图

LeakCanary的代码风格主要使用的是Builder建造者模式,其主要的思想也就是监听Activity的销毁,然后进行性能统计,目前其仅支持SDK14版本及以上,不过已覆盖绝大多数手机。其流程图很简单,如下:

LeakCanary流程图.png

如图可见,直到执行buildAndInstall()之前都是搜集所需属性,然后通过buildAndInstall()方法执行安卓统计。这里仅仅是让大家有个整体的执行流程的了解。

二、LeakCanary类图

LeakCanary类图.png

如开头所说,LeakCanary的代码风格以Builder建造者为主,在该类图中可见建造者为AndroidRefWatcherBuilder,其继承于父类RefWatcherBuilder。

三、LeakCanary源码执行流程

AndroidRefWatcherBuilder作为整个库的核心建造者,其属性如下:

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

下面再来看下LeakCanary执行的入口方法install源码:

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

继续跟进listenerServiceClass方法:

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

通过该两种方法发现,AndroidRefWatcherBuilder默认已实现了heapDumpListener和excludedRefs。
最后再来看看AndroidRefWatcherBuilder的buildAndInstall方法,也就是入口install方法最终执行的方法:

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;注册DisplayLeakActivity,用于显示性能统计结果;以及安装LeakCanary。
继续跟进installOnlcsPlus,最终执行了如下方法:

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);
}

由此可以得出一个结论,LeakCanary性能统计的原理就是通过监听每个Activity的销毁,在销毁过程中统计该页面的性能情况。
我们再来继续跟进ActivityRefWatcher.this.onActivityDestroyed(activity)方法,最终执行了如下代码片段:

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,生成性能统计文件.hprof,关键代码如下:

Debug.dumpHprofData(heapDumpFile.getAbsolutePath());

2,分析文件。分析文件的过程在service服务当中,该服务正是入口方法放进去的DisplayLeakService,最终将生成的.hprof文件通过通知的形式呈现出来:

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

其中AnalysisResult是.hprof的分析结果。

讲到这里,可能某些读者仍有些疑问,到底.hprof文件是如何解析成信息的?源码的处理的关键语句是这样的:

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

没错,性能统计文件转化为信息的代码正是checkForLeak,具体实现逻辑在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);
}

这里,执行转化的方法为HprofParser的parse方法,然后再将转化的信息封装成AnalysisResult对象,其中HprofParser也是自定义的类,里面有一定的篇幅解析.hprof文件,感兴趣的同学可以继续深入研究。

至此,整个LeakCanary的建造以及执行流程已梳理完毕。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,062评论 25 707
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,505评论 18 399
  • 男生二号宿舍,脏乱差、物品摆放不合格 男生五号宿舍物品摆放不规范,电源没关 男生七号宿舍物品摆放不规范,有店内物品...
    工作文件阅读 575评论 0 0
  • 1. 最近《欢乐颂》热播,很多人都在大批特批樊胜美,觉得她太贪钱,尤其是对待感情太物质。我觉得恰恰相反,樊胜美的可...
    顾盼生思阅读 235评论 2 1
  • 亲爱的yo: 今天一天大雨,爸爸一早去了崇明,我们两个窝在家里没有出门。本来计划要和你一起开始期末复习的,可惜我没...
    mycarolrong阅读 78评论 0 0