精尽 JDK 源码解析 —— 集合（五）哈希集合 HashSet - 《精尽 JDK》

艿艿：突然有点词穷，不知道怎么介绍，嘿嘿。

HashSet ，基于 HashMap 的 Set 实现类。在业务中，如果我们有排重的需求，一般会考虑使用 HashSet 。

在 Redis 提供的 Set 数据结构，不考虑编码的情况下，它是基于 Redis 自身的 Hash 数据结构实现的。这点，JDK 和 Redis 是相同的。😈 感兴趣的胖友，看完本文后，可以自己去撸一撸。

HashSet 实现的接口、继承的类，如下图所示：
类图

实现 java.util.Set 接口，并继承 java.util.AbstractSet 抽像类。
实现 java.io.Serializable 接口。
实现 java.lang.Cloneable 接口。

HashSet 只有一个属性，那就是 map 。代码如下：

private transient HashMap map;

map 的 key ，存储 HashSet 的每个 key 。
map 的 value ，因为 HashSet 没有 value 的需要，所以使用一个统一的 PRESENT 即可。代码如下：
private static final Object PRESENT = new Object();

HashSet 一共有 5 个构造方法，代码如下：

public HashSet() {
map = new HashMap<>();
}

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);
}

HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<>(initialCapacity, loadFactor);
}

在构造方法中，会创建 HashMap 或 LinkedHashMap 对象。

#add(E e) 方法，添加单个元素。代码如下：

public boolean add(E e) {
return map.put(e, PRESENT)==null;
}

map 的 value 值，就是我们看到的 PRESENT 。

而添加多个元素，继承自 AbstractCollection 抽象类，通过 #addAll(Collection<? extends E> c) 方法，代码如下：

public boolean addAll(Collection<? extends E> c) {
boolean modified = false;

for (E e : c)
if (add(e))
modified = true;
return modified;
}

在方法内部，会逐个调用 #add(E e) 方法，逐个添加单个元素。

#remove(Object key) 方法，移除 key 对应的 value ，并返回该 value 。代码如下：

public boolean remove(Object o) {
return map.remove(o) == PRESENT;
}

#contains(Object key) 方法，判断 key 是否存在。代码如下：

public boolean contains(Object o) {
return map.containsKey(o);
}

艿艿：后面的内容，快速看即可。

#toArray(T[] a) 方法，转换出 key 数组返回。代码如下：

@Override
public Object[] toArray() {
return map.keysToArray(new Object[map.size()]);
}

@Override
public T[] toArray(T[] a) {
return map.keysToArray(map.prepareArray(a));
}

#clear() 方法，清空 HashSet 。代码如下：

public void clear() {
map.clear();
}

#writeObject(ObjectOutputStream s) 方法，序列化 HashSet 对象。代码如下：

@java.io.Serial
private void writeObject(java.io.ObjectOutputStream s)
throws java.io.IOException {

s.defaultWriteObject();

s.writeInt(map.capacity());

s.writeFloat(map.loadFactor());

s.writeInt(map.size());

for (E e : map.keySet())
s.writeObject(e);
}

#readObject(ObjectInputStream s) 方法，反序列化成 HashSet 对象。代码如下：

@java.io.Serial
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {

s.defaultReadObject();

int capacity = s.readInt();

if (capacity < 0) {
throw new InvalidObjectException(“Illegal capacity:” +
capacity);
}

float loadFactor = s.readFloat();

if (loadFactor <= 0 || Float.isNaN(loadFactor)) {
throw new InvalidObjectException(“Illegal load factor:” +
loadFactor);
}

int size = s.readInt();

if (size < 0) {
throw new InvalidObjectException(“Illegal size:” +
size);
}

capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f),
HashMap.MAXIMUM_CAPACITY);

SharedSecrets.getJavaObjectInputStreamAccess()
.checkArray(s, Map.Entry[].class, HashMap.tableSizeFor(capacity));

map = (((HashSet<?>)this) instanceof LinkedHashSet ?
new LinkedHashMap<>(capacity, loadFactor) :
new HashMap<>(capacity, loadFactor));

for (int i=0; i@SuppressWarnings(“unchecked”)
E e = (E) s.readObject();
map.put(e, PRESENT);
}
}

#clone() 方法，克隆 HashSet 对象。代码如下：

public Object clone() {
try {

HashSet newSet = (HashSet) super.clone();

newSet.map = (HashMap) map.clone();

return newSet;
} catch (CloneNotSupportedException e) {
throw new InternalError(e);
}
}

#iterator() 方法，获得迭代器。代码如下：

public Iterator iterator() {
return map.keySet().iterator();
}

😈 总的来说，比较简单，相信胖友一会会时间就已经看完了。

可能偶尔我们会使用到 LinkedHashSet ，它是 HashSet 的子类，胖友自己去看。更加简单~

关于 HashSet 的总结，只有一句话：HashSet 是基于 HashMap 的 Set 实现类。
http://svip.iocoder.cn/JDK/Collection-HashSet/