LeakCanary监听Fragment、Fragment View、ViewModel销毁

2023-11-01 15:09:22

LeakCanary：深入探究它如何监听 Fragment、Fragment View 和 ViewModel 的销毁时机

简介

内存泄漏一直困扰着 Android 开发人员，即使是经验丰富的程序员也可能无意中制造内存泄漏，导致应用程序性能下降甚至崩溃。LeakCanary 是一个流行的内存泄漏检测库，它可以通过识别和修复内存泄漏来帮助开发人员解决这个问题。

LeakCanary 如何工作

LeakCanary 通过在应用程序中注入一个“金丝雀”对象来检测内存泄漏。当这个金丝雀对象被垃圾回收器回收时，LeakCanary 会生成一个堆转储，并分析其中的对象以找出潜在的内存泄漏。

LeakCanary 如何监听 Fragment 销毁时机

LeakCanary 通过监听 FragmentManager 的 registerFragmentLifecycleCallbacks 方法来监听 Fragment 销毁时机。当一个 Fragment 添加到 FragmentManager 中时，LeakCanary 会向 FragmentManager 中添加一个 FragmentLifecycleCallbacks 实例。该 FragmentLifecycleCallbacks 实例实现了 onFragmentDestroyed 方法，该方法会在 Fragment 被销毁时被调用。

在 onFragmentDestroyed 方法中，LeakCanary 会检查 Fragment 是否持有对 Activity 的强引用。如果是，则 LeakCanary 会将 Fragment 添加到一个弱引用集合中。在应用程序退出时，LeakCanary 会遍历这个弱引用集合，并生成任何仍然持有对 Activity 的强引用的 Fragment 的堆转储。

LeakCanary 如何监听 Fragment View 销毁时机

LeakCanary 通过监听 ViewTreeObserver 的 addOnGlobalLayoutListener 方法来监听 Fragment View 销毁时机。当一个 Fragment View 添加到窗口中时，LeakCanary 会向 ViewTreeObserver 中添加一个 ViewTreeObserver.OnGlobalLayoutListener 实例。该 ViewTreeObserver.OnGlobalLayoutListener 实例实现了 onGlobalLayout 方法，该方法会在 Fragment View 从窗口中移除时被调用。

在 onGlobalLayout 方法中，LeakCanary 会检查 Fragment View 是否持有对 Fragment 的强引用。如果是，则 LeakCanary 会将 Fragment View 添加到一个弱引用集合中。在应用程序退出时，LeakCanary 会遍历这个弱引用集合，并生成任何仍然持有对 Fragment 的强引用的 Fragment View 的堆转储。

LeakCanary 如何监听 ViewModel 销毁时机

LeakCanary 通过监听 ViewModelStore 的 addOnClearedListener 方法来监听 ViewModel 销毁时机。当一个 ViewModel 添加到 ViewModelStore 中时，LeakCanary 会向 ViewModelStore 中添加一个 ViewModelStore.OnClearedListener 实例。该 ViewModelStore.OnClearedListener 实例实现了 onCleared 方法，该方法会在 ViewModel 被清除时被调用。

在 onCleared 方法中，LeakCanary 会检查 ViewModel 是否持有对 Activity 或 Fragment 的强引用。如果是，则 LeakCanary 会将 ViewModel 添加到一个弱引用集合中。在应用程序退出时，LeakCanary 会遍历这个弱引用集合，并生成任何仍然持有对 Activity 或 Fragment 的强引用的 ViewModel 的堆转储。

代码示例

以下代码示例展示了如何使用 LeakCanary 监听 Fragment 销毁时机：

public class MyFragment extends Fragment {

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Register FragmentLifecycleCallbacks with LeakCanary
        LeakCanary.getInstance().addFragmentLifecycleCallbacks(new FragmentLifecycleCallbacks() {
            @Override
            public void onFragmentDestroyed(FragmentManager fm, Fragment f) {
                super.onFragmentDestroyed(fm, f);

                // Check if the Fragment holds a strong reference to the Activity
                if (f.getActivity() != null) {
                    // Add the Fragment to a weak reference collection
                    LeakCanary.getInstance().addWeakReference(f);
                }
            }
        });
    }
}