Java WeakHashMap 源码解析

转：http://liujiacai.net/blog/2015/09/27/java-weakhashmap/

前面把基于特定数据结构的Map介绍完了，它们分别利用了相应数据结构的特点来实现特殊的目的，像HashMap利用哈希表的快速插入、查找实现O(1)的增删改查，TreeMap则利用了红黑树来保证key的有序性的同时，使得增删改查的时间复杂度为O(log(n))。

今天要介绍的WeakHashMap并没有基于某种特殊的数据结构，它的主要目的是为了优化JVM，使JVM中的垃圾回收器（garbage collector，后面简写为 GC）更智能的回收“无用”的对象。

本文源码分析基于Oracle JDK 1.7.0_71，请知悉。

1 2 3 4

$ java - version java version "1.7.0_71" Java(TM) SE Runtime Environment (build 1.7. 0_71-b14) Java HotSpot(TM) 64-Bit Server VM (build 24.71-b01, mixed mode)

引用类型

WeakHashMap与其他 Map 最主要的不同之处在于其 key 是弱引用类型，其他 Map 的 key 均为强引用类型，说到这里，必须强调下：Java 中，引用有四种类型，分别为：强（strong）引用、软（soft）引用、弱（weak）引用、虚（phantom，本意为幽灵）引用。我相信对于 Java 初学者来说，不一定听过这几种引用类似，下面先介绍下这几种类型。

强引用

这是最常用的引用类型，在执行下面的语句时，变量 o 即为一个强引用。

1	Object o = new Object();

强引用指向的对象无论在何时，都不会被GC 清理掉。

一般来说，对于常驻类应用（比如server），随着时间的增加，所占用的内存往往会持续上升，如果程序中全部使用强引用，那么很容易造成内存泄漏，最终导致Out Of Memory (OOM)，所以 Java 中提供了除强引用之外的其他三种引用，它们全部位于java.lang.ref包中，下面一一介绍。

java.lang.ref.Reference

java.lang.ref.Reference 为 软（soft）引用、弱（weak）引用、虚（phantom）引用的父类。

Reference类继承关系

下面分析下Reference的源码（其他三种引用都是其子类，区分不是很大）。

构造函数

1 2 3 4 5 6 7 8 9 10 11

//referent 为引用指向的对象 Reference(T referent) { this(referent, null); } //ReferenceQueue对象，可以简单理解为一个队列 //GC 在检测到appropriate reachability changes之后， //会把引用对象本身添加到这个queue中，便于清理引用对象本身 Reference(T referent, ReferenceQueue<? super T> queue) { this.referent = referent; this.queue = (queue == null) ? ReferenceQueue. NULL : queue; }

如果我们在创建一个引用对象时，指定了ReferenceQueue，那么当引用对象指向的对象达到合适的状态（根据引用类型不同而不同）时，GC 会把引用对象本身添加到这个队列中，方便我们处理它，因为

引用对象指向的对象 GC 会自动清理，但是引用对象本身也是对象（是对象就占用一定资源），所以需要我们自己清理。

举个例子：

1	SoftReference < String > ss = new SoftReference < String >( "abc" , queue);

ss 为软引用，指向abc这个对象，abc 会在一定时机被 GC 自动清理，但是ss对象本身的清理工作依赖于queue，当ss出现在queue中时，说明其指向的对象已经无效，可以放心清理ss了。

从上面的分析大家应该对Reference类有了基本的认识，但是上面也提到了，不同的引用，添加到ReferenceQueue的时机是不一样。下面介绍具体引用时再进行说明。
这里有个问题，如果创建引用对象是没有指定ReferenceQueue，引用对象会怎么样呢？这里需要了解Reference类内部的四种状态。

四种状态

每一时刻，Reference对象都处于下面四种状态中。这四种状态用Reference的成员变量queue与next（类似于单链表中的next）来标示。

1 2	ReferenceQueue<? super T> queue; Reference next;

• Active。新创建的引用对象都是这个状态，在 GC 检测到引用对象已经到达合适的reachability时，GC 会根据引用对象是否在创建时制定ReferenceQueue参数进行状态转移，如果指定了，那么转移到Pending，如果没指定，转移到Inactive。在这个状态中

1 2 3

//如果构造参数中没指定queue，那么queue为ReferenceQueue.NULL，否则为构造参数中传递过来的queue queue = ReferenceQueue || ReferenceQueue. NULL next = null

• Pending。pending-Reference列表中的引用都是这个状态，它们等着被内部线程ReferenceHandler处理（会调用ReferenceQueue.enqueue方法）。没有注册的实例不会进入这个状态。在这个状态中

1 2 3

//构造参数参数中传递过来的queue queue = ReferenceQueue next = 该 queue中的下一个引用，如果是该队列中的最后一个，那么为 this

• Enqueued。调用ReferenceQueue.enqueued方法后的引用处于这个状态中。没有注册的实例不会进入这个状态。在这个状态中

1 2	queue = ReferenceQueue.ENQUEUED next = 该 queue中的下一个引用，如果是该队列中的最后一个，那么为 this

• Inactive。最终状态，处于这个状态的引用对象，状态不会在改变。在这个状态中

1 2	queue = ReferenceQueue. NULL next = this

有了这些约束，GC 只需要检测next字段就可以知道是否需要对该引用对象采取特殊处理

• 如果next为null，那么说明该引用为Active状态
• 如果next不为null，那么 GC 应该按其正常逻辑处理该引用。

我自己根据Reference.ReferenceHandler.run与ReferenceQueue.enqueue这两个方法，画出了这四种状态的转移图，供大家参考：

Reference状态转移图

要理解这个状态 GC 到底做了什么事，需要看 JVM 的代码，我这里时间、能力都不够，就不献丑了，后面有机会再来填坑。
对于一般程序员来说，这四种状态完全可以不用管。最后简单两句话总结上面的四种状态：

1. 如果构造函数中指定了ReferenceQueue，那么事后程序员可以通过该队列清理引用
2. 如果构造函数中没有指定了ReferenceQueue，那么 GC 会自动清理引用

get

调用Reference.get方法可以得到该引用指向的对象，但是由于指向的对象随时可能被 GC 清理，所以即使在同一个线程中，不同时刻的调用可能返回不一样的值。

软引用（soft reference）

软引用“保存”对象的能力稍逊于强引用，但是高于弱引用，一般用来实现memory-sensitive caches。

软引用指向的对象会在程序即将触发OOM时被GC 清理掉，之后，引用对象会被放到ReferenceQueue中。

弱引用（weak reference）

软引用“保存”对象的能力稍逊于弱引用，但是高于虚引用，一般用来实现canonicalizing mapping，也就是本文要讲的WeakHashMap