一、简介
HashSet是Java中常用的一个集合类,是Set接口的一个实现类,而Set接口继承自Collection接口,所以HashSet是Collection的一个实现类。下面看一下HashSet底层代码的实现:
- HashSet实现了由一个哈希表(实际上是一个HashMap实例)支持的Set接口。它不保证集合的迭代顺序(无序),并且允许null元素;
- HashSet的实现不是同步的,如果在多线程环境下,多个线程访问会出现线程不安全现象;(Set s = Collections.synchronizedSet(new HashSet(...));防止意外对set的非同步访问);
二、源码
- HashSet继承自AbstractSet抽象类,并且实现了Set<E>, Cloneable, java.io.Serializable接口;
public class HashSet<E>
extends AbstractSet<E>
implements Set<E>, Cloneable, java.io.Serializable
{
//....
}
- 属性
//序列化ID
static final long serialVersionUID = -5024744406713321676L;
//底层通过hashMap实现
private transient HashMap<E,Object> map;
// Dummy value to associate with an Object in the backing Map
//用来填充底层数据结构HashMap中的value,因为HashSet只用key存储数据。
private static final Object PRESENT = new Object();
- 构造方法
//底层通过创建一个HashMap对象,并且使用默认初始容量16和默认负载因子0.75
public HashSet() {
map = new HashMap<>();
}
//构造一个包含指定元素的新集合。
public HashSet(Collection<? extends E> c) {
//判断新集合的容量是否大于16,大于16返回新容量,否则直接返回16
map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
//调用AbstractCollection.addAll()方法,然后再调用HashSet的add()方法把集合中的所有元素添加到了集合中。
addAll(c);
}
//AbstractCollection.java addAll()方法
public boolean addAll(Collection<? extends E> c) {
boolean modified = false;
for (E e : c)
if (add(e))
modified = true;
return modified;
}
//AbstractCollection.java add()方法
//注意,不能直接调用AbstractCollection类的add()方法
public boolean add(E e) {
throw new UnsupportedOperationException();
}
//通过指定初始化容量和负载因子创建HashMap对象
public HashSet(int initialCapacity, float loadFactor) {
map = new HashMap<>(initialCapacity, loadFactor);
}
//使用指定的初始容量和默认负载因子(0.75)创建HashMap
public HashSet(int initialCapacity) {
map = new HashMap<>(initialCapacity);
}
//构造一个新的空的LinkedHashMap,支持的HashMap实例是一个LinkedHashMap,它具有指定的初始容量和指定的负载因子。
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
- iterator()
//返回一个迭代器。元素没有特定的顺序返回。
//实际上是返回hashmap的key键的集合
public Iterator<E> iterator() {
return map.keySet().iterator();
}
- size()
//hashSet的长度,实际是返回的是底层map的长度
public int size() {
return map.size();
}
- isEmpty()
//判断hashset是否为空,实际是判断map是否为空
public boolean isEmpty() {
return map.isEmpty();
}
- contains()
//如果该集合包含指定的元素,则返回true
public boolean contains(Object o) {
//因为HashSet使用HashMap的键保存数据,所以直接判断map中是否包含指定的key
return map.containsKey(o);
}
- add()
//如果指定的元素尚未出现,则将其添加到此集合。
public boolean add(E e) {
//底层仍然利用了HashMap键进行了元素的添加。
//HashMap的put()方法中,返回值是对应HashMap中键值对中的值,而值总是PRESENT,并且PRESENT一直是null
//所以,如果此集合尚未包含指定的元素,返回true
return map.put(e, PRESENT)==null;
}
- remove()
//从集合中删除指定的元素
public boolean remove(Object o) {
//map的remove()删除之后返回对应的值,而hashset中值一直是PRESENT
//所以,如果集合包含指定的元素,返回true
return map.remove(o)==PRESENT;
}
- clear()
//从这个集合中移除所有的元素。这个集合在这个调用返回后将是空的
public void clear() {
map.clear();
}
- clone()
//返回这个HashSet实例的浅拷贝
public Object clone() {
try {
//调用Object的clone()方法
HashSet<E> newSet = (HashSet<E>) super.clone();
//将底层的map也克隆,然后再赋值给newSet
newSet.map = (HashMap<E, Object>) map.clone();
return newSet;
} catch (CloneNotSupportedException e) {
throw new InternalError(e);
}
}
- writeObject()、readObject()
//将这个HashSet实例的状态保存到一个流中(即序列化它)。
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
// Write out any hidden serialization magic
s.defaultWriteObject();
// Write out HashMap capacity and load factor
//写出HashMap容量和负载因子
s.writeInt(map.capacity());
s.writeFloat(map.loadFactor());
// Write out size
//写出大小
s.writeInt(map.size());
// Write out all elements in the proper order.
//按适当的顺序写出所有的元素。
for (E e : map.keySet())
s.writeObject(e);
}
//从流中重新构造HashSet实例(即反序列化它)。
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// Read in any hidden serialization magic
s.defaultReadObject();
// Read capacity and verify non-negative.
//读取容量并验证非负
int capacity = s.readInt();
if (capacity < 0) {
throw new InvalidObjectException("Illegal capacity: " +
capacity);
}
// Read load factor and verify positive and non NaN.
//读取负载因子,验证正非NaN。
float loadFactor = s.readFloat();
if (loadFactor <= 0 || Float.isNaN(loadFactor)) {
throw new InvalidObjectException("Illegal load factor: " +
loadFactor);
}
// Read size and verify non-negative.
//读取大小并验证非负。
int size = s.readInt();
if (size < 0) {
throw new InvalidObjectException("Illegal size: " +
size);
}
// Set the capacity according to the size and load factor ensuring that
// the HashMap is at least 25% full but clamping to maximum capacity.
//根据大小和负载因子设置容量,确保HashMap至少25%已满,但保持最大容量。
capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f),
HashMap.MAXIMUM_CAPACITY);
// Create backing HashMap
//创建HashMap
map = (((HashSet<?>)this) instanceof LinkedHashSet ?
new LinkedHashMap<E,Object>(capacity, loadFactor) :
new HashMap<E,Object>(capacity, loadFactor));
// Read in all elements in the proper order.
//按适当的顺序读取所有元素。
for (int i=0; i<size; i++) {
@SuppressWarnings("unchecked")
E e = (E) s.readObject();
//挨个放入map中
map.put(e, PRESENT);
}
}
- equals()
// 使用父类AbstractSet中的equals实现
public boolean equals(Object o) {
//判断是否是当前对象
if (o == this)
return true;
//判断是否是Set类型
if (!(o instanceof Set))
return false;
Collection<?> c = (Collection<?>) o;
//equals()的前提是长度必须相等
if (c.size() != size())
//如果长度不相等,返回false
return false;
try {
//调用AbstractCollection.java类中containsAll()方法
return containsAll(c);
} catch (ClassCastException unused) {
return false;
} catch (NullPointerException unused) {
return false;
}
}
//AbstractCollection.java containsAll()
public boolean containsAll(Collection<?> c) {
//循环遍历集合
for (Object e : c)
//挨个判断元素是否在集合中(与顺序无关)
if (!contains(e))
return false;
return true;
}
//AbstractCollection.java contains()
public boolean contains(Object o) {
Iterator<E> it = iterator();
if (o==null) {
while (it.hasNext())
if (it.next()==null)
return true;
} else {
while (it.hasNext())
if (o.equals(it.next()))
return true;
}
return false;
}