一、参数和构造方法
public class HashSet<E>
extends AbstractSet<E>
implements Set<E>, Cloneable, java.io.Serializable
{
static final long serialVersionUID = -5024744406713321676L;
//内部使用 HashMap
private transient HashMap<E,Object> map;
// 虚拟对象，用来作为 value 放到 map 中
private static final Object PRESENT = new Object();
public HashSet() {
map = new HashMap<>();
}
// 把另一个集合的元素全都添加到当前 Set 中
// 注意，这里初始化 map 的时候是计算了它的初始容量的
public HashSet(Collection<? extends E> c) {
map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
addAll(c);
}
// 指定初始容量和装载因子
public HashSet(int initialCapacity, float loadFactor) {
map = new HashMap<>(initialCapacity, loadFactor);
}
// 只指定初始容量
public HashSet(int initialCapacity) {
map = new HashMap<>(initialCapacity);
}
// 非 public，主要是给 LinkedHashSet 使用的
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
}
构造方法都是调用 HashMap 对应的构造方法。
最后一个构造方法有点特殊，它不是 public 的，意味着它只能被同一个包或者子类调用，这是 LinkedHashSet 专属的方法。
二、其他方法
- 遍历元素
接调用 map 的 keySet 的迭代器。
public Iterator<E> iterator() {
return map.keySet().iterator();
}
// 元素个数
public int size() {
return map.size();
}
// 检查是否为空
public boolean isEmpty() {
return map.isEmpty();
}
- 查询元素
Set 没有 get()方法哦，因为 get 似乎没有意义，不像 List 那样可以按 index 获取元素。
这里只要一个检查元素是否存在的方法 contains()，直接调用 map的 containsKey()方法。
// 检查是否包含某个元素
public boolean contains(Object o) {
return map.containsKey(o);
}
- 添加元素
直接调用 HashMap 的 put()方法，把元素本身作为 key，把 PRESENT 作为 value，也就是这个 map 中所有的 value 都是一样的。
// 添加元素
public boolean add(E e) {
return map.put(e, PRESENT)==null;
}
- 删除元素
直接调用 HashMap 的 remove()方法，注意 map 的 remove 返回是删除元素的value，而 Set 的 remove 返回的是 boolean 类型。
这里要检查一下，如果是 null 的话说明没有该元素，如果不是 null 肯定等于PRESENT。
// 删除元素
public boolean remove(Object o) {
return map.remove(o)==PRESENT;
}
// 清空所有元素
public void clear() {
map.clear();
}
- 克隆方法
// 克隆方法
@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);
}
}
- 序列化
// 序列化写出方法
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {
// 写出非 static 非 transient 属性
s.defaultWriteObject();
// 写出 map 的容量和装载因子
s.writeInt(map.capacity());
s.writeFloat(map.loadFactor());
// 写出元素个数
s.writeInt(map.size());
// 遍历写出所有元素
for (E e : map.keySet())
s.writeObject(e);
}
// 序列化读入方法
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
// 读入非 static 非 transient 属性
s.defaultReadObject();
// 读入容量, 并检查不能小于 0
int capacity = s.readInt();
if (capacity < 0) {
throw new InvalidObjectException("Illegal capacity: " +
capacity);
}
// 读入装载因子, 并检查不能小于等于 0 或者是 NaN(Not a Number)；
// java.lang.Float.NaN = 0.0f / 0.0f;
float loadFactor = s.readFloat();
if (loadFactor <= 0 || Float.isNaN(loadFactor)) {
throw new InvalidObjectException("Illegal load factor: " +
loadFactor);
}
// 读入元素个数并检查不能小于 0
int size = s.readInt();
if (size < 0) {
throw new InvalidObjectException("Illegal size: " +
size);
}
// 根据元素个数重新设置容量
// 这是为了保证 map 有足够的容量容纳所有元素, 防止无意义的扩容
capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f),
HashMap.MAXIMUM_CAPACITY);
// 创建 map, 检查是不是 LinkedHashSet 类型
map = (((HashSet<?>)this) instanceof LinkedHashSet ?
new LinkedHashMap<E,Object>(capacity, loadFactor) :
new HashMap<E,Object>(capacity, loadFactor));
// 读入所有元素, 并放入 map 中
for (int i=0; i<size; i++) {
@SuppressWarnings("unchecked")
E e = (E) s.readObject();
map.put(e, PRESENT);
}
}
- 迭代器
//可分割的迭代器, 主要用于多线程并行迭代处理时使用
public Spliterator<E> spliterator() {
return new HashMap.KeySpliterator<E,Object>(map, 0, -1, 0, 0);
}
三、总结
- （1）HashSet 内部使用 HashMap 的 key 存储元素，以此来保证元素不重复；
- （2）HashSet 是无序的，因为 HashMap 的 key 是无序的；
- （3）HashSet 中允许有一个 null 元素，因为 HashMap 允许 key 为 null；
- （4）HashSet 是非线程安全的；
- （5）HashSet 是没有 get()方法的；
