[學習筆記-Java集合-9] Set - HashSet源碼分析

時間 2019-11-08

標籤學習筆記 java 集合 set hashset 源碼分析欄目 Java 简体版

原文原文鏈接

簡介

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

廣義上來說，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都是同樣的。this

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

刪除元素

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

這裏要檢查一下，若是是null的話說明沒有該元素，若是不是null確定等於PRESENT。code

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