Java是什么?
Java历史
Java语言特点
C++ VS Java比较
Java工厂设计模式
Java抽象工厂模式
Java单例模式
Java建造者(Builder)模式
Java原型模式
Java适配器模式
Java桥接模式
Java获取网络文件大小
Java套接字到单一的客户端
Java连接套接字
Java URL部分
Java URL连接日期
Java下载网页
Java主机指定IP地址
Java确定本地IP地址
Java检查端口占用
Java查找代理服务器设置
Java创建Socket
Java线程实例
Java检查线程活着
Java如何检查一个线程停止或没有?
Java解决死锁实例
Java如何获取正在运行的线程的优先级?
Java如何监视线程的状态?
Java获取线程名称
Java线程生产者消费者问题
Java如何设置线程的优先级?
Java如何停止线程一会儿?
Java如何暂停线程?
Java获取线程ID
Java如何检查线程的优先级?
Java显示所有正在运行的线程?
Java显示线程状态
Java中断一个线程
Java Applet实例
Java创建Applet
Java使用Applet创建横幅
Java使用Applet显示时钟?
Java在一个Applet创建不同形状
Java如何使用Applet填充形状的颜色?
Java使用Applet跳转到一个链接
Java在Applet创建事件监听器
Java使用Applet显示图像
Java使用Applet在新窗口中打开链接
Java使用Applet播放声音?
Java使用Applet读取文件
Java使用Applet写入文件
Java中Swing应用程序applet
Java简单的图形用户界面-GUI
Java以不同的字体显示文本
Java使用GUI画一条线
Java创建框架-frame
Java使用GUI显示多边形
Java在矩形中显示文本
Java GUI显示不同形状
Java如何绘制GUI实心矩形?
Java创建GUI透明光标
Java检查GUI平滑处理状态
Java在框架中显示颜色
Java GUI显示饼图
Java使用图形用户界面绘制文本
Java编辑表-table
Java 使用prepared语句
Java使用保存点和回滚
Java同时执行数据库多个SQL命令
Java使用行方法
Java使用列方法
Java正则表达式实例
Java将字符串分割
Java搜索重复单词
Java查找出现的单词
Java最后一个词的索引
Java模式匹配
Java删除空格
Java匹配电话号码
Java计数组词
Java搜索词组
Java拆分正则表达式
Java替换第一个出现字符串
Java检查日期格式
Java验证电子邮件地址格式
Java替换所有匹配字符串
Java使每个单词的第一个字母大写
从XML创建SqlSessionFactory实例
不使用XML来创建SqlSessionFactory
从SqlSessionFactory获取SqlSession
映射SQL语句
作用域和生命周期
Mapper XML配置
properties元素
Settings元素
typeAliases 元素
typeHandlers元素
理解CacheLine与写出更好的JAVA
Java核心技术点之动态代理
更好的使用JAVA线程池
理解Java中字符流与字节流的区别
深入分析Java方法反射的实现原理
关于Java面试,你应该准备这些知识点
Java内存模型
2017年你不能错过的Java类库
Leakcanary Square的一款Android/Java内存泄漏检测工具
Java Synchronised机制
Java核心技术点之注解
JVM(8):JVM知识点总览-高级Java工程师面试必备
JVM(3):Java GC算法 垃圾收集器
JVM(1):Java 类的加载机制
解决ActiveMQ中,Java与C++交互中文乱码问题
关于Java Collections的几个常见问题
Java I/O 总结
JVM源码分析之Java对象的创建过程
JVM源码分析之Java类的加载过程
Java GC的那些事(下)
Java GC的那些事(上)
java对象头的HotSpot实现分析
面试的角度诠释Java工程师(一)
面试的角度诠释Java工程师(二)
框架开发之Java注解的妙用
谈谈Java反射机制
Java并发:volatile内存可见性和指令重排
死磕Java并发:Java内存模型之happens-before
死磕Java并发:深入分析volatile的实现原理
死磕Java并发:深入分析synchronized的实现原理
Java 10 可能对 Lambda 表达式进行升级
G1垃圾回收器中的字符串去重(Java 8 Update 20)
Java RESTful框架的性能比较
理解RxJava的线程模型
继续了解Java的纤程库 – Quasar
Java中的纤程库 – Quasar
Java豆瓣电影爬虫——抓取电影详情和电影短评数据
Java集合框架源码剖析:LinkedHashSet 和 LinkedHashMap
Java Lambda表达式初探
Java中的陷阱题
Java 9的这一基本功能,你可能从未听过
关于Java并发编程的总结和思考
几种简单的负载均衡算法及其Java代码实现
JAVA虚拟机关闭钩子(Shutdown Hook)
Java 脚本化编程指南
Java Scripting API 使用示例
Java 8 的 Nashorn 脚本引擎教程
如何开始使用 Java 机器学习
CognitiveJ —— Java 的图像分析库
Java 性能优化的五大技巧
Java 解惑:Comparable 和 Comparator 的区别
Google Java编程风格指南
java NIO详解
Java 异常处理的误区和经验总结
Java语法糖(4):内部类
Java语法糖(3):泛型
Java语法糖(2):自动装箱和自动拆箱
Java消息队列任务的平滑关闭
Java语法糖(1):可变长度参数以及foreach循环原理
2016最流行的Java EE服务器
自己写一个java.lang.reflect.Proxy代理的实现
java 如何在pdf中生成表格
如何防止单例模式被JAVA反射攻击
java虚拟机 jvm 局部变量表实战
聊聊并发-Java中的Copy-On-Write容器
java.lang.Instrument 代理Agent使用
Java开发者需要了解的移动开发编程语言
13个不容错过的Java项目
2016年7款最佳 Java 框架推荐
Java 开发者值得关注的 11 个技术博客
Redmonk发布Java框架流行度调研结果
Java 8开发的4大顶级技巧
GitHub漫游指南:10个值得你关注的Java项目
除了Guava,Java开发者还值得了解的5个谷歌类库
Java中创建对象的5种不同方法
Java性能优化全攻略
奇怪的Java题:为什么1000 == 1000返回为False,而100 == 100会返回为True?
11个最值得Java开发者收藏的网站
Java的常见误区与细节
对Java意义重大的7个性能指标
Java调优经验谈
关于Java并发编程的总结和思考
HDFS Federation设计动机与基本原理
《Effective STL》学习笔记(第三部分)
《Effective STL》学习笔记(第二部分)
《Effective STL》学习笔记(第一部分)
数据结构之位图
Thrift使用指南
Cassandra概要介绍
Cassandra部署与安装
Cassandra客户端
Cassandra数据模型
Cassandra中的各种策略
数据结构之树状数组
数据结构之伸展树
数据结构之后缀数组
数据结构之堆
浅析MRv1与MRv2的API兼容性
Apache Tez最新进展
运行在YARN上的计算框架
从传统操作系统角度理解Hadoop YARN

