Android LeakCanary 使用

一、简介

LeakCanary 是 Square 公司开源的 Android 内存泄漏检测工具，通过自动化监控和堆转储分析，帮助开发者快速定位内存泄漏根源。其核心设计轻量高效，已成为 Android 开发中必备的调试工具。

二、使用方式

1. 集成步骤

在项目的 build.gradle 文件中添加依赖：

---
dependencies {debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.12' 
}
---

2. 自动初始化机制

通过 ContentProvider 实现无感初始化：

class MainProcessAppWatcherInstaller : ContentProvider() {override fun onCreate(): Boolean {val application = context!!.applicationContext as ApplicationAppWatcher.manualInstall(application) // 核心初始化入口return true}
}

优势：无需修改 Application 代码，系统自动完成初始化流程

3. 监控对象

默认监控范围：LeakCanary 自动检测以下对象的泄漏：

已销毁的 Activity 实例
Fragment 及其关联视图对象
已清理的 ViewModel 实例
Service 实例

手动监控：开发者可以对任意对象进行主动监控：

val watchedObject = MyObject()
AppWatcher.objectWatcher.watch(watchedObject,"MyObject is leaking"
)

4. 查看泄漏报告

通知栏提醒：检测到泄漏时，LeakCanary 会生成通知栏提示。

详细报告内容：

泄漏对象的引用链（从对象到 GC Root 的路径）。
泄漏原因分类（如静态变量、未解绑监听器等）。
可疑代码位置高亮。

5. 自定义配置

在 Application 中修改默认行为：

class MyApp : Application() {override fun onCreate() {super.onCreate()LeakCanary.config = LeakCanary.config.copy(dumpHeap = true,              // 是否生成 hprof 文件retainedVisibleThreshold = 3,  // 触发堆转储的阈值（默认5秒）referenceMatchers = listOf(    // 忽略特定引用IgnoredReferenceMatcher(pattern = "com.example.MyClass.staticField")))}
}

三、原理分析

1. 自动初始化与生命周期监控

1.1 ContentProvider 自动初始化

LeakCanary 通过 ContentProvider 实现零侵入初始化，核心逻辑在 MainProcessAppWatcherInstaller 中：

// 源码路径：leakcanary-object-watcher-android/src/main/java/leakcanary/internal/MainProcessAppWatcherInstaller.kt
class MainProcessAppWatcherInstaller : ContentProvider() {override fun onCreate(): Boolean {// 获取 Application 实例val application = context!!.applicationContext as Application// 调用 AppWatcher 手动安装AppWatcher.manualInstall(application)return true}// 其他方法空实现（query/insert 等）
}

触发时机：Android 系统在应用启动时自动初始化所有注册的 ContentProvider，通过 onCreate() 触发 LeakCanary 的初始化。

优势：无需开发者手动在 Application 中调用代码，实现完全自动化。

1.2 生命周期监控组件注册

在 AppWatcher.manualInstall() 中注册默认的监控组件：

// 源码路径：leakcanary-object-watcher-android/src/main/java/leakcanary/AppWatcher.kt
fun manualInstall(application: Application,watchersToInstall: List<InstallableWatcher> = appDefaultWatchers(application)
) {// 1. 初始化 InternalLeakCanaryLeakCanaryDelegate.loadLeakCanary(application)// 2. 注册四大监控组件watchersToInstall.forEach { it.install() }
}private fun appDefaultWatchers(application: Application): List<InstallableWatcher> {return listOf(ActivityWatcher(application, objectWatcher),FragmentAndViewModelWatcher(application, objectWatcher),RootViewWatcher(objectWatcher),ServiceWatcher(objectWatcher))
}

四大核心监控组件：

组件名称	监控目标	触发时机	实现原理
ActivityWatcher	Activity	onDestroy()	ActivityLifecycleCallbacks
FragmentWatcher	Fragment/ViewModel	onViewDestroyed()	FragmentManager 生命周期监听
RootViewWatcher	DecorView	onDetachedFromWindow	View.OnAttachStateListener
ServiceWatcher	Service	onDestroy()	Service 生命周期回调

典型监控流程（以 Activity 为例）：

// 源码路径：leakcanary-object-watcher-android/src/main/java/leakcanary/internal/ActivityWatcher.kt
class ActivityWatcher(private val application: Application,private val reachabilityWatcher: ReachabilityWatcher
) : InstallableWatcher {private val lifecycleCallbacks = object : Application.ActivityLifecycleCallbacks {override fun onActivityDestroyed(activity: Activity) {// 将 Activity 加入泄漏监控队列reachabilityWatcher.expectWeaklyReachable(activity, "${activity::class.java.name} received Activity#onDestroy()")}}override fun install() {application.registerActivityLifecycleCallbacks(lifecycleCallbacks)}
}

核心逻辑：通过 registerActivityLifecycleCallbacks 监听 onActivityDestroyed，触发对象泄漏检测。

2. 弱引用追踪系统

对象监控三要素：

KeyedWeakReference：携带唯一标识的弱引用。
ReferenceQueue：关联的回收队列。
ObjectWatcher：负责管理被监控对象。

// 源码路径：leakcanary-object-watcher/core/src/main/java/leakcanary/ObjectWatcher.kt
class ObjectWatcher {private val watchedObjects = mutableMapOf<String, KeyedWeakReference>()private val queue = ReferenceQueue<Any>()fun watch(target: Any, description: String) {val key = UUID.randomUUID().toString()val reference = KeyedWeakReference(target, key, description, queue)watchedObjects[key] = referencescheduleRetainedCheck()}private fun scheduleRetainedCheck() {checkRetainedExecutor {removeWeaklyReachableObjects()checkRetainedCount()}}
}

KeyedWeakReference：自定义弱引用，关联全局 ReferenceQueue，用于判断对象是否被回收。

class KeyedWeakReference(referent: Any,val key: String,val description: String,val watchUptimeMillis: Long,queue: ReferenceQueue<Any>
) : WeakReference<Any>(referent, queue)

2.2 回收检测流程

关键步骤，双阶段检测流程：

轮询队列：通过轮询 ReferenceQueue，移除已被回收的 KeyedWeakReference。
触发泄漏检测：若对象未被回收，调用 onObjectRetained() 通知监听器。

private fun removeWeaklyReachableObjects() {do {val ref = queue.poll() as? KeyedWeakReferenceref?.let { watchedObjects.remove(it.key) }} while (ref != null)
}private fun checkRetainedCount() {if (watchedObjects.size >= config.retainedVisibleThreshold) {onLeakDetected()}
}// onLeakDetected() 是 ObjectWatcher 中的一个方法，用于在检测到内存泄漏时触发后续的处理逻辑。
// onLeakDetected() 方法会遍历 onObjectRetainedListeners 列表，并调用每个监听器的     
// onObjectRetained() 方法。
private fun onLeakDetected() {// 1. 触发泄漏通知onObjectRetainedListeners.forEach { it.onObjectRetained() }
}// 源码路径：leakcanary-android-core/src/main/java/leakcanary/internal/HeapDumpTrigger.kt
override fun onObjectRetained() {scheduleRetainedObjectCheck()
}

3. 堆转储触发与堆分析

3.1 HeapDumpTrigger 调度

泄漏通知最终由 HeapDumpTrigger 处理：等待5s后，调用gc，如果持有的弱引用没有被清除，则被监视器认为产生了一个内存泄露，LeakCanary会将其记录到Logcat中；记录保留对象的计数，达到阈值后，会调用转储堆；

泄漏判定流程：

检测潜在泄漏对象。
主动触发 System.gc()。
二次确认存活状态。
生成 hprof 堆转储文件。
启动 Shark 分析引擎。

// 源码路径：leakcanary-android-core/src/main/java/leakcanary/internal/HeapDumpTrigger.kt
class HeapDumpTrigger(private val application: Application,private val backgroundHandler: Handler,private val objectWatcher: ObjectWatcher,private val gcTrigger: GcTrigger,private val configProvider: () -> Config
) {fun scheduleRetainedObjectCheck() {backgroundHandler.postDelayed({checkRetainedObjects()}, 0)}private fun checkRetainedObjects() {// 1. 检查未被回收的对象数量val retainedCount = objectWatcher.retainedObjectCountif (retainedCount > 0) {// 2. 主动触发 GCgcTrigger.runGc()// 3. 再次检查，确认泄漏if (objectWatcher.retainedObjectCount >= configProvider().retainedVisibleThreshold) {// 4. 生成堆转储dumpHeap(retainedCount, reason = "Retained objects ≥ threshold")}}}
}

主动触发 GC：

object Default : GcTrigger {override fun runGc() {Runtime.getRuntime().gc()Thread.sleep(100)System.runFinalization()}
}

3.2 堆转储生成

private fun dumpHeap(retainedReferenceCount: Int, reason: String) {// 1. 创建堆转储文件val heapDumpFile = InternalLeakCanary.createLeakDirectoryProvider(application).newHeapDumpFile()// 2. 调用 Android API 生成 hprof 文件Debug.dumpHprofData(heapDumpFile.absolutePath)// 3. 发送分析任务InternalLeakCanary.sendEvent(HeapDump(heapDumpFile, reason))
}

3.3 堆分析引擎（Shark 库）

堆分析由 BackgroundThreadHeapAnalyzer 在后台线程执行：

// 源码路径：leakcanary-android-core/src/main/java/leakcanary/internal/BackgroundThreadHeapAnalyzer.kt
object BackgroundThreadHeapAnalyzer : EventListener {private val handlerThread = HandlerThread("HeapAnalyzer")override fun onEvent(event: Event) {if (event is HeapDump) {handlerThread.handler.post {// 使用 Shark 库解析 hprofval result = SharkHelper.analyze(event.heapDumpFile)// 生成泄漏报告showResult(result)}}}
}

Shark 分析引擎四步法：

流式解析：分块读取避免内存溢出。
索引构建：建立快速查找表。
泄漏追踪：BFS 算法查找 GC Root 路径。
结果聚合：生成可视化报告。

4. 检测流程

四、泄漏报告解读与处理

1. 报告输出渠道

通知栏：点击查看详细堆栈。
Logcat：打印完整引用链信息。
Toast：提示内存泄漏发生。
桌面报告文件：/sdcard/Download/leakcanary-{package}/ 目录。

// 源码路径：leakcanary-android-core/src/main/java/leakcanary/EventListener.kt
object LogcatEventListener : EventListener {override fun onEvent(event: Event) {if (event is HeapAnalysisDone) {Log.d("LeakCanary", event.heapAnalysis.toString())}}
}object NotificationEventListener : EventListener {override fun onEvent(event: Event) {if (event is HeapAnalysisDone) {showNotification(event.heapAnalysis)}}
}

2. 典型报告结构

┬───
│ GC Root: 静态变量 com.example.AppConfig.sInstance
│
├─ com.example.UserManager 实例
│    ↓ 静态 UserManager.currentActivity
├─ com.example.MainActivity 实例
│    ↓ 匿名内部类持有外部引用
╰→ 泄漏点: MainActivity$1.class

3. 常见泄漏模式

泄漏类型	典型场景	解决方案
静态引用	单例持有 Activity 引用	改用 `WeakReference`
匿名内部类	`Handler` 未及时移除	使用静态内部类 + 弱引用
未解绑监听	注册系统服务未反注册	生命周期配对解除
资源未关闭	文件流/`Cursor` 未关闭	使用 `try-with-resources`

五、高级优化策略

1. 生产环境配置

LeakCanary.config = LeakCanary.config.copy(dumpHeap = BuildConfig.DEBUG,analysisPeriodMillis = 120_000,referenceMatchers = listOf(IgnoredReferenceMatcher(className = "com.example.SDKManager",fieldName = "mContext"))
)