集合源码 009：WeakHashMap源码解析

总体介绍

在 Java 集合框架系列文章的最后，介绍一个特殊的成员：WeakHashMap。从名字可以看出它是某种 Map。它的特殊之处在于 WeakHashMap 里的 entry 可能会被 GC 自动删除，即使程序员没有调用 remove() 或者 clear() 方法。

更直观地说，当使用 WeakHashMap 时，即使没有显式地添加或删除任何元素，也可能发生如下情况：

调用两次 size() 方法返回不同的值；
两次调用 isEmpty() 方法，第一次返回 false，第二次返回 true；
两次调用 containsKey() 方法，第一次返回 true，第二次返回 false，尽管两次使用的是同一个 key；
两次调用 get() 方法，第一次返回一个 value，第二次返回 null，尽管两次使用的是同一个对象。

遇到这么奇葩的现象，你是不是觉得使用者一定会疯掉？其实不然，WeakHashMap 的这个特点特别适用于需要缓存的场景。在缓存场景下，由于内存是有限的，不能缓存所有对象；对象缓存命中可以提高系统效率，但缓存 MISS 也不会造成错误，因为可以通过计算重新得到。

要明白 WeakHashMap 的工作原理，还需要引入一个概念：弱引用（WeakReference）。我们都知道 Java 中内存是通过 GC 自动管理的，GC 会在程序运行过程中自动判断哪些对象是可以被回收的，并在合适的时机进行内存释放。GC 判断某个对象是否可被回收的依据是，是否有有效的引用指向该对象。如果没有有效引用指向该对象（基本意味着不存在访问该对象的方式），那么该对象就是可回收的。这里的”有效引用”并不包括弱引用。也就是说，虽然弱引用可以用来访问对象，但进行垃圾回收时弱引用并不会被考虑在内，仅有弱引用指向的对象仍然会被 GC 回收。

WeakHashMap 内部是通过弱引用来管理 entry 的，弱引用的特性对应到 WeakHashMap 上意味着：将一对 key、value 放入到 WeakHashMap 里并不能避免该 key 值被 GC 回收，除非在 WeakHashMap 之外还有对该 key 的强引用。

这里只需要知道 Java 中引用也是分种类的，并且不同种类的引用对 GC 的影响不同就够了。

具体实现

WeakHashMap 的存储结构类似于 HashMap（数组 + 冲突链表），可参考前文HashSet & HashMap 源码解析，这里不再赘述。

Weak HashSet?

如果你看过前几篇关于 Map 和 Set 的讲解，一定会问：既然有 WeakHashMap，是否有 WeakHashSet 呢？答案是没有。不过 Java Collections 工具类给出了解决方案，Collections.newSetFromMap(Map<E,Boolean> map) 方法可以将任何 Map 包装成一个 Set。通过如下方式可以快速得到一个 Weak HashSet：

// 将WeakHashMap包装成一个Set
Set<Object> weakHashSet = Collections.newSetFromMap(
    new WeakHashMap<Object, Boolean>());

不出你所料，newSetFromMap() 方法只是对传入的 Map 做了简单包装：

// Collections.newSetFromMap()用于将任何Map包装成一个Set
public static <E> Set<E> newSetFromMap(Map<E, Boolean> map) {
    return new SetFromMap<>(map);
}

private static class SetFromMap<E> extends AbstractSet<E>
    implements Set<E>, Serializable
{
    private final Map<E, Boolean> m;  // The backing map
    private transient Set<E> s;       // Its keySet

    SetFromMap(Map<E, Boolean> map) {
        if (!map.isEmpty())
            throw new IllegalArgumentException("Map is non-empty");
        m = map;
        s = map.keySet();
    }

    public void clear()               { m.clear(); }
    public int size()                 { return m.size(); }
    public boolean isEmpty()          { return m.isEmpty(); }
    public boolean contains(Object o) { return m.containsKey(o); }
    public boolean remove(Object o)   { return m.remove(o) != null; }
    public boolean add(E e)           { return m.put(e, Boolean.TRUE) == null; }
    public Iterator<E> iterator()     { return s.iterator(); }
    public Object[] toArray()         { return s.toArray(); }
    public <T> T[] toArray(T[] a)     { return s.toArray(a); }
    public String toString()          { return s.toString(); }
    public int hashCode()             { return s.hashCode(); }
    public boolean equals(Object o)   { return o == this || s.equals(o); }
    public boolean containsAll(Collection<?> c) {return s.containsAll(c);}
    public boolean removeAll(Collection<?> c)   {return s.removeAll(c);}
    public boolean retainAll(Collection<?> c)   {return s.retainAll(c);}
    // addAll is the only inherited implementation
    ......
}

系列导航

上一篇：TreeSet & TreeMap 源码解析
回到系列起点：集合源码 001：类关系图（Overview）

参考内容

浅谈WeakHashMap

CHARLIE SAYS