Leakcanary Square的一款Android/Java内存泄漏检测工具

于2017-05-10由小牛君创建

分享到:


git地址: square/leakcanary

git readme:

中文翻译@Jacksgong

一款Android与Java的内存检测库

“A small leak will sink a gret ship.” – Benjamin Franklin

I. 开始

build.gradle 中的配置:

dependencies {
   debugCompile 'com.squareup.leakcanary:leakcanary-android:1.3'
   releaseCompile 'com.squareup.leakcanary:leakcanary-android-no-op:1.3'
 }

Application class 中的配置:

public class ExampleApplication extends Application {
  @Override public void onCreate() {
    super.onCreate();
    LeakCanary.install(this);
  }
}

这样就可以了! 在debug包中activity内存泄漏将会被监听到,并且将会自动显示一个通知(show a notification)。

II. 为什么要使用LeakCanary?

好问题! 我们已经在 博客文章中回答了这个问题。

III. 应该怎么使用它呢?

使用RefWatcher来监听引用是否已经被GC:

RefWatcher refWatcher = {...};
// We expect schrodingerCat to be gone soon (or not), let's watch it.
// 我们预测shcrodingerCat很快会销毁(也许不会),这里监听了它.
refWatcher.watch(schrodingerCat);

LeakCanary.install()会返回预设的RefWatcher,并且安装了一个ActivityRefWatcher来监听activity调用了Activity.onDestroy()以后的泄漏。

public class ExampleApplication extends Application {
  public static RefWatcher getRefWatcher(Context context) {
    ExampleApplication application = (ExampleApplication) context.getApplicationContext();
    return application.refWatcher;
  }
  private RefWatcher refWatcher;
  @Override public void onCreate() {
    super.onCreate();
    refWatcher = LeakCanary.install(this);
  }
}

你也可以使用RefWatcher来监听fragment的泄漏:

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

IV. LeakCanary是如何工作的呢?

  1. RefWatcher.watch()创建了一个KeyedWeakReference到了监控的对象。
  2. 之后,在后台线程,它检查引用是否已经被释放,如果没有它将促发一次GC。
  3. 如果引用依然没有被释放,它会导出heap到存储在app文件系统的a.hprof文件。
  4. HeapAnalyzerService在单独的一个进程被启动,并且HeapAnalyzer使用HAHA来解析heap。
  5. HeapAnalyzer由于采用了单独的reference key,在heap dump中找到了KeyedWeakReference并且定位到泄漏的引用。
  6. HeapAnalyzer通过计算出到GC根部最短路径的强引用来决定是否这里是泄漏了,并且建立导致泄漏的引用关系链。
  7. 结果将传回在app进程的DisplayLeakService,并且显示泄漏通知。

V. 我应该如何拷贝leak trace呢?

可以在Logcat中看到leak trace:

