虚引用的使用

虚引用相信大家都知道他的作用，但是由于平时不常用，所以实际上手有点困难。

本文目的通过学习虚引用的使用，敲开 LeakCanary 源码学习的大门。

使用虚引用检测对象被回收

虚引用必须与 ReferenceQueue 一起使用，当 GC 准备回收一个对象，如果发现它有虚引用，就会在回收之前，把这个 虚引用 加入到与之关联的 ReferenceQueue 中。

利用这个原理，我们可以检测到对象何时被回收。

下面通过测试代码，说明如何检测。

public class MainActivity extends AppCompatActivity {

    private static final String TAG = "PhantomReferenceDemo";

    // 1、定义为成员变量 防止PhantomReference被回收
    private ReferenceQueue mQueue = new ReferenceQueue<>();
    private PhantomReference mReference;

    // 2、定义为成员变量 方便手动控制回收
    private String mTest;

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

        // 4、开启线程 监控回收情况
        new Thread(() -> {
            while (true) {
                Reference poll = mQueue.poll();
                if (poll != null) {
                    Log.e(TAG, "引用被回收：" + poll);
                }
            }
        }).start();

        // 3、
        // 直接用双引号定义的 存储在方法区
        // new出来的 存储在JVM堆
        // 由于GC回收主要针对堆 所以这儿使用new String才能看到效果
        mTest = new String("test");

        mReference = new PhantomReference<>(mTest, mQueue);
    }

    // click 事件
    public void setEmpty(View view) {
        Log.e(TAG, "手动置空");
        mTest = null;
        // 因为Android的垃圾回收机制 这里最好使用MemoryProfiler手动操作垃圾回收
    }
}

下面序号对应代码注释序号。

1、定义 ReferenceQueue 和 PhantomReference。

这里为了方便测试，将 ReferenceQueue 和 PhantomReference 定义为成员变量，防止虚引用及其队列本身被回收。

2、定义要回收的变量。

这里定义测试回收对象 mTest，定义为成员变量的原因是为了手动置空、随时控制垃圾回收的时机。

3、给回收变量赋值。

注意 mTest = new String("test"); 不能替换为 mTest = "test";，原因是垃圾回收主要针对 JVM 堆，而双引号字符串在方法区，不属于垃圾回收的范畴。

4、开启线程，循环判断 ReferenceQueue 中是否有对象。

上面说到如果对象被回收时，其虚引用会被加入到 ReferenceQueue 中，此时队列不为空， Reference poll = mQueue.poll(); 代码被激活，我们就能知道对象发生了回收。

那么如何测试呢？

看下布局：

开启程序后，首先点击置空（即调用 setEmpty 函数），将 mTest 设置为 null。

你会发现，循环监控线程并没有反应，这是因为此时并没有发生 gc，即使你在代码后调用 System.gc();，其回收时机也是不确定的。

更好的办法是，使用 Android Memory Profiler，手动强制垃圾回收。

垃圾回收后，我们即能在 logcat 中，看到如下日志：

手动置空
引用被回收：java.lang.ref.PhantomReference@c053ba5

从日志中，仍然无从得知哪个对象被回收了，因为我们看到的是被回收对象的虚引用。
因此，要想通过虚引用检测内存泄漏，必须建立一个回收对象和虚引用的关联。

使用虚引用检测内存泄漏

这里仅提供思路和演示，直接上代码。

public class MainActivity extends AppCompatActivity {

    private static final String TAG = "PhantomReferenceDemo";

    // 定义为成员变量 防止PhantomReference被回收
    private ReferenceQueue mQueue = new ReferenceQueue<>();
    private PhantomReference mReference;

    // 定义为成员变量 方便手动控制回收
    private String mTest;

    // 1、用于判断是否存在内存泄漏
    private Map> mMonitor = new HashMap<>();

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

        // 开启线程 监控回收情况
        new Thread(() -> {
            while (true) {
                Reference poll = mQueue.poll();
                if (poll != null) {
                    // 2、
                    mMonitor.remove(poll);
                    Log.e(TAG, "引用被回收：" + poll);
                }
            }
        }).start();

        // 直接用双引号定义的 存储在方法区
        // new出来的 存储在JVM堆
        // 由于GC回收主要针对堆 所以这儿使用new String才能看到效果
        mTest = new String("test");
        // 4、
//        ReferenceOutside.sTest = mTest;

        mReference = new PhantomReference<>(mTest, mQueue);

        // 1、
        mMonitor.put(mReference, new WeakReference<>(mTest));
    }

    public void setEmpty(View view) {
        Log.e(TAG, "手动置空");
        mTest = null;
        // 因为Android的垃圾回收机制 这里最好使用MemoryProfiler手动操作垃圾回收
    }

    // 3、
    public void judgeMemory(View view) {
        Log.e(TAG, "判断是否内存泄漏：");
        for (WeakReference