Как LeakCanary понимает что утечка памяти произошла

Как LeakCanary определяет утечки памяти

LeakCanary — это инструмент для обнаружения утечек памяти в Android-приложениях. Он работает по принципу автоматического отслеживания утечек объектов после уничтожения контекста жизненного цикла (например, Activity или Fragment). Вот подробное объяснение механизма его работы.

Основной принцип обнаружения утечек

LeakCanary внедряется в приложение и начинает мониторинг объектов, которые должны быть уничтожены после завершения их жизненного цикла. Процесс включает несколько ключевых шагов:

1. Отслеживание уничтоженных объектов: LeakCanary использует ActivityLifecycleCallbacks и FragmentLifecycleCallbacks для автоматического обнаружения, когда Activity или Fragment уничтожаются. После этого он помечает эти объекты как "подозрительные" для утечки.

2. Сбор мусора и проверка ссылок: После уничтожения объекта LeakCanary явно вызывает System.gc() (сборку мусора), чтобы позволить JVM освободить память. Затем он проверяет, остался ли объект в памяти, используя WeakReference (слабые ссылки). Если объект доступен через WeakReference после GC, это означает, что он все ещё удерживается в памяти — потенциальная утечка.

Пример кода, иллюстрирующий логику проверки:

val weakRef = WeakReference(suspectedObject)
System.gc()
System.runFinalization()
if (weakRef.get() != null) {
    // Объект всё ещё в памяти — возможная утечка
    analyzeLeak(weakRef.get())
}

Анализ причин утечки

Если объект не был собран сборщиком мусора, LeakCanary выполняет анализ цепочки ссылок, чтобы найти причину утечки:

• Дамп памяти (Heap Dump): LeakCanary создаёт дамп памяти приложения с помощью Debug.dumpHprofData(). Этот дамп содержит информацию о всех объектах в памяти и их взаимных ссылках.
• Поиск пути удержания: Используя библиотеку Shark (или ранее HAHA), LeakCanary анализирует дамп, чтобы найти кратчайший путь удержания (shortest path to GC roots) для утекшего объекта. Этот путь показывает, какие объекты удерживают ссылку на подозрительный объект, предотвращая его удаление.

Пример структуры пути удержания в отчёте LeakCanary:

┬───
│   StaticField: MySingleton.instance
│   ├── MySingleton
│   └── Context
│       └── MainActivity (уничтожена)

В этом примере статическое поле MySingleton.instance удерживает контекст, который ссылается на уничтоженную Activity, вызывая утечку.

Ключевые компоненты LeakCanary

• ObjectWatcher: Отслеживает объекты, которые должны быть собраны GC. Реализует логику с WeakReference и триггерит анализ при обнаружении "застрявших" объектов.
• HeapDumper: Отвечает за создание дампа памяти в формате HPROF.
• HeapAnalyzer: Анализирует дамп памяти, используя алгоритмы обхода графов, чтобы найти пути удержания.
• DisplayLeakService: Показывает уведомления и детальные отчёты об утечках в интерфейсе приложения.

Настройка и кастомизация

LeakCanary можно настроить, например, задать пороговое время перед проверкой утечки или исключить определённые объекты из отслеживания. Конфигурация в Kotlin:

LeakCanary.config = LeakCanary.config.copy(
    watchDurationMillis = 5000, // Ждать 5 сек перед проверкой
    excludedRefs = ExcludedRefs.builder()
        .instanceField("com.example.MyClass", "staticField")
        .build()
)

Почему это работает эффективно?

• Автоматизация: LeakCanary автоматически обнаруживает утечки без ручного вмешательства.
• Наглядность: Он предоставляет чёткие визуальные отчёты с путями удержания, что упрощает исправление проблем.
• Интеграция с жизненным циклом: Благодаря отслеживанию жизненного цикла Android-компонентов, LeakCanary фокусируется на наиболее критичных утечках (например, утечках контекста).

Ограничения

• Производительность: Создание дампа памяти может замедлить приложение, поэтому в production-сборках LeakCanary обычно отключают.
• Ложные срабатывания: Иногда объекты могут временно удерживаться системой (например, в фоновых задачах), что приводит к ложным утечкам. Настройка временных задержек помогает минимизировать эту проблему.

В итоге, LeakCanary использует комбинацию отслеживания жизненного цикла, сборки мусора и анализа дампов памяти, чтобы точно определять и диагностировать утечки, делая его незаменимым инструментом для разработчиков Android.