Leakcanary的使用

LeakCanary是Android查找内存泄漏的主要工具，由Square公司开发，可以直接在手机端查看内存泄露的工具。其使用方法如下：
第一步：

    debugCompile 'com.squareup.leakcanary:leakcanary-android:1.6.1'
    releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.6.1'
    testCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.6.1'

第二步：

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        instance = this;

        if (LeakCanary.isInAnalyzerProcess(this)) {//1
            // This process is dedicated to LeakCanary for heap analysis.
            // You should not init your app in this process.

//            如果当前的进程是用来给LeakCanary 进行堆分析的则return，否则会执行LeakCanary的install方法。
//            这样我们就可以使用LeakCanary了，如果检测到某个Activity 有内存泄露，LeakCanary 就会给出提示。

            return;
        }
        LeakCanary.install(this);
    }
}

通过这两个步骤的，就可以使用Leakcanary来监控Activity的内存泄漏情况了，如果还想要监控Fragment的内存泄漏情况，则需要修改Application，修改后的代码如下所示：

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        instance = this;
	    refWatcher= setupLeakCanary();
    }

    private RefWatcher setupLeakCanary() {
        if (LeakCanary.isInAnalyzerProcess(this)) {
            // This process is dedicated to LeakCanary for heap analysis.
            // You should not init your app in this process.

//            如果当前的进程是用来给LeakCanary 进行堆分析的则return，否则会执行LeakCanary的install方法。
//            这样我们就可以使用LeakCanary了，如果检测到某个Activity 有内存泄露，LeakCanary 就会给出提示。

            return RefWatcher.DISABLED;
        }
        return LeakCanary.install(this);
    }

    public static RefWatcher getRefWatcher(Context context) {
        MyApplication leakApplication = (MyApplication) context.getApplicationContext();
        return leakApplication.refWatcher;
    }

}

install方法会返回RefWatcher用来监控对象，LeakApplication中还要提供getRefWatcher静态方法来返回全局RefWatcher。最后为了举例，我们在一段存在内存泄漏的代码中引入LeakCanary监控，如下所示:

public class InnerClassLeakActivity extends AppCompatActivity {
    private static Leak sLeak;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_leak_common);
        sLeak = new Leak();
        sLeak.test();

    }

    private class Leak {
        private void test(){
            LogUtil.i("test method execute");
        }
    }
    
    @Override
    protected void onDestroy() {
        super.onDestroy();
        RefWatcher refWatcher = MyApplication.getRefWatcher(this);
        refWatcher.watch(this);
    }
}

InnerClassLeakActivity 存在内存泄漏，因为非静态内部类Leak的静态实例对象sLeak持有外部类InnerClassLeakActivity 的实例，导致即使InnerClassLeakActivity 销毁了，InnerClassLeakActivity 也不能被GC回收。
由于Leakcanary自动监控Activity执行onDestroy方法之后是否发生内存泄露,当前此例onDestroy加是多余的，
这里只是为了方便举例，如果想要监控Fragment，在Fragment中添加如上的onDestroy方法是有用的。

通过不断的打开InnerClassLeakActivity和关闭这个页面，会出现
提示内容为“Dwnping memory app will 企eeze.Brrrr. ”。稍等一会儿，内存泄漏的信息就会出现在Notification,如下图所示：

点击上图中红框的条目，就可以看到如下图所示的，关于内存泄漏的详细信息：

通过展示的泄漏的详情，可以看到确实是InnerClassLeakActivity发生了内存泄漏，泄漏的原因就是
InnerClassLeakActivity.sLeak这个静态变量持有了InnerClassLeakActivity的实例导致，InnerClassLeakActivity 即使被销毁，也无法被GC回收，造成内存泄漏。解决这个内存泄漏的方法是，将sLeak这个静态变量改成非静态的即可。或者将非静态内部类Leak改成静态内部类。

使用时需要注意的点：
a.因为LeakCanary需要生成hprof文件，保存在SD卡里面，因此你的应用要先申请权限添加读写外部存储的权限，在安装应用后手动打开权限。

<!– 向SDCard写入数据权限 –>
<uses-permission android:name=“android.permission.WRITE_EXTERNAL_STORAGE”/>

b.将新添加leakcanary的activity和service属性android:enabled修改为true

c.有时候一直无法生成报告，输出如下log

LeakCanary: Could not dump heap, previous analysis still is in progress.

删除/sdcard/Download/leakcanary-包名/目录下的文件，再重新抓取一次。

d.如果报了如下异常：

java.lang.NullPointerException: Attempt to invoke virtual method’boolean java.lang.String.equals(java.lang.Object)’ on a null object reference
atcom.squareup.leakcanary.HeapAnalyzer.findLeakingReference(HeapAnalyzer.java:160)

是LeakCanary的版本过低了，不适合Android6.0及以上的机型，升级到1.5及以上版本的就没问题了。

参考：
android – LeakCanary报告在InputMethodManager中泄漏
http://www.voidcn.com/article/p-agkoubcz-bur.html

性能优化工具（九）-LeakCanary
https://www.jianshu.com/p/70b8c87ea877

LeakCanary使用经验小结
https://blog.csdn.net/zuo_er_lyf/article/details/79162017

Android系统App中使用Leakcanary
https://blog.csdn.net/abc_1234d/article/details/72478385