Android 性能优化之内存分析工具----LeakCanary(使用篇)

前言

LeakCanary(https://square.github.io/leakcanary)是Square公司研发的一个可视化的内存泄漏分析工具,源码github地址为https://github.com/square/leakcanary

LeakCanary对Android框架内部的了解使它有一种独特的能力来缩小每次泄露的原因,帮助开发人员显著减少OutOfMemoryError崩溃。

LeakCanary运作原理

第一步:检查保留的对象

LeakCanary可嫁接到Android的生命周期中,以便于自动检查activity 和Fragment等销毁时进行垃圾收集,这些被销毁的对象的若应用被传递给ObjectWatcher对象。支持自动检查的对象有:

被销毁的Activity实例、被销毁的Fragment实例、被销毁的Fragment View实例,被清除的ViewModel实例

如果这些被ObjectWatcher所持有的对象的弱应用在执行GC 5秒后,ObjectWather仍然持有对象的弱应用,那该对象就被视为内存泄漏。

LeakCanary等待持有的这些泄漏对象数量达到一个阈值(5)的时候,就会将这些对象dump到转储堆中;而在未达到阈值的时候,会发出一个找到几个泄漏对象的通知。

第二步:转储堆

LeakCanary将这些保留对象转储到Android文件系统的.hprof文件中,这回导致程序冻结一小段时间,同时也会发出正在dump的通知“LeakCanary is dumping the memory to investigate leaks”。

第三步:分析堆

LeakCanary使用Shrk来解析上一步的.hproof文件,找到保留的对象。并从垃圾回收的泄漏跟踪中找到该保留对象的引用路径。

LeakCanary会为每一个泄漏跟踪创建一个签名,将签名相同的泄漏组合在一起,然后将以通知的方式显示分析结果的摘要,并在Logcat中打印结果。

点击通知,可以打开每一条泄漏的位置及其详细引用关系。

第四步:泄漏分类

将发现的泄漏分为两类: 应用程序泄漏和库泄漏,关于库的泄漏我们就可以飘过了,我们主要关心应用程序的泄漏就好了。

LeakCanary使用

第一步: 准备阶段:

​ 1)自定义LeakCanaryApplication

class LeakCanaryApplication : Application() {

    //用于存放视图
    val viewMap = ArrayList<View>()
    
    override fun onCreate(){
        super.onCreate();
    }
  }

​ 2) MainActivity中添加一个TextView

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        val textView = findViewById<TextView>(R.id.helloworld);

        //将布局加载出来的视图添加到application的视图容器中
        (application as LeakCanaryApplication).viewMap.add(textView)
    }
}

第二步:build.gradle中添加依赖 & (可选)自定义Application的onCreate()配置

    //leakCanary for debug
    debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.6'

    // NEW: LeakCanary for releases!
    releaseImplementation 'com.squareup.leakcanary:leakcanary-android-release:2.6'
    // Optional: detect retained objects. This helps but is not required.
    releaseImplementation 'com.squareup.leakcanary:leakcanary-object-watcher-android:2.6'

由于笔者用的是最新的LeakCanary 2.6的版本,已经完全支持Kotlin ,而且2.6 添加依赖后不需要在application中初始化了。不过如果你觉得默认的不够白富美,可以自己在application中进行一些配置(当然不止下面的那些):

 override fun onCreate() {
        super.onCreate()

        //要自定义堆转储和分析,

        LeakCanary.config = LeakCanary.config.copy(retainedVisibleThreshold = 3)

        //要在运行时自定义对保留对象的检测
        AppWatcher.config=AppWatcher.config.copy(watchFragmentViews = false)

        //禁用堆转储和分析    AppWatcher.objectWatcher仍然会保持跟踪保留的对象,并LeakCanary将寻找这些对象当您更改LeakCanary.Config.dumpHeap回true。
        LeakCanary.config = LeakCanary.config.copy(dumpHeap = false)

        //隐藏泄漏显示活动启动器图标
        LeakCanary.showLeakDisplayActivityLauncherIcon(false)
    }

好了就这么简单,你现在可以大摇大摆的运行你的app了。

因为LeakCanary检查的是activity ,fragment在调用onDestory时发生GC后5秒仍然还保留的对象,所以我们点击设备的Back按键让页面关闭,看看日志:


发现泄漏logcat日志.png

这时候在我们的运行该app的设备上会收到一条通知:


发现泄漏的通知.png

点击上图中的通知,会自动开始dump,如下图


发现泄漏的通知2.png

dump会将签名相同的泄漏进行合并,我们继续点击该通知:如下


发现泄漏的通知3.png

打开通知后,就是LeakCanary抓取的泄漏的地方,继续点击进去


发现泄漏的通知4.png

下图就是LeakCanary 检查出来泄漏的地方(左侧红色线和下划线标注),是不是很清晰


发现泄漏的通知5.png

LeakCanary 可以帮我们找到内存泄漏的地方对象及其引用关系,接下来就需要我们自己去堵上这个泄漏了。笔者就不在废话了.

Good Luck !!!!!!!

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

推荐阅读更多精彩内容