Flutter内存泄漏检测插件

leak_detector

leak_detector是用来检测Widget, ElementState是否会在退出页面之后内存泄漏的插件。

github地址:https://github.com/liujiakuoyx/leak_detector (欢迎大家star)

插件地址:https://pub.dev/packages/leak_detector

开始使用

初始化

为了避免底层库vm_service发生crash,请在添加内存泄漏检测对象之前调用:

//maxRetainingPath:引用链的最大长度,设置越短性能越高,但是很有可能获取不到完整的泄漏路径 默认是 300
LeakDetector().init(maxRetainingPath: 300);

开启泄漏检测会降低性能,Full GC可能会使页面掉帧。
插件中通过assert语句初始化,所以您不用特意在release版本中关闭该插件。

检测

MaterialApp增加路由的监听器LeakNavigatorObserver,这样将会自动检测页面的Widget和其对应的Element是否存在内存泄漏,如果页面的WidgetStatefulWidget,也会自动检查其对应的State对象。

import 'package:leak_detector/leak_detector.dart';

@override
Widget build(BuildContext context) {
  return MaterialApp(
    navigatorObservers: [
      //used the LeakNavigatorObserver
      LeakNavigatorObserver(
        //返回false则不会校验这个页面.
        shouldCheck: (route) {
          return route.settings.name != null && route.settings.name != '/';
        },
      ),
    ],
  );
}

获取泄漏信息

LeakDetector().onLeakedStream可以注册自己的监听函数,在检测到内存泄漏之后会通知对象的引用链数据。
LeakDetector().onEventStream可以监听内部时间的通知,如startGcendGc等。

提供了一个引用链的预览页面,你只需要添加以下代码即可,注意其中的BulidContext必须能够获取NavigatorState

import 'package:leak_detector/leak_detector.dart';

//show preview page
LeakDetector().onLeakedStream.listen((LeakedInfo info) {
  //print to console
  info.retainingPath.forEach((node) => print(node));
  //show preview page
  showLeakedInfoPage(navigatorKey.currentContext, info);
});

页面展示效果如下:


image2.png
image3.png
image4.png

其中包含引用链节点的类信息、被引用属性信息、属性声明源码、源码位置(行号:列号)。

内存泄漏历史记录

import 'package:leak_detector/leak_detector.dart';

getLeakedRecording().then((List<LeakedInfo> infoList) {
  showLeakedInfoListPage(navigatorKey.currentContext, infoList);
});
image3.png

*真机上无法连接vm_service问题

vm_service 存在 Single Client Mode(单一客户端模式)。

DDS(Dart Development Service)连接到vm_service时,vm_service进入单一客户端模式,之后不再接受其他的WebSocket连接,而是将WebSocket转发给DDS,直到DDSvm_service断开连接,则vm_service才能再次开始接受WebSocket请求。

所以当我们连接电脑运行的时候,电脑端的DDS会首先连接到我们的移动端的vm_serviceWebSocket服务,导致我们的leak_detector插件无法再次连接到vm_service

有两种解决办法:

  • run完成之后,断开与电脑端的连接,然后最好重启app。

    如果是打好的测试包安装在手机上,是不存在上面的问题的,所以这种方法适用于给测试人员使用的情况下。

  • flutter run后面加上--disable-dds参数关闭调试端的DDS服务,经过测试,这样做并不会造成调试端的功能问题。

    要是使用Android Studio也可以像下面这样配置。

注意:在 Pull Request #80900 合入之后,--disable-dds被改名为--no-dds

[图片上传失败...(image-da9089-1651905121228)]

[图片上传失败...(image-68bd57-1651905121228)]

*目前存在的问题

由于vm_service在获取DartVm数据的时候偶尔会报一些奇怪的错误,猜测是VM中报的错无法定位,会造成检测失败。

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

推荐阅读更多精彩内容