第4章 LeakCanary 集成与配置：依赖引入、版本选择、白名单设置、日志输出解读

4.1 现象识别——LeakCanary 不工作或误报

当 LeakCanary 未正确集成时，开发者通常遇到以下三类现象：

• 静默失效：发生内存泄漏后，通知栏无泄漏图标、Logcat 无 LeakCanary 输出、Heap dump 未生成。
• 启动崩溃：Application 初始化阶段抛出 ClassNotFoundException 或 NoClassDefFoundError。
• 误报 / 白名单遗漏：每次 Activity 销毁都报告泄漏，但实际是系统缓存或框架对象，导致无效告警淹没有效泄漏。

4.2 数据采集——获取配置信息与日志

1. 确认依赖生效：查看 .gradle 缓存或依赖树

   ./gradlew :app:dependencies --configuration debugImplementation

2. 抓取 LeakCanary 自身日志：过滤 Logcat tag LeakCanary、LeakCanary-Info、LeakCanary-Debug。典型有效日志：

   D/LeakCanary: LeakCanary is running, ready to detect leaks.
   D/LeakCanary: Watching activity com.example.MainActivity (fragment accepted)
   D/LeakCanary: Scheduling check for retained instances in 5 seconds
   D/LeakCanary: Analysis in progress, working on retained instances...
   D/LeakCanary: Heap dump file path: /data/data/com.example/cache/leakcanary/xxx.hprof

3. 获取 Heap dump 文件：通过 Device File Explorer 提取 /data/data/{package}/cache/leakcanary/ 目录下的 .hprof。
4. 白名单配置检查：在 Logcat 过滤 IgnoredClassReachability 可看到哪些类被跳过。例如：

   LeakCanary: IgnoredClassReachability: android.arch.lifecycle.ReportFragment injected by framework - ignoring.

4.3 原因定位——故障树分析法

4.4 修复动作——依赖引入、版本选择、白名单配置

4.4.1 依赖坐标与版本选择规则

4.4.2 build.gradle 正确配置示例

// app/build.gradle
android {
    // ...
    buildTypes {
        release {
            // 确保 release 构建下没有 LeakCanary 的自动 dump
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    // 仅在 debug 变体引入
    debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.13'
    // release 变体使用 no-op 空模块
    releaseImplementation 'com.squareup.leakcanary:leakcanary-android-no-op:2.13'
    // 可选：测试变体也启用
    testImplementation 'com.squareup.leakcanary:leakcanary-android-no-op:2.13'
}

4.4.3 白名单设置方法

白名单用于跳过已知不构成泄漏的系统对象或框架缓存。在 assets/leakcanary-ignored-classes.txt 中配置，一行一个类全限定名：

# Android framework 常见误报
android.arch.lifecycle.ReportFragment
android.app.ActivityManager
com.android.internal.policy.DecorView
android.view.inputmethod.InputMethodManager

# 第三方 SDK 缓存
com.example.sdk.CommonCache
com.bumptech.glide.manager.SupportRequestManagerFragment

# 自定义接口回调（确认生命周期正确时）
com.example.app.GlobalCallback

4.4.4 ProGuard / R8 保留规则

若使用混淆，必须保留 LeakCanary 内部类和泄漏分析器：

-keep class leakcanary.** { *; }
-keep class shark.** { *; }
# 如果你手动 install，保留 Application 子类中的 install 调用
-keepclasseswithmembers class * extends android.app.Application {
    public void onCreate();
}

4.5 复测——验证集成生效

1. 验证依赖生效：在 Application 启动时加一行日志 Log.d("LeakCheck", "LeakCanary installed: " + LeakCanary.isInAnalyzerProcess);（仅在 debug 下）。
2. 制造人工泄漏：在 Activity 中持有静态 Context 引用，然后快速旋转屏幕，观察 5 秒后是否出现通知。
3. 检查白名单日志：过滤 IgnoredClass，确认系统类被正确跳过。
4. 验证 release 包无影响：切换 build variant 到 release，确认 apk 中不包含 leakcanary 相关类（可通过反编译或检查 dex 字节数）。

4.6 预防——集成规范 checklist