Flutter内存检测插件ume_kit_memory_detector的使用

ume_kit_memory_detector 是一个用于自动以 Route 为单元进行内存泄漏检测的 Flutter 插件。（参赛作品）

使用

首先，在 MaterialApp 或 CupertinoApp 中添加 UmeKitMemoryDetector 到 navigatorObservers：

MaterialApp(
  navigatorObservers: [
    UmeKitMemoryDetector(), // 添加内存检测观察器
  ],
  home: MyHomePage(),
)

（非必须）可以将 MemoryDetectorButton 添加到任意位置，建议使用悬浮窗：

WidgetsBinding.instance?.addPostFrameCallback((timeStamp) {
  entry = OverlayEntry(builder: (_) => const MemoryDetectorButton());
  Overlay.of(context)?.insert(entry!);
});

默认情况下，泄漏信息会通过 LeakedInfoDbRecorder 写入到数据库，并可以通过它来获取所存储的泄露信息。

// 其父类
/// 泄露信息记录器
abstract class LeakedInfoRecorder {

  /// 添加一条记录
  void add(LeakedInfo info);

  /// 批量添加记录
  void addAll(List<LeakedInfo> list);

  /// 根据id删除一条记录
  void deleteById(int id);

  /// 清除所有记录
  void clear();

  /// 获取所有记录
  Future<List<LeakedInfo>> getAll();
}

更多使用方式

信息流监听

可以直接监听 UmeKitMemoryDetector 的 stream 来获取检测阶段及泄漏信息：

// 监听检测阶段
UmeKitMemoryDetector().taskPhaseStream.listen((phase) {
  print('当前检测阶段: $phase');
});

// 监听泄漏信息
UmeKitMemoryDetector().infoStream.listen((leakInfo) {
  print('检测到泄漏信息: ${leakInfo.description}');
});

自定义对象检测

通过以下方法可以添加任意待检测对象：

// key需要是唯一的
// 添加一个待检测对象
UmeKitMemoryDetector().addObject(obj: leaker, group: key);

// 开始检测
UmeKitMemoryDetector().doDetect(key);

自定义泄露信息存储方式

默认通过 LeakedInfoDbRecorder 写入到数据库，也可以覆盖 defaultHandler 来调整输出位置：

// 自定义记录器
LeakedRecordHandler defaultHandler = YourRecorder().add;

class YourRecorder implements LeakedInfoRecorder {

  [@override](/user/override)
  void add(LeakedInfo info) {
    // 自定义存储逻辑
  }

  [@override](/user/override)
  void addAll(List<LeakedInfo> list) {
    // 批量存储逻辑
  }

  [@override](/user/override)
  void deleteById(int id) {
    // 删除指定ID的记录
  }

  [@override](/user/override)
  void clear() {
    // 清空所有记录
  }

  [@override](/user/override)
  Future<List<LeakedInfo>> getAll() async {
    // 获取所有记录
    return [];
  }
}

自定义检测属性

可以通过以下字段，调整检测属性:

/// 引用链最大长度
/// * 见 [VmService.getRetainingPath]
const int maxRetainingPath = int.fromEnvironment("maxRetainingPath", defaultValue: 400);

/// 强制关闭内存检测
const bool closeMemDetector = bool.fromEnvironment("closeMemDetector", defaultValue: false);

/// 延迟检测
/// * 单位 : 毫秒
/// * 部分对象并不会及时回收
const int delayDoDetect = int.fromEnvironment('delayDoDetect', defaultValue: 800);

/// 扩展单元数量
/// * 在gc前创建[expandUnitNumber]个对象，用于触发full gc
/// * 0则不创建。
/// * 在实际项目接入中，由于项目所占用的内存，默认值可能过大，建议根据需求调整。
const int expandUnitNumber = int.fromEnvironment('expandUnitNumber', defaultValue: 10000000);

高度自定义

如果以上无法满足需求，可以直接继承 MemoryDetector:

class YourCustomDetector extends MemoryDetector {
  [@override](/user/override)
  void onTaskStart() {
    // 自定义任务开始逻辑
  }

  [@override](/user/override)
  void onTaskEnd() {
    // 自定义任务结束逻辑
  }

  [@override](/user/override)
  void onLeakDetected(LeakedInfo info) {
    // 自定义泄漏检测逻辑
  }
}

完整示例Demo

以下是一个完整的示例，展示如何使用 ume_kit_memory_detector 插件进行内存泄漏检测：

import 'package:flutter/material.dart';
import 'package:ume_kit_memory_detector/ume_kit_memory_detector.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Memory Leak Detection Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      navigatorObservers: [
        UmeKitMemoryDetector(), // 添加内存检测观察器
      ],
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late OverlayEntry entry;

  [@override](/user/override)
  void initState() {
    super.initState();
    WidgetsBinding.instance?.addPostFrameCallback((timeStamp) {
      entry = OverlayEntry(builder: (_) => const MemoryDetectorButton());
      Overlay.of(context)?.insert(entry);
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('内存泄漏检测'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 添加待检测对象
            UmeKitMemoryDetector().addObject(
              obj: this,
              group: 'HomePage',
            );

            // 开始检测
            UmeKitMemoryDetector().doDetect('HomePage');
          },
          child: Text('检测内存泄漏'),
        ),
      ),
    );
  }
}