HashSet源码解读

HashSet实现Set接口，是由一个哈希表（实际上是一个HashMap实例）支持。HashSet不保证集合的迭代顺序，也不保证元素顺序随时间保持恒定。HashSet允许null元素。

一、类定义

public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable
H

HashSet实现了Set接口，继承AbstractSet。对于HashSet而言，它是基于HashMap实现的，HashSet底层使用HashMap来保存

所有元素，因此HashSet 的实现比较简单，相关HashSet的操作，基本上都是直接调用底层HashMap的相关方法来完成，

二、源码解读

public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable
{
    static final long serialVersionUID = -5024744406713321676L;

    // 底层使用HashMap来保存HashSet中所有元素
    private transient HashMap<E,Object> map;

    // 定义一个虚拟的Object对象作为HashMap的value值
    private static final Object PRESENT = new Object();

    // 默认无参构造函数，构造一个空的HashSet
    // 实际上初始化的是一个空的HashMap，并使用默认初始容量为16和加载因子0.75
    public HashSet() {
        map = new HashMap<>();
    }

    // 构造一个包含指定collection元素的新的set
    // 实际上底层使用默认加载因子0.75和足以包含指定collection中所有元素的初始容量来创建一个HashMap
    public HashSet(Collection<? extends E> c) {
        map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
        addAll(c);
    }

    // 构造一个指定初始容量和加载因子的空的HashSet
    public HashSet(int initialCapacity, float loadFactor) {
        map = new HashMap<>(initialCapacity, loadFactor);
    }

    // 构造一个指定初始容量的空的HashSet，加载因子使用默认的0.75
    public HashSet(int initialCapacity) {
        map = new HashMap<>(initialCapacity);
    }

    // 构造一个指定初始容量和加载因子的空的LinkedHashSet
    // 此构造函数为包访问权限，不对外公开，实际只是是对LinkedHashSet的支持
    HashSet(int initialCapacity, float loadFactor, boolean dummy) {
        map = new LinkedHashMap<>(initialCapacity, loadFactor);
    }

    // 返回对此set中元素进行迭代的迭代器。返回元素的顺序并不是特定的
    // 底层实际调用底层HashMap的keySet来返回所有的key。
    // 可见HashSet中的元素，只是存放在了底层HashMap的key上，value使用一个static final的Object对象标识。 
    public Iterator<E> iterator() {
        return map.keySet().iterator();
    }

    // 返回set中所有元素的数据，也就是set的容量
    public int size() {
        return map.size();
    }

    // 如果set为空，则返回true，否则返回false
    public boolean isEmpty() {
        return map.isEmpty();
    }

    // 如果set包含该指定元素，则返回true，否则返回false
    // 更确切地讲，如果此 set 没有包含满足(e==null ? e2==null : e.equals(e2))的元素e2，
    // 则向此set添加指定的元素e。如果此set已包含该元素，则该调用不更改set并返回false。
    public boolean contains(Object o) {
        return map.containsKey(o);
    }

    // 如果此set中尚未包含指定元素，则添加指定元素。 
    // 更确切地讲，如果此 set 没有包含满足(e==null ? e2==null : e.equals(e2)) 
    // 的元素e2，则向此set 添加指定的元素e。 
    // 如果此set已包含该元素，则该调用不更改set并返回false。 
    public boolean add(E e) {
        return map.put(e, PRESENT)==null;
    }

    // 如果指定元素存在于此set中，则将其移除。 
    // 更确切地讲，如果此set包含一个满足(o==null ? e==null : o.equals(e))的元素e， 
    // 则将其移除。如果此set已包含该元素，则返回true 
    //（或者：如果此set因调用而发生更改，则返回true）。（一旦调用返回，则此set不再包含该元素）。 
    public boolean remove(Object o) {
        return map.remove(o)==PRESENT;
    }

    // 删除set中的所有元素
    public void clear() {
        map.clear();
    }

    // 返回HashSet实例的浅复制：并没有复制这些元素本身
    public Object clone() {
        try {
            HashSet<E> newSet = (HashSet<E>) super.clone();
            newSet.map = (HashMap<E, Object>) map.clone();
            return newSet;
        } catch (CloneNotSupportedException e) {
            throw new InternalError();
        }
    }

    // 将此HashSet实例的状态保存到流中，也就是序列化它
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException {
        // Write out any hidden serialization magic
        s.defaultWriteObject();

        // Write out HashMap capacity and load factor
        s.writeInt(map.capacity());
        s.writeFloat(map.loadFactor());

        // Write out size
        s.writeInt(map.size());

        // Write out all elements in the proper order.
        for (E e : map.keySet())
            s.writeObject(e);
    }

    // 从流重构HashSet实例,也就是反序列化它
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        // Read in any hidden serialization magic
        s.defaultReadObject();

        // Read in HashMap capacity and load factor and create backing HashMap
        int capacity = s.readInt();
        float loadFactor = s.readFloat();
        map = (((HashSet)this) instanceof LinkedHashSet ?
               new LinkedHashMap<E,Object>(capacity, loadFactor) :
               new HashMap<E,Object>(capacity, loadFactor));

        // Read in size
        int size = s.readInt();

        // Read in all elements in the proper order.
        for (int i=0; i<size; i++) {
            E e = (E) s.readObject();
            map.put(e, PRESENT);
        }
    }
}