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"))
)