In com.example.leakcanary:1.0:1 com.example.leakcanary.MainActivity has leaked:
* GC ROOT thread java.lang.Thread.<Java Local> (named 'AsyncTask #1')
* references com.example.leakcanary.MainActivity$3.this$0 (anonymous class extends android.os.AsyncTask)
* leaks com.example.leakcanary.MainActivity instance
* Reference Key: e71f3bf5-d786-4145-8539-584afaecad1d
* Device: Genymotion generic Google Nexus 6 - 5.1.0 - API 22 - 1440x2560 vbox86p
* Android Version: 5.1 API: 22

也可以从action bar menu分享leak trace与heap dump文件。

VI. 应该如何解决内存泄漏呢?

一旦拥有了leak trace,就可以分析出哪个路径中的引用不应该存在,然后分析出引用依然存在的原因。通常情况是注册的监听没有反注册,或者是close()方法没有调用,或者是一个未知的类((通常也是没有句柄的对象,就纯new出来执行了某方法)hold住了外部类的引用。如果你分析不出你代码中的问题,别放弃,可以在Stack Overflow question(使用leakcanary 标签)中创建相关问题。

VII. 我的泄漏是因为执行Android SDK导致的!

随着时间的推移,已经有一些已知的由于Android SDK的执行导致的内存泄漏得到了作为生厂商AOSP的修复。当发生这样的内存泄漏的时候,其实我们作为应用开发者能做的很少。对于这样的问题,LeakCanary已经有内建了一个忽略已知Android SDK泄漏的列表: AndroidExcludedRefs.java。如果你发现了新的,请提供leak trace、reference key、设备版本与Android版来创建问题,当然如果能够提供一个heap dump的文件连接更好。

这对于新发布的Android来说是特别重要的,你有机会能够帮助尽早发现新的内存泄漏,使整个Android社区受益。

开发版本的快照: Sonatype’s snapshots repository

VIII. 超出leak trace范围

通常leak trace是不够的,还需要通过MAT或者YourKit来深挖heap dump,下面是你如何通过heap dump来找出泄漏:

  1. 找到com.squareup.leakcanary.KeyedWeakReference所有的实例。
  2. 对于每个实例,查看它的key成员变量。
  3. 找到包含与LeakCanary报出的reference key相同key成员变量的KeyedWeakReference
  4. 那么这个KeyedWeakReference中的reference成员变量,就是你泄漏了的对象。
  5. 到此为止,剩余的工作就是,开始查找到GC Roots最短路径(不包含弱引用)。

IX. 定制

图标与标注(Icon and Label)

DisplayLeakActivity默认是使用默认的图标与标注,当然你可以通过在你的app中提供R.drawable.__leak_canary_iconR.string.__leak_canary_display_activity_label来定制这个:

res/
drawable-hdpi/
__leak_canary_icon.png
drawable-mdpi/
__leak_canary_icon.png
drawable-xhdpi/
__leak_canary_icon.png
drawable-xxhdpi/
__leak_canary_icon.png
drawable-xxxhdpi/
__leak_canary_icon.png
<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string name="__leak_canary_display_activity_label">MyLeaks</string>
</resources>

存储leak traces

DisplayLeakActivity最多在app目录中存储7个heap dumps与leak traces 文件。你可以通过在你的app中提供R.integer.__leak_canary_max_stored_leaks来定制这个:

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <integer name="__leak_canary_max_stored_leaks">20</integer>
</resources>

上传到服务器

可以通过修改默认的行为来上传leak trace与heap dump到指定的服务器。

创建一个你自己的AbstractAnalysisResultService。最简单的方法是在debug的app中继承DefaultAnalysisResultService:

public class LeakUploadService extends DefaultAnalysisResultService {
  @Override protected void afterDefaultHandling(HeapDump heapDump, AnalysisResult result, String leakInfo) {
    if (!result.leakFound || result.excludedLeak) {
      return;
    }
    myServer.uploadLeakBlocking(heapDump.heapDumpFile, leakInfo);
  }
}

要确认发布的Application类使用无效的RefWatcher:

public class ExampleApplication extends Application {
  public static RefWatcher getRefWatcher(Context context) {
    ExampleApplication application = (ExampleApplication) context.getApplicationContext();
    return application.refWatcher;
  }
  private RefWatcher refWatcher;
  @Override public void onCreate() {
    super.onCreate();
    refWatcher = installLeakCanary();
  }
  protected RefWatcher installLeakCanary() {
    return RefWatcher.DISABLED;
  }
}

在你debug的Application类中创建一个自定义的RefWatcher:

public class DebugExampleApplication extends ExampleApplication {
  protected RefWatcher installLeakCanary() {
    return LeakCanary.install(app, LeakUploadService.class);
  }
}

不要忘了在debug的manifest里面注册service:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    >
  <application android:name="com.example.DebugExampleApplication">
    <service android:name="com.example.LeakUploadService" />
  </application>
</manifest>

你也可以上传leak traces到Slack或者HipChat,这里是一个例子

LeakCanary 名称是为了表达canary in a coal mine,因为LeakCanary是通过提供危险预警,检测风险的哨兵,维护者@edenman提的建议!

X. License

Copyright 2015 Square, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.