死磕 java集合之HashSet源碼分析

問題

（1）集合（Collection）和集合（Set）有什么區別？

（2）HashSet怎么保證添加元素不重復？

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

（4）HashSet是有序的嗎？

（5）HashSet是同步的嗎？

（6）什么是fail-fast？

簡介

集合，這個概念有點模糊。

廣義上來講，java中的集合是指java.util包下面的容器類，包括和Collection及Map相關的所有類。

中義上來講，我們一般說集合特指java集合中的Collection相關的類，不包含Map相關的類。

狹義上來講，數學上的集合是指不包含重復元素的容器，即集合中不存在兩個相同的元素，在java里面對應Set。

具體怎么來理解還是要看上下文環境。

比如，面試別人讓你說下java中的集合，這時候肯定是廣義上的。

再比如，下面我們講的把另一個集合中的元素全部添加到Set中，這時候就是中義上的。

HashSet是Set的一種實現方式，底層主要使用HashMap來確保元素不重復。

源碼分析

屬性

    // 內部使用HashMap
    private transient HashMap<E,Object> map;

    // 虛擬對象，用來作為value放到map中
    private static final Object PRESENT = new Object();

構造方法

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

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

構造方法都是調用HashMap對應的構造方法。

最后一個構造方法有點特殊，它不是public的，意味著它只能被同一個包或者子類調用，這是LinkedHashSet專屬的方法。

添加元素

直接調用HashMap的put()方法，把元素本身作為key，把PRESENT作為value，也就是這個map中所有的value都是一樣的。

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

刪除元素

直接調用HashMap的remove()方法，注意map的remove返回是刪除元素的value，而Set的remov返回的是boolean類型。

這里要檢查一下，如果是null的話說明沒有該元素，如果不是null肯定等于PRESENT。

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

查詢元素

Set沒有get()方法哦，因為get似乎沒有意義，不像List那樣可以按index獲取元素。

這里只要一個檢查元素是否存在的方法contains()，直接調用map的containsKey()方法。

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

遍歷元素

直接調用map的keySet的迭代器。

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

全部源碼

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()方法的；

彩蛋

（1）阿里手冊上有說，使用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);
}

（2）什么是fail-fast？

fail-fast機制是java集合中的一種錯誤機制。

當使用迭代器迭代時，如果發現集合有修改，則快速失敗做出響應，拋出ConcurrentModificationException異常。

這種修改有可能是其它線程的修改，也有可能是當前線程自己的修改導致的，比如迭代的過程中直接調用remove()刪除元素等。

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

那么，fail-fast是怎么實現的呢？

細心的同學可能會發現，像ArrayList、HashMap中都有一個屬性叫modCount，每次對集合的修改這個值都會加1，在遍歷前記錄這個值到expectedModCount中，遍歷中檢查兩者是否一致，如果出現不一致就說明有修改，則拋出ConcurrentModificationException異常。

歡迎關注我的公眾號“彤哥讀源碼”，查看更多源碼系列文章, 與彤哥一起暢游源碼的海洋。