HashMap 之弱引用 - WeakHashMap

■ Java 引用的相关知识

　 1. 强引用

Object o = new Object(); 

• 强引用是Java 默认实现 的引用，JVM会尽可能长时间的保留强引用的存在（直到内存溢出）
• 当内存空间不足，Java虚拟机宁愿抛出OutOfMemoryError错误，使程序异常终止，也不会靠随意回收具有强引用的对象来解决内存不足的问题：只有当没有任何对象指向它时JVM将会回收

　2. 软引用

public class SoftReference<T> extends Reference<T> {...} 

• 软引用只会在虚拟机 内存不足 的时候才会被回收
• 软引用可以和一个引用队列（ReferenceQueue）联合使用，如果软引用所引用的对象被垃圾回收器回收，Java虚拟机就会把这个软引用加入到与之关联的引用队列中

3. 弱引用

public class WeakReference<T> extends Reference<T> {...} 

• 弱引用是指当对象没有任何的强引用存在，在 下次GC回收 的时候它将会被回收
• 在垃圾回收器线程扫描它所管辖的内存区域的过程中，一旦发现了只具有弱引用的对象，不管当前内存空间足够与否，都会回收它的内存
• 需要注意的是：由于垃圾回收器是一个优先级很低的线程，因此不一定会很快发现那些只具有弱引用的对象

■ WeakHashMap 的认识：

• WeakHashMap 是存储键值对(key-value)的非同步且无序的散列表，键和值都允许为null，基本跟 HashMap一致
• 特殊之处在于 WeakHashMap 里的entry可能会被GC自动删除，即使没有主动调用 remove() 或者 clear() 方法
• 其键为弱键，除了自身有对key的引用外，此key没有其他引用那么此map会自动丢弃此值
• 在《Effective Java》一书中第六条，消除陈旧对象时，提到了weakHashMap，用于短时间内就过期的缓存
• 由于与JDK1.7版本的HashMap实现原理一致（具体请参见笔者的 HashMap一文通），这里只讨论不同
• 若有机会写JVM篇的垃圾回收机制时会再进一步描述 Reference

1. 类定义

public class WeakHashMap<K,V>
    extends AbstractMap<K,V>
    implements Map<K,V>

2. 重要的全局变量

/**
  * The default initial capacity -- MUST be a power of two.
  * 默认容量，必须是2次幂
  */
private static final int DEFAULT_INITIAL_CAPACITY = 16;
/**
  * The maximum capacity, used if a higher value is implicitly specified by either of the
  * constructors with arguments. MUST be a power of two <= 1<<30.
  * 最大容量，必须为2次幂且 <= 1<<30
  */
private static final int MAXIMUM_CAPACITY = 1 << 30;
/**
  * The load factor used when none specified in constructor.
  * 负载因子
  */
private static final float DEFAULT_LOAD_FACTOR = 0.75f;
/**
  * The table, resized as necessary. Length MUST Always be a power of two.
  * 容量必须为2次幂的数组
  */
Entry<K,V>[] table;
/**
  * The number of key-value mappings contained in this weak hash map.
  * 拥有键值对的数量
  */
private int size;
/**
  * The next size value at which to resize (capacity * load factor).
  * 阈值 -- 扩容判断依据
  */
private int threshold;
/**
  * The load factor for the hash table.
  */
private final float loadFactor;
/**
  * Reference queue for cleared WeakEntries
  * 引用队列，用于存储已被GC清除的WeakEntries
  */
private final ReferenceQueue<Object> queue = new ReferenceQueue<>();

3. 构造器

// 默认构造函数
WeakHashMap()
// 指定"容量大小"的构造函数
WeakHashMap(int capacity)
// 指定"容量大小"和"负载因子"的构造函数
WeakHashMap(int capacity, float loadFactor)
// 包含"子Map"的构造函数
WeakHashMap(Map<? extends K, ? extends V> map)

• 实现跟JDK1.7版本HashMap的实现一致,具体请参见笔者的  HashMap - 基于哈希表和 Map 接口的键值对利器 （JDK 1.7）

4. Entry

/**
  * The entries in this hash table extend WeakReference, using its main ref field as the key.
  * 该Enty继承WeakReference，从而具备弱引用的特性
  */
private static class Entry<K,V> extends WeakReference<Object> implements Map.Entry<K,V> {
    V value;
    int hash;
    Entry<K,V> next;//链表
    /**
      * Creates new entry.
      */
    Entry(Object key, V value,
            ReferenceQueue<Object> queue,
            int hash, Entry<K,V> next) {
        super(key, queue);
        this.value = value;
        this.hash  = hash;
        this.next  = next;
    }
    ....
}  

■ WeakHashMap 的重要方法

• 常规 put(), get(), remove() 等不详细研究，来看下比较关键的 expungeStaleEntries()

/**
  * Expunges stale entries from the table. -- 删除过时的entry
  * 该方法是实现弱键回收的最关键方法，也是区分HashMap的根本方法
  * 核心：移除table和queue的并集元素（queue中存储是已被GC的key，注意是key！！）
  * 效果：key在GC的时候被清除，value在key清除后访问WeakHashMap被清除
  */
private void expungeStaleEntries() {
    //从队列中出队遍历
    //poll 移除并返问队列头部的元素；如果队列为空，则返回null
    for (Object x; (x = queue.poll()) != null; ) {
        synchronized (queue) {
            //值得一提的是WeakHashMap是非线程安全的，这里却同步了一下
            //大神原本的用意是保证在多线程时能不破坏数据结构，但JavaDoc已经强调这类非安全，如下文
            //http://bugs.java.com/bugdatabase/view_bug.do?bug_id=6425537
            @SuppressWarnings("unchecked")
                Entry<K,V> e = (Entry<K,V>) x;
            //找到该队列中的元素在数组中的位置，并移除该元素（table和queue都需要移除）
            int i = indexFor(e.hash, table.length);
            Entry<K,V> prev = table[i];
            Entry<K,V> p = prev;
            while (p != null) {
                Entry<K,V> next = p.next;
                if (p == e) {
                    if (prev == e)
                        table[i] = next;
                    else
                        prev.next = next;
                    // Must not null out e.next;
                    // stale entries may be in use by a HashIterator
                    e.value = null; // Help GC 移除value
                    size--;
                    break;
                }
                prev = p;
                p = next;
            }
        }
    }
}