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

  1 package java.util;
  2 
  3 import java.io.InvalidObjectException;
  4 import sun.misc.SharedSecrets;
  5 
  6 public class HashSet<E> extends AbstractSet<E>
  7     implements Set<E>, Cloneable, java.io.Serializable {
  8     
  9     static final long serialVersionUID = -5024744406713321676L;
 10 
 11     // 底层使用HashMap来保存HashSet中所有元素
 12     private transient HashMap<E,Object> map;
 13 
 14     // 定义一个虚拟的Object对象作为HashMap的value，将此对象定义为static final
 15     private static final Object PRESENT = new Object();
 16 
 17     //默认的无参构造器，构造一个空的HashSet。 
 18     // 实际底层会初始化一个空的HashMap，并使用默认初始容量为16和加载因子0.75。 
 19     public HashSet() {
 20         map = new HashMap<>();
 21     }
 22 
 23      //构造一个包含指定collection中的元素的新set。 
 24      //实际底层使用默认的加载因子0.75和足以包含指定 collection中所有元素的初始容量来创建一个HashMap。 
 25     public HashSet(Collection<? extends E> c) {
 26         map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
 27         addAll(c);
 28     }
 29 
 30     //以指定的initialCapacity和loadFactor构造一个空的HashSet。
 31     //实际底层以相应的参数构造一个空的HashMap。
 32     public HashSet(int initialCapacity, float loadFactor) {
 33         map = new HashMap<>(initialCapacity, loadFactor);
 34     }
 35 
 36     //以指定的initialCapacity构造一个空的HashSet。 
 37     //实际底层以相应的参数及加载因子loadFactor为0.75构造一个空的HashMap。
 38     public HashSet(int initialCapacity) {
 39         map = new HashMap<>(initialCapacity);
 40     }
 41 
 42     //以指定的initialCapacity和loadFactor构造一个新的空链接哈希集合。 
 43     //此构造函数为包访问权限，不对外公开，实际只是是对LinkedHashSet的支持。 
 44     //实际底层会以指定的参数构造一个空LinkedHashMap实例来实现。 
 45     HashSet(int initialCapacity, float loadFactor, boolean dummy) {
 46         map = new LinkedHashMap<>(initialCapacity, loadFactor);
 47     }
 48 
 49     //返回对此set中元素进行迭代的迭代器。返回元素的顺序并不是特定的。 
 50     //底层实际调用底层HashMap的keySet来返回所有的key。 
 51     //可见HashSet中的元素，只是存放在了底层HashMap的key上，value使用一个static final的Object对象标识。 
 52     public Iterator<E> iterator() {
 53         return map.keySet().iterator();
 54     }
 55 
 56     //返回此set中的元素的数量（set的容量）。 
 57     //底层实际调用HashMap的size()方法返回Entry的数量，就得到该Set中元素的个数。 
 58     public int size() {
 59         return map.size();
 60     }
 61 
 62     //判断set是否为空，则返回true,底层实际调用HashMap的isEmpty()判断该HashSet是否为空。
 63     public boolean isEmpty() {
 64         return map.isEmpty();
 65     }
 66 
 67     //如果此set包含指定元素，则返回true。  
 68     //底层实际调用HashMap的containsKey判断是否包含指定key。
 69     public boolean contains(Object o) {
 70         return map.containsKey(o);
 71     }
 72 
 73     //如果此set中尚未包含指定元素，则添加指定元素。 
 74     //底层实际将将该元素作为key放入HashMap。 
 75     //由于HashMap的put()方法添加key-value对时，当新放入HashMap的Entry中key 
 76     //与集合中原有Entry的key相同（hashCode()返回值相等，通过equals比较也返回true）， 
 77     //新添加的Entry的value会将覆盖原来Entry的value，但key不会有任何改变， 
 78     //因此如果向HashSet中添加一个已经存在的元素时，新添加的集合元素将不会被放入HashMap中， 
 79     //原来的元素也不会有任何改变，这也就满足了Set中元素不重复的特性。
 80     public boolean add(E e) {
 81         return map.put(e, PRESENT)==null;
 82     }
 83 
 84     //如果指定元素存在于此set中，则将其移除。
 85     public boolean remove(Object o) {
 86         return map.remove(o)==PRESENT;
 87     }
 88 
 89     //从此set中移除所有元素。此调用返回后，该set将为空。 
 90     //底层实际调用HashMap的clear方法清空Entry中所有元素。 
 91     public void clear() {
 92         map.clear();
 93     }
 94 
 95     //返回此HashSet实例的浅表副本：并没有复制这些元素本身。
 96     @SuppressWarnings("unchecked")
 97     public Object clone() {
 98         try {
 99             HashSet<E> newSet = (HashSet<E>) super.clone();
100             newSet.map = (HashMap<E, Object>) map.clone();
101             return newSet;
102         } catch (CloneNotSupportedException e) {
103             throw new InternalError(e);
104         }
105     }
106 
107     //序列化
108     private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException {
109         s.defaultWriteObject();
110 
111         s.writeInt(map.capacity());
112         s.writeFloat(map.loadFactor());
113 
114         s.writeInt(map.size());
115 
116         for (E e : map.keySet())
117             s.writeObject(e);
118     }
119 
120     //反序列化
121     private void readObject(java.io.ObjectInputStream s)throws java.io.IOException, ClassNotFoundException {
122         s.defaultReadObject();
123 
124         int capacity = s.readInt();
125         if (capacity < 0) {
126             throw new InvalidObjectException("Illegal capacity: " + capacity);
127         }
128 
129         float loadFactor = s.readFloat();
130         if (loadFactor <= 0 || Float.isNaN(loadFactor)) {
131             throw new InvalidObjectException("Illegal load factor: " + loadFactor);
132         }
133 
134         int size = s.readInt();
135         if (size < 0) {
136             throw new InvalidObjectException("Illegal size: " + size);
137         }
138 
139         capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f), HashMap.MAXIMUM_CAPACITY);
140 
141         SharedSecrets.getJavaOISAccess().checkArray(s, Map.Entry[].class, HashMap.tableSizeFor(capacity));
142 
143         map = (((HashSet<?>)this) instanceof LinkedHashSet ?
144                new LinkedHashMap<E,Object>(capacity, loadFactor) :
145                new HashMap<E,Object>(capacity, loadFactor));
146 
147         for (int i=0; i<size; i++) {
148             @SuppressWarnings("unchecked")
149                 E e = (E) s.readObject();
150             map.put(e, PRESENT);
151         }
152     }
153 
154     public Spliterator<E> spliterator() {
155         return new HashMap.KeySpliterator<E,Object>(map, 0, -1, 0, 0);
156     }
157 }