深入Java集合学习系列(二)

HashSet的实现原理

1. HashSet概述

HashSet实现Set接口,由哈希表(实际上是一个HashMap实例)支持。它不保证set 的迭代顺序;特别是它不保证该顺序恒久不变。此类允许使用null元素。

2. HashSet的实现

对于HashSet而言,它是基于HashMap实现的,HashSet底层使用HashMap来保存所有元素,因此HashSet 的实现比较简单,相关HashSet的操作,基本上都是直接调用底层HashMap的相关方法来完成, HashSet的源代码如下:

Java代码 

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

3. 相关说明

1) 相关HashMap的实现原理,请参考我的上一遍总结:深入Java集合学习系列:HashMap的实现原理

   2) 对于HashSet中保存的对象,请注意正确重写其equals和hashCode方法,以保证放入的对象的唯一性。