HashSet源码分析

一、HashSet继承关系

1、继承

    public boolean equals(Object o) {
        if (o == this)
            return true;

		// o没有实现Set接口，返回false
        if (!(o instanceof Set))
            return false;
        // 向下转换
        Collection<?> c = (Collection<?>) o;
        // 元素个数不相等，返回false
        if (c.size() != size())
            return false;
        try {
        	// 判断是否包含c中的所有元素
            return containsAll(c);
        } catch (ClassCastException unused)   {
            return false;
        } catch (NullPointerException unused) {
            return false;
        }
    }

	// 迭代器遍历，返回所有对象的hashCode的和
    public int hashCode() {
        int h = 0;
        Iterator<E> i = iterator();
        while (i.hasNext()) {
            E obj = i.next();
            if (obj != null)
                h += obj.hashCode();
        }
        return h;
    }

	// 删除存在于c中所有元素，遍历少数量的集合
    public boolean removeAll(Collection<?> c) {
    	// 如果c为null，抛出空指针异常
        Objects.requireNonNull(c);
        boolean modified = false;

        if (size() > c.size()) {
            for (Iterator<?> i = c.iterator(); i.hasNext(); )
                modified |= remove(i.next());
        } else {
            for (Iterator<?> i = iterator(); i.hasNext(); ) {
                if (c.contains(i.next())) {
                    i.remove();
                    modified = true;
                }
            }
        }
        return modified;
    }

modified |= remove(i.next())的说明：|为或运算符，只要remove(i.next())方法删除成功一次，modified就为true，否则为false。

2、接口

• Serializable接口，表明它支持序列化
• Cloneable接口，表明它支持克隆，可以调用超类的clone()方法进行浅拷贝

二、HashSet类源码解读

1、属性

	// 版本号
    static final long serialVersionUID = -5024744406713321676L;

	// 底层使用HashMap存储数据
	// 使用transient修饰，序列化时忽略此属性
    private transient HashMap<E,Object> map;

	// 用来填充底层数据结构HashMap中的value，因为HashSet只用key存储数据
    private static final Object PRESENT = new Object();

2、构造器

构建了一个空的set集合，其底层的HashMap实例使用默认的初始容量（16）和加载因子（0.75）

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

使用HashMap(int)构造器，创建了一个新的HashSet

初始容量由对象 c 的 临界值 和 默认初始化容量 的最大值决定

临界值 = 数组长度容量 * 负载因子

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

	/**
	 * 以指定的initialCapacity和loadFactor构造一个HashMap。
	 */
    public HashSet(int initialCapacity, float loadFactor) {
        map = new HashMap<>(initialCapacity, loadFactor);
    }

	/**
	 * 以指定的initialCapacity和默认的loadFactor（0.75）构造一个HashMap。
	 */
    public HashSet(int initialCapacity) {
        map = new HashMap<>(initialCapacity);
    }
    
    /**
	 * 以指定的initialCapacity和loadFactor构造一个LinkedHashMap。
     * dummy 为标识，该构造函数主要作用是对LinkedHashSet起到一个支持作用，访问权限为包权限，不对外公开的
	 */
    HashSet(int initialCapacity, float loadFactor, boolean dummy) {
        map = new LinkedHashMap<>(initialCapacity, loadFactor);
    }

3、方法

HashSet内部的功能都是基于HashMap实现

    /**
     * 返回迭代器，用于迭代
     */
    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);
    }

    /**
     * 添加元素，如果 Set集合中未包含该元素，返回true
     */
    public boolean add(E e) {
        return map.put(e, PRESENT)==null;
    }

    /**
     * 删除元素，如果Set集合包含该元素，返回true
     */
    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);
        }
    }

自定义 序列化 和 反序列化 方法

writeObject和readObject都是private方法，它如何被外部类（ObjectOutputStream和ObjectInputStream）调用？

利用反射机制。ObjectOutputStream 和 ObjectInputStream 使用了反射来寻找是否声明了这两个方法。因为它们使用getPrivateMethod，所以这些方法不得不被声明为priate以至于供ObjectOutputStream来使用。

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

    /**
     * Reconstitute the <tt>HashSet</tt> instance from a stream (that is,
     * deserialize it).
     */
    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.
        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.
        capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f),
                HashMap.MAXIMUM_CAPACITY);

        // Create backing 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.put(e, PRESENT);
        }
    }

三、总结

HashSet底层是基于HashMap实现的，HashSet内部通过使用HashMap的键来存储集合中的元素。

1. HashMap不能存储重复的Key，所以HashSet不能存放重复元素。
2. 由于HashMap的key是基于hashCode存储对象的，所以hashSet中存放的对象也是无序的。
3. 内部的HashMap的所有值都是PRESENT，PRESENT在实例域的地方直接初始化了，而且不允许改变。
4. HashSet没有提供get方法，但是可以通过Iterator迭代器获取数据

参考文章：https://www.cnblogs.com/DarkSki/p/15733162.html