HashSet源码解析

HashSet源码解析

问题

（1）集合（Collection）和集合（Set）有什么区别？

（2）HashSet 怎么保证添加元素不重复？

（3）HashSet 是否允许 null 元素？

（4）HashSet 是有序的吗？

（5）HashSet 是同步的吗？

（6）什么是 fail-fast？

简介

HashSet 是 Set 的一种实现方式，底层主要使用 HashMap 来确保元素不重复。

对于 HashSet 和 HashMap，前者仅仅是对后者做了一层包装，也就是说 HashSet 里面有一个 HashMap（适配器模式）。

由于 HashSet 的本质是一个 HashMap，一些底层的方法分析就不在这里讲述了，参考HashMap源码解析。

继承体系

源码解析

属性

    // 内部使用HashMap存储元素，所以本质上HashSet就是HashMap
    private transient HashMap<E,Object> map;

    // 虚拟对象，用来作为value放到map中(在HashSet底层的HashMap中，key为要存储的元素，value统一为PRESENT)
    private static final Object PRESENT = new Object();

构造方法

    /*
     * 底层调用HashMap的无参构造器创建了一个HashMap对象，为map属性赋值。
     * 而HashMap的无参构造器只会为内部的加载因子赋值为0.75，不会初始化哈希表（懒加载）。
     */
	public HashSet() {
        map = new HashMap<>();
    }

	/*
	 * 传入一个集合。
	 * 初始化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);
    }

    // 非public，主要是给LinkedHashSet使用的
    HashSet(int initialCapacity, float loadFactor, boolean dummy) {
        map = new LinkedHashMap<>(initialCapacity, loadFactor);
    }

构造方法都是调用 HashMap 对应的构造方法。

最后一个构造方法有点特殊，它不是 public 的，意味着它只能被同一个包或者子类调用，这是 LinkedHashSet 专属的方法。

add(E e)

   public boolean add(E e) {
        /*
         * 调用的是HashMap的put()方法，key就是e(添加的元素)，value都是PRESENT(Object对象)
         * 也即map中所有的value都是PRESENT。
         */
        return map.put(e, PRESENT)==null;
    }

HashSet 保证元素不重复的关键就在于这个 add() 方法；

在 HashMap 中如果插入元素的 key 与当前桶位的 key 完全一致，则会认为这是一次替换操作，更新键值对的 value 值；

而对于 HashSet 的实现，添加相同的 key 时，利用是否存在映射对象 PRESENT 返回添加是否成功。对于 HashMap#putVal() 方法的返回值，如果这是一次正常的添加操作则会返回 null，如果这是一次替换操作则返回 oldValue(旧值)，而对应到 HashSet 中，就取决于这个返回值的判断：return map.put(e, PRESENT)==null;，如果该元素是第一次被添加到集合中，则 add() 方法返回 true，添加成功，因为 map.put() 的返回值为 null；而如果添加的元素在集合中已经存在，其实也走了一遍更新 key 对应的 value 的流程，但由于所有键值对的 value 都是同一个 PRESENT 对象，所以此时返回的 oldValue(旧值) 就是当前 PRESENT 对象，所以返回值不为 null，条件不成立，返回 false，即相当于添加失败。

remove(Object o)

    /*
     * 调用的是HashMap的remove()方法，删除元素
     */
	public boolean remove(Object o) {
        return map.remove(o)==PRESENT;
    }

这里要检查一下，如果是 null 的话说明没有该元素，如果不是 null 肯定等于 PRESENT。

contains()

Set 没有 get() 方法，因为 Set 是无序的，所以 get 没有意义，不像 List 那样可以按 index 获取元素，只能通过迭代器遍历。

   	/*
     * 判断Set是否存在指定元素
     */
	public boolean contains(Object o) {
        // 调用的是map的containsKey()方法
        return map.containsKey(o);
    }

iterator()

    /*
     * 迭代元素
     */
	public Iterator<E> iterator() {
        // 直接调用map的keySet的迭代器
        return map.keySet().iterator();
    }

size()

	/*
     * 查看set中的元素个数
     */
	public int size() {
     	// 返回map的size()
        return map.size();
    }

isEmpty()

    /*
     * 判断set中是否有元素
     */
	public boolean isEmpty() {
        // 调用map的isEmpty()
        return map.isEmpty();
    }

完整源码

HashSet 是基于 HashMap 实现的，所以其源码较少。

package java.util;

import java.io.InvalidObjectException;
import sun.misc.SharedSecrets;

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;

    // 虚拟元素，用来存到map元素的value中的，没有实际意义
    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);
    }

    // LinkedHashSet专用的方法
    // dummy是没有实际意义的, 只是为了跟上上面那个操持方法签名不同而已
    HashSet(int initialCapacity, float loadFactor, boolean dummy) {
        map = new LinkedHashMap<>(initialCapacity, loadFactor);
    }
    
    // 迭代器
    public Iterator<E> iterator() {
        return map.keySet().iterator();
    }

    // 元素个数
    public int size() {
        return map.size();
    }

    // 检查是否为空
    public boolean isEmpty() {
        return map.isEmpty();
    }

    // 检查是否包含某个元素
    public boolean contains(Object o) {
        return map.containsKey(o);
    }
    
    // 添加元素
    public boolean add(E e) {
        return map.put(e, PRESENT)==null;
    }

    // 删除元素
    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);

        // 再次检查某些东西，不重要的代码忽视掉
        SharedSecrets.getJavaOISAccess()
                     .checkArray(s, Map.Entry[].class, HashMap.tableSizeFor(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() 方法的，遍历元素只能通过迭代器；

彩蛋

阿里手册上有说，使用 java 中的集合时要自己指定集合的大小，通过这篇源码的分析，你知道初始化 HashMap 的时候初始容量怎么传吗？

我们发现有下面这个构造方法，很清楚明白地告诉了我们怎么指定容量。

假如，我们预估 HashMap 要存储 n 个元素，那么，它的容量就应该指定为 ((n/0.75f) + 1)，如果这个值小于 16，那就直接使用 16 得了。

初始化时指定容量是为了减少扩容的次数，提高效率。

    public HashSet(Collection<? extends E> c) {
        map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
        addAll(c);
    }

什么是 fail-fast？

fail-fast 机制是 java 集合中的一种错误机制。

当使用迭代器迭代时，如果发现集合有修改，则快速失败做出响应，抛出 ConcurrentModificationException 异常。

这种修改有可能是其它线程的修改，也有可能是当前线程自己的修改导致的，比如迭代的过程中直接调用 remove() 删除元素等。

另外，并不是 java 中所有的集合都有 fail-fast 的机制。比如，像最终一致性的 ConcurrentHashMap、CopyOnWriterArrayList 等都是没有 fast-fail 的。

那么，fail-fast 是怎么实现的呢？

细心的同学可能会发现，像 ArrayList、HashMap 中都有一个属性叫 modCount，每次对集合的修改这个值都会加 1，在遍历前记录这个值到 expectedModCount 中，遍历中检查两者是否一致，如果出现不一致就说明有修改，则抛出 ConcurrentModificationException 异常。

---

参考文章

• 彤哥读源码_死磕 java集合之HashSet源码分析
• shstart7_HashSet源码解析