5.Java集合框架剖析 之 Hashset和LinkedHashSet源码剖析

package java.util;

import java.io.InvalidObjectException;
import sun.misc.SharedSecrets;

//HashSet底层是数组 + 单链表 + 红黑树的数据结构
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，将此对象定义为static final
    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);
    }

    //以指定的initialCapacity和loadFactor构造一个空的HashSet。
    //实际底层以相应的参数构造一个空的HashMap。
    public HashSet(int initialCapacity, float loadFactor) {
        map = new HashMap<>(initialCapacity, loadFactor);
    }

    //以指定的initialCapacity构造一个空的HashSet。 
    //实际底层以相应的参数及加载因子loadFactor为0.75构造一个空的HashMap。
    public HashSet(int initialCapacity) {
        map = new HashMap<>(initialCapacity);
    }

    //以指定的initialCapacity和loadFactor构造一个新的空链接哈希集合。 
    //此构造函数为包访问权限，不对外公开，实际只是是对LinkedHashSet的支持。 
    //实际底层会以指定的参数构造一个空LinkedHashMap实例来实现。 
    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的容量）。 
    //底层实际调用HashMap的size()方法返回Entry的数量，就得到该Set中元素的个数。 
    public int size() {
        return map.size();
    }

    //判断set是否为空，则返回true,底层实际调用HashMap的isEmpty()判断该HashSet是否为空。
    public boolean isEmpty() {
        return map.isEmpty();
    }

    //如果此set包含指定元素，则返回true。  
    //底层实际调用HashMap的containsKey判断是否包含指定key。
    public boolean contains(Object o) {
        return map.containsKey(o);
    }

    //如果此set中尚未包含指定元素，则添加指定元素。 
    //底层实际将将该元素作为key放入HashMap。 
    //由于HashMap的put()方法添加key-value对时，当新放入HashMap的Entry中key 
    //与集合中原有Entry的key相同（hashCode()返回值相等，通过equals比较也返回true）， 
    //新添加的Entry的value会将覆盖原来Entry的value，但key不会有任何改变， 
    //因此如果向HashSet中添加一个已经存在的元素时，新添加的集合元素将不会被放入HashMap中， 
    //原来的元素也不会有任何改变，这也就满足了Set中元素不重复的特性。
    public boolean add(E e) {
        return map.put(e, PRESENT)==null;
    }

    //如果指定元素存在于此set中，则将其移除。
    public boolean remove(Object o) {
        return map.remove(o)==PRESENT;
    }

    //从此set中移除所有元素。此调用返回后，该set将为空。 
    //底层实际调用HashMap的clear方法清空Entry中所有元素。 
    public void clear() {
        map.clear();
    }

    //返回此HashSet实例的浅表副本：并没有复制这些元素本身。
    @SuppressWarnings("unchecked")
    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(e);
        }
    }

    //序列化
    private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException {
        s.defaultWriteObject();

        s.writeInt(map.capacity());
        s.writeFloat(map.loadFactor());

        s.writeInt(map.size());

        for (E e : map.keySet())
            s.writeObject(e);
    }

    //反序列化
    private void readObject(java.io.ObjectInputStream s)throws java.io.IOException, ClassNotFoundException {
        s.defaultReadObject();

        int capacity = s.readInt();
        if (capacity < 0) {
            throw new InvalidObjectException("Illegal capacity: " + capacity);
        }

        float loadFactor = s.readFloat();
        if (loadFactor <= 0 || Float.isNaN(loadFactor)) {
            throw new InvalidObjectException("Illegal load factor: " + loadFactor);
        }

        int size = s.readInt();
        if (size < 0) {
            throw new InvalidObjectException("Illegal size: " + size);
        }

        capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f), HashMap.MAXIMUM_CAPACITY);

        SharedSecrets.getJavaOISAccess().checkArray(s, Map.Entry[].class, HashMap.tableSizeFor(capacity));

        map = (((HashSet<?>)this) instanceof LinkedHashSet ?
               new LinkedHashMap<E,Object>(capacity, loadFactor) :
               new HashMap<E,Object>(capacity, loadFactor));

        for (int i=0; i<size; i++) {
            @SuppressWarnings("unchecked")
                E e = (E) s.readObject();
            map.put(e, PRESENT);
        }
    }

    public Spliterator<E> spliterator() {
        return new HashMap.KeySpliterator<E,Object>(map, 0, -1, 0, 0);
    }
}

 

package java.util;

//LinkedHashSet继承自HashSet，内部使用的是LinkHashMap,好处是LinkedHashSet中的元素顺序是可以保证的，即遍历顺序和插入顺序是一致的。
//LinkedHashSet底层是 数组 + 单链表 + 红黑树 + 双向链表的数据结构
public class LinkedHashSet<E> extends HashSet<E> implements Set<E>, Cloneable, java.io.Serializable {

    private static final long serialVersionUID = -2851667679971038690L;

    //调用HashSet中的LinkedHashMap
    public LinkedHashSet(int initialCapacity, float loadFactor) {
        super(initialCapacity, loadFactor, true);
    }

    //调用HashSet中的 LinkedHashMap 的构造方法，该方法初始化了初始起始容量，以及加载因子，
    //dummy 参数没有作用这里可以忽略，在HashSet中只是为了区别其他的构造方法而已
    public LinkedHashSet(int initialCapacity) {
        super(initialCapacity, .75f, true);
    }

    //初始化 LinkedHashMap 的初始容量为诶 16 加载因子为 0.75f
    public LinkedHashSet() {
        super(16, .75f, true);
    }

    //初始化 LinkedHashMap 的初始容量为 Math.max(2*c.size(), 11) 加载因子为 0.75f 
    public LinkedHashSet(Collection<? extends E> c) {
        super(Math.max(2*c.size(), 11), .75f, true);
        addAll(c);
    }

    //
    @Override
    public Spliterator<E> spliterator() {
        return Spliterators.spliterator(this, Spliterator.DISTINCT | Spliterator.ORDERED);
    }
}