HashSet 概述
HashSet 实现 Set 接口,由哈希表(实际上是一个 HashMap 实例)支持。它不保证 set 的迭代顺序;特别是它不保证该顺序恒久不变。此类允许使用 null 元素。
HashSet 的实现
对于 HashSet 而言,它是基于 HashMap 实现的,HashSet 底层使用 HashMap 来保存所有元素,因此 HashSet 的实现比较简单,相关 HashSet 的操作,基本上都是直接调用底层 HashMap 的相关方法来完成, 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
* <p>
* 实际底层使用默认的加载因子0.75和足以包含指定collection中所有
* 元素的初始容量来创建一个HashMap
*
* @param c 其中的元素将存放在此set中的collection
*/
public HashSet(Collection<? extends E> c) {
map = new HashMap<>(Math.max((int) (c.size() / .75f) + 1, 16));
addAll(c);
}
/**
* 以指定的initialCapacity和loadFactor构造一个空的HashSet
* <p>
* 实际底层以相应的参数构造一个空的HashMap
*
* @param initialCapacity 初始容量
* @param loadFactor 加载因子
*/
public HashSet(int initialCapacity, float loadFactor) {
map = new HashMap<>(initialCapacity, loadFactor);
}
/**
* 以指定的initialCapacity构造一个空的HashSet
* <p>
* 实际底层以相应的参数及加载因子为0.75构造一个HashMap
*
* @param initialCapacity 初始容量
*/
public HashSet(int initialCapacity) {
map = new HashMap<>(initialCapacity);
}
/**
* *以指定的initialCapacity 和loadFactor 构造一个新的空链接哈希集合。
* 此构造函数为包访问权限,不对外公开,实际只是是对LinkedHashSet 的支持
* <p>
* 实际底层会以指定的参数构造一个空LinkedHashMap 实例来实现
*
* @param initialCapacity 初始容量
* @param loadFactor 加载因子
* @param dummy 标记
*/
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
/**
* 返回对此set 中元素进行迭代的迭代器。返回元素的顺序并不是特定的。
* <p>
* 底层实际调用底层HashMap 的keySet 来返回所有的key。
* 可见HashSet 中的元素,只是存放在了底层HashMap 的key 上,
* value 使用一个static final 的Object 对象标识。
*
* @return 对此set 中元素进行迭代的Iterator。
*/
public Iterator<E> iterator() {
return map.keySet().iterator();
}
/**
* 返回此set 中的元素的数量(set 的容量)。
* <p>
* 底层实际调用HashMap 的size()方法返回Entry 的数量,就得到该 Set 中元素的个数。
*
* @return 此set 中的元素的数量(set 的容量)。
*/
public int size() {
return map.size();
}
/**
* 如果此set 不包含任何元素,则返回true。
* <p>
* 底层实际调用HashMap 的isEmpty()判断该HashSet 是否为空。
*
* @return 如果此set 不包含任何元素,则返回true。
*/
public boolean isEmpty() {
return map.isEmpty();
}
/**
* 如果此set 包含指定元素,则返回true。
* 更确切地讲,当且仅当此set 包含一个满足(o==null ? e==null : o.equals(e))
* 的e元素时,返回true。
* <p>
* 底层实际调用HashMap 的containsKey 判断是否包含指定key。
*/
public boolean contains(Object o) {
return map.containsKey(o);
}
/**
* 如果此set 中尚未包含指定元素,则添加指定元素。
* 更确切地讲,如果此 set 没有包含满足(e==null ? e2==null : e.equals(e2))
* 的元素 e2,则向此 set 添加指定的元素e。
* 如果此set 已包含该元素,则该调用不更改set 并返回false。
* <p>
* 底层实际将将该元素作为key 放入HashMap。
* 由于 HashMap的put()方法添加key-value对时,当新放入 HashMap的Entry中key
* 与集合中原有Entry的key 相同(hashCode()返回值相等,通过equals比较也返回true),
* 新添加的Entry的value会将覆盖原来Entry的value,但key不会有任何改变,
* 因此如果向HashSet 中添加一个已经存在的元素时,新添加的集合元素将不会被放入HashMap中,
* 原来的元素也不会有任何改变,这也就满足了Set中元素不重复的特性。
*
* @param e 将添加到此set 中的元素。
* @return 如果此set 尚未包含指定元素,则返回true。
*/
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 不再包含该元素)。
* <p>
* 底层实际调用HashMap 的remove 方法删除指定Entry。
*
* @param o 如果存在于此set 中则需要将其移除的对象。
* @return 如果set 包含指定元素,则返回true。
*/
public boolean remove(Object o) {
return map.remove(o) == PRESENT;
}
/**
*从此set中移除所有元素。此调用返回后,该set将为空。
*
*底层实际调用HashMap的clear方法清空Entry中所有元素。
*/
public void clear() {
map.clear();
}
/**
*返回此HashSet实例的浅表副本:并没有复制这些元素本身
*
*底层实际调用HashMap 的clone()方法,获取HashMap 的浅表副本,并设置到HashSe
*/
@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);
}
}
}
说明:对于 HashSet 中保存的对象,请注意正确重写其 equals 和 hashCode 方法,以保证放入的对象的唯一性