深入Java集合学习系列:HashSet的实现原理

from:深入Java集合学习系列:HashSet的实现原理


1.    HashSet概述:

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



2.    HashSet的实现:

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

  1. public class HashSet<E>

  2.     extends AbstractSet<E>

  3.     implements Set<E>, Cloneable, java.io.Serializable

  4. {

  5.     static final long serialVersionUID = -5024744406713321676L;


  6.     // 底层使用HashMap来保存HashSet中所有元素。

  7.     private transient HashMap<E,Object> map;


  8.     // 定义一个虚拟的Object对象作为HashMap的value,将此对象定义为static final。

  9.     private static final Object PRESENT = new Object();


  10.     /**

  11.      * 默认的无参构造器,构造一个空的HashSet。

  12.      * 

  13.      * 实际底层会初始化一个空的HashMap,并使用默认初始容量为16和加载因子0.75。

  14.      */

  15.     public HashSet() {

  16.     map = new HashMap<E,Object>();

  17.     }


  18.     /**

  19.      * 构造一个包含指定collection中的元素的新set。

  20.      *

  21.      * 实际底层使用默认的加载因子0.75和足以包含指定

  22.      * collection中所有元素的初始容量来创建一个HashMap。

  23.      * @param c 其中的元素将存放在此set中的collection。

  24.      */

  25.     public HashSet(Collection<? extends E> c) {

  26.     map = new HashMap<E,Object>(Math.max((int) (c.size()/.75f) + 116));

  27.     addAll(c);

  28.     }


  29.     /**

  30.      * 以指定的initialCapacity和loadFactor构造一个空的HashSet。

  31.      *

  32.      * 实际底层以相应的参数构造一个空的HashMap。

  33.      * @param initialCapacity 初始容量。

  34.      * @param loadFactor 加载因子。

  35.      */

  36.     public HashSet(int initialCapacity, float loadFactor) {

  37.     map = new HashMap<E,Object>(initialCapacity, loadFactor);

  38.     }


  39.     /**

  40.      * 以指定的initialCapacity构造一个空的HashSet。

  41.      *

  42.      * 实际底层以相应的参数及加载因子loadFactor为0.75构造一个空的HashMap。

  43.      * @param initialCapacity 初始容量。

  44.      */

  45.     public HashSet(int initialCapacity) {

  46.     map = new HashMap<E,Object>(initialCapacity);

  47.     }


  48.     /**

  49.      * 以指定的initialCapacity和loadFactor构造一个新的空链接哈希集合。

  50.      * 此构造函数为包访问权限,不对外公开,实际只是是对LinkedHashSet的支持。

  51.      *

  52.      * 实际底层会以指定的参数构造一个空LinkedHashMap实例来实现。

  53.      * @param initialCapacity 初始容量。

  54.      * @param loadFactor 加载因子。

  55.      * @param dummy 标记。

  56.      */

  57.     HashSet(int initialCapacity, float loadFactor, boolean dummy) {

  58.     map = new LinkedHashMap<E,Object>(initialCapacity, loadFactor);

  59.     }


  60.     /**

  61.      * 返回对此set中元素进行迭代的迭代器。返回元素的顺序并不是特定的。

  62.      * 

  63.      * 底层实际调用底层HashMap的keySet来返回所有的key。

  64.      * 可见HashSet中的元素,只是存放在了底层HashMap的key上,

  65.      * value使用一个static final的Object对象标识。

  66.      * @return 对此set中元素进行迭代的Iterator。

  67.      */

  68.     public Iterator<E> iterator() {

  69.     return map.keySet().iterator();

  70.     }


  71.     /**

  72.      * 返回此set中的元素的数量(set的容量)。

  73.      *

  74.      * 底层实际调用HashMap的size()方法返回Entry的数量,就得到该Set中元素的个数。

  75.      * @return 此set中的元素的数量(set的容量)。

  76.      */

  77.     public int size() {

  78.     return map.size();

  79.     }


  80.     /**

  81.      * 如果此set不包含任何元素,则返回true。

  82.      *

  83.      * 底层实际调用HashMap的isEmpty()判断该HashSet是否为空。

  84.      * @return 如果此set不包含任何元素,则返回true。

  85.      */

  86.     public boolean isEmpty() {

  87.     return map.isEmpty();

  88.     }


  89.     /**

  90.      * 如果此set包含指定元素,则返回true。

  91.      * 更确切地讲,当且仅当此set包含一个满足(o==null ? e==null : o.equals(e))

  92.      * 的e元素时,返回true。

  93.      *

  94.      * 底层实际调用HashMap的containsKey判断是否包含指定key。

  95.      * @param o 在此set中的存在已得到测试的元素。

  96.      * @return 如果此set包含指定元素,则返回true。

  97.      */

  98.     public boolean contains(Object o) {

  99.     return map.containsKey(o);

  100.     }


  101.     /**

  102.      * 如果此set中尚未包含指定元素,则添加指定元素。

  103.      * 更确切地讲,如果此 set 没有包含满足(e==null ? e2==null : e.equals(e2))

  104.      * 的元素e2,则向此set 添加指定的元素e。

  105.      * 如果此set已包含该元素,则该调用不更改set并返回false。

  106.      *

  107.      * 底层实际将将该元素作为key放入HashMap。

  108.      * 由于HashMap的put()方法添加key-value对时,当新放入HashMap的Entry中key

  109.      * 与集合中原有Entry的key相同(hashCode()返回值相等,通过equals比较也返回true),

  110.      * 新添加的Entry的value会将覆盖原来Entry的value,但key不会有任何改变,

  111.      * 因此如果向HashSet中添加一个已经存在的元素时,新添加的集合元素将不会被放入HashMap中,

  112.      * 原来的元素也不会有任何改变,这也就满足了Set中元素不重复的特性。

  113.      * @param e 将添加到此set中的元素。

  114.      * @return 如果此set尚未包含指定元素,则返回true。

  115.      */

  116.     public boolean add(E e) {

  117.     return map.put(e, PRESENT)==null;

  118.     }


  119.     /**

  120.      * 如果指定元素存在于此set中,则将其移除。

  121.      * 更确切地讲,如果此set包含一个满足(o==null ? e==null : o.equals(e))的元素e,

  122.      * 则将其移除。如果此set已包含该元素,则返回true

  123.      * (或者:如果此set因调用而发生更改,则返回true)。(一旦调用返回,则此set不再包含该元素)。

  124.      *

  125.      * 底层实际调用HashMap的remove方法删除指定Entry。

  126.      * @param o 如果存在于此set中则需要将其移除的对象。

  127.      * @return 如果set包含指定元素,则返回true。

  128.      */

  129.     public boolean remove(Object o) {

  130.     return map.remove(o)==PRESENT;

  131.     }


  132.     /**

  133.      * 从此set中移除所有元素。此调用返回后,该set将为空。

  134.      *

  135.      * 底层实际调用HashMap的clear方法清空Entry中所有元素。

  136.      */

  137.     public void clear() {

  138.     map.clear();

  139.     }


  140.     /**

  141.      * 返回此HashSet实例的浅表副本:并没有复制这些元素本身。

  142.      *

  143.      * 底层实际调用HashMap的clone()方法,获取HashMap的浅表副本,并设置到HashSet中。

  144.      */

  145.     public Object clone() {

  146.         try {

  147.             HashSet<E> newSet = (HashSet<E>) super.clone();

  148.             newSet.map = (HashMap<E, Object>) map.clone();

  149.             return newSet;

  150.         } catch (CloneNotSupportedException e) {

  151.             throw new InternalError();

  152.         }

  153.     }

  154. }

3. 相关说明:

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

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