Android内存泄漏检测工具LeakCanary上手指南

LeakCanary官方Demo介绍

• 首先可以去github上面downlaod它的官方开源Demo

• 用Android Studio打开leakcanary项目后，在leakcanary-sample ->MainAvtivity目录下可以看到内存泄漏示例

  
  
  
• 注释说明了此例子内存泄漏的原因：此AsyncTask是一个匿名的内部类，隐式的持有外部类（MainActivity）的引用，当activity被销毁的时候，如果AsyncTask（代码sleep 20秒，模拟了一个耗时操作）没有执行完成，则MainActivity将会泄漏。
• 运行Demo，点击启动异步线程的Button，在20秒内我们点手机返回键(就是关闭MainActivity的意思,这会让GC回收MainActivity)。
  -大概过了10秒左右，将会在通知栏看到一个内存泄漏的提示：

• 查看提示
  -总结：在这个例子中，可以看到是由于子线程的引用，导致GC无法回收MainActivity，引发了内存泄漏了(264KB)。

在项目中引入LeakCanary

1. 配置 build.gradle文件,添加后我们点Sync Now ，或者build一下

dependencies {
//debugCompile是设置仅在我们开发Debug的时候，LeakCanary才会帮我们去检测内存泄漏
   debugCompile 'com.squareup.leakcanary:leakcanary-android:1.4-beta2'
// releaseCompile是打包的时候LeakCanary不生效
   releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.4-beta2'
   testCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.4-beta2'
 }

2. 在项目里添加一个类叫MyApplication 继承自Application ，并在其中“安装” LeakCannary：

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        LeakCanary.install(this);
    }
}

• 记得把它作为 android:name 配到 AndroidManifest.xml 的 Application 节点下

完成这些步骤后就已经把环境基本上配置好了，不添加任何代码，LeakCanary会默认帮我们去检测Activity的内存泄漏。

写一个内存泄漏的Demo

• UI布局

• 在MainActivity中添加代码

public class MainActivity extends AppCompatActivity implements View.OnClickListener {
    private TextView mTv;
    private Button mButton;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mButton = (Button) findViewById(R.id.button);
        mButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                startAsyncTask();
            }
        });
    }

    public void startAsyncTask(){
        new AsyncTask(){
            @Override
            protected Void doInBackground(Void... params) {
                Log.v("家俊","doInBackground");
                SystemClock.sleep(10000);
                return null;
            }
        }.execute();
    }

• 运行代码，点击button后等待10秒，LeakCanary提示内存泄漏。

• 分析其中的原因：

• AsyncTask是一个匿名的内部类，隐式的持有外部类（MainActivity）的引用，当activity被销毁的时候，如果AsyncTask（代码sleep 20秒，模拟了一个耗时操作）没有执行完成，则MainActivity将会泄漏

• 关于隐式引用----内部类可以直接去调用外部类的成员(属性和方法)，如果没有持有外部类的引用，内部类是没办法去调用外部类的成员，但是内部类又没有显示的去指定声明引用，所以称之为隐式引用。

LeakCanary使用方式

1. 监控 Activity 泄露（默认）
   由于经常把 Activity 当作为 Context 对象使用,在不同场合由各种对象引用 Activity。所以,Activity 泄漏是一个重要的需要检查的内存泄漏之一。

2. 监控Fragment泄漏
   -使用RefWatcher监控
   此类的对象的获取方式：RefWatcher refWatcher=LeakCanary.install(this);
   可以在刚才自定义的全局MyApplication 中去获取。代码如下：

public class MyApplication extends Application {
    public static RefWatcher refWatcher;

    @Override
    public void onCreate() {
        super.onCreate();
        refWatcher = LeakCanary.install(this);
    }
}

然后，在需要检测Fragment回收的地方，加入refWatcher.watch(this);
-代码如下

public abstract class BaseFragment extends Fragment {
    @Override 
    public void onDestroy() {
        super.onDestroy();
        RefWatcher refWatcher = MyApplication.refWatcher;
        refWatcher.watch(this);
    }
}

当 Fragment.ondestroy()被调用之后，如果这个 fragment 实例没有被销毁，那么就会从通知栏和 logcat 里看到相应的泄漏信息。

3. 监控其他泄漏

  RefWatcher refWatcher = MyApplication.refWatcher;
  refWatcher.watch(someObjNeedGced);

someObjNeedGced标识我们需要监控的对象，当 someObjNeedGced 还在内存中时，就会在 logcat 里看到内存泄漏的提示。

原理

• LeakCanary 流程图
  
  
• LeakCanary 的机制如下：
  1.RefWatcher.watch() 会以监控对象来创建一个 KeyedWeakReference 弱引用对象
  2.在 AndroidWatchExecutor 的后台线程里，来检查弱引用已经被清除了，如果没被清除，则执行一次 GC
  3.如果弱引用对象仍然没有被清除，说明内存泄漏了，系统就导出 hprof 文件，保存在 app 的文件系统目录下
  4.HeapAnalyzerService 启动一个单独的进程，使用 HeapAnalyzer 来分析 hprof 文件。它使用另外一个开源库 HAHA。
  5.HeapAnalyzer 通过查找 KeyedWeakReference 弱引用对象来查找内在泄漏
  6.HeapAnalyzer 计算 KeyedWeakReference 所引用对象的最短强引用路径，来分析内存泄漏，并且构建出对象引用链出来。
  7.内存泄漏信息送回给 DisplayLeakService，它是运行在 app 进程里的一个服务。然后在设备通知栏显示内存泄漏信息。