HashSet继承结构:
public class HashSet<E>
extends AbstractSet<E>
implements Set<E>, Cloneable, java.io.Serializable
HashSet 继承于AbstractSet 该类提供了Set 接口的骨架实现,以最大限度地减少实现此接口所需的工作量。
实现Set接口,标志着内部元素是无序的,元素是不可以重复的。
实现Cloneable接口,标识着可以它可以被复制。
实现Serializable接口,标识着可被序列化。
HashSet实现Set接口,由哈希表(实际上是一个HashMap实例)支持(见下方源码);
它不保证set 的迭代顺序;特别是它不保证该顺序恒久不变;
此类允许使用null元素。
HashSet源码:
对于HashSet而言,它是基于HashMap实现的,HashSet底层使用HashMap来保存所有元素,因此HashSet 的实现比较简单,相关HashSet的操作,基本上都是直接调用底层HashMap的相关方法来完成:
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<>();
}
//构造一个包含指定集合中元素的新集合。HashMap是使用默认加载因子(0.75)和足以包含指定
//集合中元素的初始容量创建的。
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实例来实现。
//initialCapacity 初始容量。 loadFactor 加载因子。 dummy 标记。
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
//返回对此set中元素进行迭代的迭代器。返回元素的顺序并不是特定的。
//底层实际调用底层HashMap的keySet来返回所有的key。 可见HashSet中的元素,只是存放在了底层HashMap的key上
//value使用一个static final的Object对象标识。
// @return 对此set中元素进行迭代的Iterator。
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。
//更确切地讲,当且仅当此set包含一个满足(o==null ? e==null : o.equals(e))
//的e元素时,返回true。
//底层实际调用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。
*
* 底层实际将将该元素作为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不再包含该元素)。
*
* 底层实际调用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的浅表副本,并设置到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);
}
}
}
总结:
HashSet就是限制了功能的HashMap,所以了解HashMap的实现原理,这个HashSet自然就通;
对于HashSet中保存的对象,主要要正确重写equals方法和hashCode方法,以保证放入Set对象的唯一性;
虽说时Set是对于重复的元素不放入,倒不如直接说是底层的Map直接把原值替代了(这个Set的put方法的返回值真有意思);
HashSet没有提供get()方法,原因是同HashMap一样,Set内部是无序的,只能通过迭代的方式获得;
参考: