HashSet源碼閱讀

一、簡介

HashSet是Java中常用的一個集合類,是Set接口的一個實現類,而Set接口繼承自Collection接口,所以HashSet是Collection的一個實現類。下面看一下HashSet底層代碼的實現:

  • HashSet實現了由一個哈希表(實際上是一個HashMap實例)支持的Set接口。它不保證集合的迭代順序(無序),並且允許null元素
  • HashSet的實現不是同步的,如果在多線程環境下,多個線程訪問會出現線程不安全現象;(Set s = Collections.synchronizedSet(new HashSet(...));防止意外對set的非同步訪問);

二、源碼

  • HashSet繼承自AbstractSet抽象類,並且實現了Set<E>, Cloneable, java.io.Serializable接口;
public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable
{
    //....
}
  • 屬性
//序列化ID
static final long serialVersionUID = -5024744406713321676L;

//底層通過hashMap實現
private transient HashMap<E,Object> map;

// Dummy value to associate with an Object in the backing Map
//用來填充底層數據結構HashMap中的value,因爲HashSet只用key存儲數據。
private static final Object PRESENT = new Object();
  • 構造方法
//底層通過創建一個HashMap對象,並且使用默認初始容量16和默認負載因子0.75
public HashSet() {
    map = new HashMap<>();
}

//構造一個包含指定元素的新集合。
public HashSet(Collection<? extends E> c) {
    //判斷新集合的容量是否大於16,大於16返回新容量,否則直接返回16
    map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
    //調用AbstractCollection.addAll()方法,然後再調用HashSet的add()方法把集合中的所有元素添加到了集合中。
    addAll(c);
}

//AbstractCollection.java   addAll()方法
public boolean addAll(Collection<? extends E> c) {
    boolean modified = false;
    for (E e : c)
        if (add(e))
            modified = true;
    return modified;
}

//AbstractCollection.java   add()方法
//注意,不能直接調用AbstractCollection類的add()方法
public boolean add(E e) {
    throw new UnsupportedOperationException();
}


//通過指定初始化容量和負載因子創建HashMap對象
public HashSet(int initialCapacity, float loadFactor) {
    map = new HashMap<>(initialCapacity, loadFactor);
}

//使用指定的初始容量和默認負載因子(0.75)創建HashMap
public HashSet(int initialCapacity) {
    map = new HashMap<>(initialCapacity);
}

//構造一個新的空的LinkedHashMap,支持的HashMap實例是一個LinkedHashMap,它具有指定的初始容量和指定的負載因子。
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
    map = new LinkedHashMap<>(initialCapacity, loadFactor);
}
  •  iterator()
//返回一個迭代器。元素沒有特定的順序返回。
//實際上是返回hashmap的key鍵的集合
public Iterator<E> iterator() {
    return map.keySet().iterator();
}
  • size()
//hashSet的長度,實際是返回的是底層map的長度
public int size() {
    return map.size();
}
  • isEmpty()
//判斷hashset是否爲空,實際是判斷map是否爲空
public boolean isEmpty() {
    return map.isEmpty();
}
  • contains()
//如果該集合包含指定的元素,則返回true
public boolean contains(Object o) {
    //因爲HashSet使用HashMap的鍵保存數據,所以直接判斷map中是否包含指定的key
    return map.containsKey(o);
}
  • add()
//如果指定的元素尚未出現,則將其添加到此集合。
public boolean add(E e) {
    //底層仍然利用了HashMap鍵進行了元素的添加。
    //HashMap的put()方法中,返回值是對應HashMap中鍵值對中的值,而值總是PRESENT,並且PRESENT一直是null
    //所以,如果此集合尚未包含指定的元素,返回true
    return map.put(e, PRESENT)==null;
}
  • remove()
//從集合中刪除指定的元素
public boolean remove(Object o) {
    //map的remove()刪除之後返回對應的值,而hashset中值一直是PRESENT
    //所以,如果集合包含指定的元素,返回true
    return map.remove(o)==PRESENT;
}
  • clear()
//從這個集合中移除所有的元素。這個集合在這個調用返回後將是空的
public void clear() {
    map.clear();
}
  • clone()
//返回這個HashSet實例的淺拷貝
public Object clone() {
    try {
        //調用Object的clone()方法
        HashSet<E> newSet = (HashSet<E>) super.clone();
        //將底層的map也克隆,然後再賦值給newSet
        newSet.map = (HashMap<E, Object>) map.clone();
        return newSet;
    } catch (CloneNotSupportedException e) {
        throw new InternalError(e);
    }
}
  • writeObject()、readObject()
//將這個HashSet實例的狀態保存到一個流中(即序列化它)。
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
    //寫出HashMap容量和負載因子
    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);
}

//從流中重新構造HashSet實例(即反序列化它)。
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.
    //讀取負載因子,驗證正非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.
    //根據大小和負載因子設置容量,確保HashMap至少25%已滿,但保持最大容量。
    capacity = (int) Math.min(size * Math.min(1 / loadFactor, 4.0f),
            HashMap.MAXIMUM_CAPACITY);

    // Create backing HashMap
    //創建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中
        map.put(e, PRESENT);
    }
}
  • equals()
// 使用父類AbstractSet中的equals實現
public boolean equals(Object o) {
    //判斷是否是當前對象
    if (o == this)
        return true;
    //判斷是否是Set類型
    if (!(o instanceof Set))
        return false;
    Collection<?> c = (Collection<?>) o;
    //equals()的前提是長度必須相等
    if (c.size() != size())
       //如果長度不相等,返回false
        return false;
    try {
        //調用AbstractCollection.java類中containsAll()方法
        return containsAll(c);
    } catch (ClassCastException unused)   {
        return false;
    } catch (NullPointerException unused) {
        return false;
    }
}

//AbstractCollection.java   containsAll()
public boolean containsAll(Collection<?> c) {
    //循環遍歷集合
    for (Object e : c)
       //挨個判斷元素是否在集合中(與順序無關)
        if (!contains(e))
            return false;
    return true;
}

//AbstractCollection.java   contains()
public boolean contains(Object o) {
    Iterator<E> it = iterator();
    if (o==null) {
        while (it.hasNext())
            if (it.next()==null)
                return true;
    } else {
        while (it.hasNext())
            if (o.equals(it.next()))
                return true;
    }
    return false;
}

 

發佈了206 篇原創文章 · 獲贊 89 · 訪問量 14萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章