需求痛点:leakCanary虽然很傻瓜了,但是必须要手动点开通知才能看到泄露信息,如果自动测试就无法保存现场。自动跑monkey和mtbf时,出现了内存泄露,但是没有抓取到相关的信息,无法分析,明知道有泄露但是无法找到原因,非常痛苦。
适用范围:仅适用于java层的内存泄露,基于leakCanary源码实现。
编译配置:
在gradle中编译,可参考源码中的引用方式,在build.gradle中添加如下配置。
dependencies{
debugCompile project(':leakcanary-android')
releaseCompile project(':leakcanary-android-no-op');
}
在源码中编译,Android.mk文件中配置如下。并将相应jar包拷贝到对应目录下(此处为libs),并保证名字相同。jar包获取地址:auto-leak-detect.rar
LOCAL_AAPT_FLAGS := --auto-add-overlay
LOCAL_AAPT_FLAGS += --extra-packages com.squareup.leakcanary
LOCAL_STATIC_JAVA_LIBRARIES += dpt-haha-2.0.3.jar
LOCAL_STATIC_JAVA_AAR_LIBRARIES := \
dpt-leakcanary-watcher-1.4-beta2 \
dpt-leakcanary-analyzer-1.4-beta2 \
dpt-leakcanary-android-1.4-beta2 \
LOCAL_PREBUILT_STATIC_JAVA_LIBRARIES := \
dpt-haha-2.0.3:libs/haha-2.0.3.jar \
dpt-leakcanary-analyzer-1.4-beta2:libs/leakcanary-analyzer-1.4-beta2.aar \
dpt-leakcanary-watcher-1.4-beta2:libs/leakcanary-watcher-1.4-beta2.aar \
dpt-leakcanary-android-1.4-beta2:libs/leakcanary-android-1.4-beta2.aar \
源码编译方式可参考邮件的提交:http://diana.devops.letv.com/#/c/257105/
如果需要加入混淆,请在混淆配置文件中加入如下配置,这个配置在源码的混淆文件中就有,拷贝过来列在下面。
-dontwarn com.squareup.haha.guava.**
-dontwarn com.squareup.haha.perflib.**
-dontwarn com.squareup.haha.trove.**
-dontwarn com.squareup.leakcanary.**
-keep class com.squareup.haha.** { *; }
-keep class com.squareup.leakcanary.** { *; }
# Marshmallow removed Notification.setLatestEventInfo()
-dontwarn android.app.Notification
使用方式:
在自定义的Application中调用LeakCanary.install(this);
获取自动保存的文件并分析:
在原来打开通知栏时,我们会看到一个如下图所示的列表,列表中每项都代表一个泄露,打开其中一项后,会有一个泄露的堆栈信息。
以源码中的samle apk为例,产生的文件保存在/sdcard/Download/leakcanary-com.example.leakcanary中,此处com.example.leakcanary根据被检查的宿主apk命名。打开文件夹,如下面左图所示。
其中后缀名为.leakinfo的文件,就是我们自动加上的文件,打开其中一个查看,与上面的右图中的堆栈信息一一对应。看看has leaked:后面的堆栈信息,如上面右图中的堆栈信息是一样的:root是一个Thread,references代表引用了一个对象,这里是com.example.leakcanary.MainActivity$2.this$0,这个可能有多个。最后leaks com.example.leakcanary.MainActivity instance代表导致了一个MainActivity的泄露。当然,文件中有比上图中更丰富的信息,有兴趣的同学可以再研究。
原理分析:
在源码中,分析完内存堆栈后,会直接生成一个Notification,同时还会保留一份dump出来的堆栈信息。但是,这个堆栈信息是不可读的,我们只要把他转换为可读信息,然后保存就好了。
代码:就是重写DisplayLeakService.java文件中的afterDefaultHandling这个方法。完整的工程源码请参考git地址:https://github.com/hhhqq/leakcanary/tree/master/leakcanary-android/src/main/java/com/squareup/leakcanary
/**
* You can override this method and do a blocking call to a server to upload the leak trace and
* the heap dump. Don't forget to check {@link AnalysisResult#leakFound} and {@link
* AnalysisResult#excludedLeak} first.
*/
protected voidafterDefaultHandling(HeapDump heapDump,AnalysisResult result,String leakInfo) {
booleanshouldSaveResult = result.leakFound|| result.failure!=null;
if(shouldSaveResult) {
saveResult2(heapDump,result,leakInfo);
}
}
private booleansaveResult2(HeapDump heapDump,AnalysisResult result,String leakInfo) {
File resultFile =newFile(heapDump.heapDumpFile.getParentFile(),
heapDump.heapDumpFile.getName() +".leakinfo");
FileOutputStream fos =null;
try{
fos =newFileOutputStream(resultFile);
fos.write(leakInfo.getBytes());
return true;
}catch(IOException e) {
CanaryLog.d(e,"Could not save leakInfo analysis result to disk.");
}finally{
if(fos !=null) {
try{
fos.close();
}catch(IOException ignored) {
}
}
}
return false;
}