問題起源
大家現在都在用 LeakCanary 來做內存泄漏的檢測,引入方式比較簡單。
在 LeakCanary 2.0 之前
dependencies {
debugImplementation 'com.squareup.leakcanary:leakcanary-android:1.5'
}
以及在 Application 的 onCreate:
LeakCanary.install(this);
在 LeakCanary 2.0 之後,LeakCanary.install(this) 不必由開發者再自己手動寫了,因爲使用了 contentprovider 來自動完成
internal sealed class AppWatcherInstaller : ContentProvider() {
override fun onCreate(): Boolean {
val application = context!!.applicationContext as Application
InternalAppWatcher.install(application)
return true
}
}
安裝以後,我們會看到生成了一個 Leaks 的桌面圖標
導入一個庫,卻生成了另外的桌面圖標,這是爲什麼呢?
問題探究
點開 Leaks 圖標,dump 出 top activity 或者其他工具,可以知道打開的Activity 是 DisplayLeakActivity,我們到 github 上找 LeakCanary 源碼(Tag 1.5),在庫中搜索 DisplayLeakActivity
可以輕易找到
<activity
android:theme="@style/leak_canary_LeakCanary.Base"
android:name=".internal.DisplayLeakActivity"
android:process=":leakcanary"
android:enabled="false"
android:label="@string/leak_canary_display_activity_label"
android:icon="@mipmap/leak_canary_icon"
android:taskAffinity="com.squareup.leakcanary.${applicationId}"
>
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
</intent-filter>
</activity>
原來這個 DisplayLeakActivity 也定義了 <action android:name="android.intent.action.MAIN"/> 以及 <category android:name="android.intent.category.LAUNCHER"/>
,所以也可出現在應用程序列表上。
上面是 LeakCanary 1.5 的實現,那麼 LeakCanary 2.0 是怎麼實現的呢
<activity
android:name="leakcanary.internal.activity.LeakActivity"
android:icon="@mipmap/leak_canary_icon"
android:label="@string/leak_canary_display_activity_label"
android:taskAffinity="com.squareup.leakcanary.${applicationId}"
android:theme="@style/leak_canary_LeakCanary.Base"
/>
<activity-alias
android:name="leakcanary.internal.activity.LeakLauncherActivity"
android:enabled="@bool/leak_canary_add_launcher_icon"
android:icon="@mipmap/leak_canary_icon"
android:label="@string/leak_canary_display_activity_label"
android:targetActivity="leakcanary.internal.activity.LeakActivity"
android:taskAffinity="com.squareup.leakcanary.${applicationId}"
android:theme="@style/leak_canary_LeakCanary.Base"
>
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
</intent-filter>
</activity-alias>
這裏可以看到,LeakCanary 生成圖標的方式改變爲使用 activity-alias 實現。顧名思義,activity-alias 可以指定 targetActivity,然後成爲這個 targetActivity 的別名,一般供 Launcher 判別使用。注意,這個 activity-alias 僅作爲標記使用,並沒有 class 類,並通過 enabled 屬性來確認是否啓用。關於這個 activity-alias 的使用,可以用來動態替換圖標,參考這篇文章:
上次發版我就改了一行代碼
LeakCanary 原理總結
我們先來看一張架構圖(來自LeakCanary 源碼分析):
整體過程就是,LeakCanary 會將監視的 activity 在 Lifecycle 的 onDestroy 階段,使用弱引用 WeakReference 包裝,並且添加到 ReferenceQueue 中,添加後,開啓 ensureGone 方法,移除不可達對象或者再次觸發 GC,判斷監視對象是否還存在 ReferenceQueue 中。如果存在,則使用 Debug.dumpHprofData 生成堆內存快照 hprof 文件,hprof 文件具有固定格式,因此分析堆內存的各個對象的引用鏈,在引用鏈上的 GCroot 或者其他一些明確的對象是不需要分析的,因此標記爲 leaking:no 或者 leaking unknown,直到找到第一個 leaking:yes 的對象,這個對象就是內存泄漏點。