Java學習筆記之HashSet集合保證元素唯一性地源碼解析

HashSet是Set接口的一個實現類,它的底層是HashMap,HashMap的底層是數組加鏈表.
它是怎麼保證元素唯一性的呢?我們來看看源碼:

public V put(K key, V value) {
    /**四個參數，第一個hash值，第四個參數表示如果該key存在值，如果爲null的話，則插入新的value，最後一個參數，在hashMap中沒有用，可以不用管，使用默認的即可**/
    return putVal(hash(key), key, value, false, true);
}

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
    boolean evict) {
    //tab 哈希數組，p 該哈希桶的首節點，n hashMap的長度，i 計算出的數組下標
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    //獲取長度並進行擴容，使用的是懶加載，table一開始是沒有加載的，等put後纔開始加載
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length; //初始化長度16
    /**如果計算出的該哈希桶的位置沒有值，則把新插入的key-value放到此處，此處就算沒有插入成功，也就是發生哈希衝突時也會把哈希桶的首節點賦予p**/
    if ((p = tab[i = (n - 1) & hash]) == null)
        tab[i] = newNode(hash, key, value, null);
    //發生哈希衝突的幾種情況
    else {
        // e 臨時節點的作用， k 存放該當前節點的key
        Node<K,V> e; K k;
        //第一種，插入的key-value的hash值，key都與當前節點的相等，e = p，則表示爲首節點
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        //第二種，hash值不等於首節點，判斷該p是否屬於紅黑樹的節點
        else if (p instanceof TreeNode)
            /**爲紅黑樹的節點，則在紅黑樹中進行添加，如果該節點已經存在，則返回該節點（不爲null），該值很重要，用來判斷put操作是否成功，如果添加成功返回null**/
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        //第三種，hash值不等於首節點，不爲紅黑樹的節點，則爲鏈表的節點
        else {
            //遍歷該鏈表
            for (int binCount = 0; ; ++binCount) {
                //如果找到尾部，則表明添加的key-value沒有重複，在尾部進行添加
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    //判斷是否要轉換爲紅黑樹結構
                    if (binCount >= TREEIFY_THRESHOLD - 1)
                        treeifyBin(tab, hash);
                    break;
                }
                //如果鏈表中有重複的key，e則爲當前重複的節點，結束循環
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        //有重複的key，則用待插入值進行覆蓋，返回舊值。
        if (e != null) {
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    //到了此步驟，則表明待插入的key-value是沒有key的重複，因爲插入成功e節點的值爲null
    //修改次數+1
    ++modCount;
    //實際長度+1，判斷是否大於臨界值，大於則擴容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    //添加成功
    return null;
}
	
//這裏的threshold是臨界值,跟進查看源碼
int threshold;

/**
 * The load factor for the hash table.
 *
 * @serial
 */
final float loadFactor;

//initialCapacity:初始容量   loadFactor:載荷因數
public HashMap(int initialCapacity, float loadFactor) {
	//當初始容量小於0,拋出IllegalArgumentException:違反內容異常
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " + initialCapacity);
	//initialCapacity:初始容量大於MAXIMUM_CAPACITY:最大容量,初始容量=最大容量
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
	//當載荷因數小於等於0或者Float.isNaN()爲false,拋出異常IllegalArgumentException
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
    this.loadFactor = loadFactor;
    this.threshold = tableSizeFor(initialCapacity);
    }
	
public static boolean isNaN(float v) {
    return (v != v);
}


static final int tableSizeFor(int cap) {
	//調用numberOfLeadingZeros()方法
    int n = -1 >>> Integer.numberOfLeadingZeros(cap - 1);
	//如果n值小於0,直接返回1,如果n值大於0,判斷n是否大於MAXIMUM_CAPACITY,如果大於返回MAXIMUM_CAPACITY,如果小於返回n+1
    return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
}

//根據這個方法我們假設i=1<<16/i=1<<8/i=1<<4/i=1<<2時,得出四個返回值:14/22/26/28	
public static int numberOfLeadingZeros(int i) {
    // HD, Count leading 0's
    if (i <= 0)
        return i == 0 ? 32 : 0;
    int n = 31;
    if (i >= 1 << 16) { n -= 16; i >>>= 16; }
    if (i >= 1 <<  8) { n -=  8; i >>>=  8; }
    if (i >= 1 <<  4) { n -=  4; i >>>=  4; }
    if (i >= 1 <<  2) { n -=  2; i >>>=  2; }
    return n - (i >>> 1);
}

由於很多方法裏面調用了其他方法,我只分析了一部分相關的內容.