HashSet 新增/遍歷元素原始碼分析

趙妹兒發表於2022-07-08

HashSet 類圖

Hash類圖

HashSet 簡單說明

HashSet 實現了 Set 介面

HashSet 底層實際上是由 HashMap 實現的

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

可以存放 null，但是隻能有一個 null

HashSet 不保證元素是有序的(即不保證存放元素的順序和取出元素的順序一致)，取決於 hash 後，再確定索引的結果

不能有重複的元素

HashSet 底層機制說明

HashSet 底層是 HashMap，HashMap 底層是 陣列 + 連結串列 + 紅黑樹

模擬陣列+連結串列的結構

/**
 * 模擬 HashSet 陣列+連結串列的結構
 */
public class HashSetStructureMain {
    public static void main(String[] args) {
        // 模擬一個 HashSet(HashMap) 的底層結構
        // 1. 建立一個陣列，陣列的型別為 Node[]
        // 2. 有些地方直接把 Node[] 陣列稱為 表
        Node[] table = new Node[16];
        System.out.println(table);
        // 3. 建立節點
        Node john = new Node("john", null);
        table[2] = jhon; // 把節點 john 放在陣列索引為 2 的位置
        Node jack = new Node("jack", null);
        jhon.next = jack; // 將 jack 掛載到 jhon 的後面
        Node rose = new Node("rose", null);
        jack.next = rose; // 將 rose 掛載到 jack 的後面
        Node lucy = new Node("lucy", null);
        table[3] = lucy; // 將 lucy 放在陣列索引為 3 的位置
        System.out.println(table);

    }
}

// 節點類 儲存資料，可以指向下一個節點，從而形成連結串列
class Node{
    Object item; // 存放資料
    Node next; // 指向下一個節點
    public Node(Object item, Node next){
        this.item = item;
        this.next = next;
    }
}

HashSet 新增元素底層機制

HashSet 新增元素的底層實現

HashSet 底層是 HashMap

當新增一個元素時，會先得到 待新增元素的 hash 值，然後將其轉換成一個 索引值

查詢儲存資料表(Node 陣列) table，看當前 待新增元素 所對應的 索引值 的位置是否已經存放了 其它元素

如果當前 索引值 所對應的的位置不存在 其它元素，就將當前 待新增元素 放到這個 索引值 所對應的的位置

如果當前 索引值 所對應的位置存在 其它元素，就呼叫 待新增元素.equals(已存在元素) 比較，結果為 true，則放棄新增；結果為 false，則將 待新增元素 放到 已存在元素 的後面(已存在元素.next = 待新增元素)

HashSet 擴容機制

HashSet 的底層是 HashMap，第一次新增元素時，table 陣列擴容到 cap = 16，threshold(臨界值) = cap * loadFactor(載入因子 0.75) = 12

如果 table 陣列使用到了臨界值 12，就會擴容到 cap * 2 = 32，新的臨界值就是 32 * 0.75 = 24，以此類推

在 Java8 中，如果一條連結串列上的元素個數到達 TREEIFY_THRESHOLD(預設是 8)，並且 table 的大小 >= MIN_TREEIFY_CAPACITY(預設是 64)，就會進行 樹化(紅黑樹)

判斷是否擴容是根據 ++size > threshold，即是否擴容，是根據 HashMap 所存的元素個數(size)是否超過臨界值，而不是根據 table.length() 是否超過臨界值

HashSet 新增元素原始碼

/**
 * HashSet 原始碼分析
 */
public class HashSetSourceMain {
    public static void main(String[] args) {
        HashSet hashSet = new HashSet();
        hashSet.add("java");
        hashSet.add("php");
        hashSet.add("java");
        System.out.println("set = " + hashSet);

        // 原始碼分析
        // 1. 執行 HashSet()
        /**
         * public HashSet() { // HashSet 底層是 HashMap
         *         map = new HashMap<>();
         *     }
         */

        // 2. 執行 add()
        /**
         * public boolean add(E e) { // e == "java"
         *         // HashSet 的 add() 方法其實是呼叫 HashMap 的 put()方法
         *         return map.put(e, PRESENT)==null; // (static) PRESENT = new Object(); 用於佔位
         *     }
         */

        // 3. 執行 put()
        // hash(key) 得到 key(待存元素) 對應的hash值，並不等於 hashcode()
        // 演算法是 h = key.hashCode()) ^ (h >>> 16
        /**
         * public V put(K key, V value) {
         *         return putVal(hash(key), key, value, false, true);
         *     }
         */

        // 4. 執行 putVal()
        // 定義的輔助變數：Node<K,V>[] tab; Node<K,V> p; int n, i;
        // table 是 HashMap 的一個屬性，初始化為 null；transient Node<K,V>[] table;
        // resize() 方法，為 table 陣列指定容量
        // p = tab[i = (n - 1) & hash] 計算 key的hash值所對應的 table 中的索引位置，將索引位置對應的 Node 賦給 p
        /**
         * final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
         *                    boolean evict) {
         *         Node<K,V>[] tab; Node<K,V> p; int n, i; // 輔助變數
         *         // table 就是 HashMap 的一個屬性，型別是 Node[]
         *         // if 語句表示如果當前 table 是 null，或者 table.length == 0
         *         // 就是 table 第一次擴容，容量為 16
         *         if ((tab = table) == null || (n = tab.length) == 0)
         *             n = (tab = resize()).length;
         *         // 1. 根據 key，得到 hash 去計算key應該存放到 table 的哪個索引位置
         *         // 2. 並且把這個位置的索引值賦給 i；索引值對應的元素，賦給 p
         *         // 3. 判斷 p 是否為 null
         *         // 3.1 如果 p 為 null，表示還沒有存放過元素，就建立一個Node(key="java",value=PRESENT)，並把這個元素放到 i 的索引位置
         *         // tab[i] = newNode(hash, key, value, null);
         *         if ((p = tab[i = (n - 1) & hash]) == null)
         *             tab[i] = newNode(hash, key, value, null);
         *         else {
         *             Node<K,V> e; K k; // 輔助變數
         *             // 如果當前索引位置對應的連結串列的第一個元素和待新增的元素的 hash值一樣
         *             // 並且滿足下面兩個條件之一：
         *             // 1. 待新增的 key 與 p 所指向的 Node 節點的key 是同一個物件
         *             // 2. 待新增的 key.equals(p 指向的 Node 節點的 key) == true
         *             // 就認為當前待新增的元素是重複元素，新增失敗
         *             if (p.hash == hash &&
         *                 ((k = p.key) == key || (key != null && key.equals(k))))
         *                 e = p;
         *             // 判斷 當前 p 是不是一顆紅黑樹
         *             // 如果是一顆紅黑樹，就呼叫 putTreeVal，來進行新增
         *             else if (p instanceof TreeNode)
         *                 e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
         *             else {
         *                  // 如果 當前索引位置已經形成一個 連結串列，就使用 for 迴圈比較
         *                  // 將待新增元素依次和連結串列上的每個元素進行比較
         *                  // 1. 比較過程中如果出現待新增元素和連結串列中的元素有相同的，比較結束，出現重複元素，新增失敗
         *                  // 2. 如果比較到連結串列最後一個元素，連結串列中都沒出現與待新增元素相同的，就把當前待新增元素放到該連結串列最後的位置
         *                  // 注意：在把待新增元素新增到連結串列後，立即判斷 該連結串列是否已經到達 8 個節點
         *                  // 如果到達，就呼叫 treeifyBin() 對當前這個連結串列進行數化(轉成紅黑樹)
         *                  // 注意：在轉成紅黑樹前，還要進行判斷
         *                  // if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
         *                  //        resize();
         *                  // 如果上面條件成立，先對 table 進行擴容
         *                  // 如果上面條件不成立，才轉成紅黑樹
         *                 for (int binCount = 0; ; ++binCount) {
         *                     if ((e = p.next) == null) {
         *                         p.next = newNode(hash, key, value, null);
         *                         if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
         *                             treeifyBin(tab, hash);
         *                         break;
         *                     }
         *                     if (e.hash == hash &&
         *                         ((k = e.key) == key || (key != null && key.equals(k))))
         *                         break;
         *                     p = e;
         *                 }
         *             }
         *             // e 不為 null ，說明新增失敗
         *             if (e != null) { // existing mapping for key
         *                 V oldValue = e.value;
         *                 if (!onlyIfAbsent || oldValue == null)
         *                     e.value = value;
         *                 afterNodeAccess(e);
         *                 return oldValue;
         *             }
         *         }
         *         ++modCount;
         *         // 擴容：說明判斷 table 是否擴容不是看 table 的length
         *         // 而是看 整個 HashMap 的 size(即已存元素個數)
         *         if (++size > threshold)
         *             resize();
         *         afterNodeInsertion(evict);
         *         return null;
         *     }
         */
    }
}

HashSet 遍歷元素底層機制

HashSet 的底層是 HashMap，HashSet 的迭代器也是藉由 HashMap 來實現的
HashSet.iterator() 實際上是去呼叫 HashMap 的 KeySet().iterator()

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

KeySet() 方法返回一個 KeySet 物件，而 KeySet 是 HashMap 的一個內部類

public Set<K> keySet() {
    Set<K> ks = keySet;
    if (ks == null) {
        ks = new KeySet();
        keySet = ks;
    }
    return ks;
}

KeySet().iterator() 方法返回一個 KeyIterator 物件，KeyIterator 是 HashMap 的一個內部類

public final Iterator<K> iterator()     { return new KeyIterator(); }

KeyIterator 繼承了 HashIterator(HashMap的內部類) 類，並實現了 Iterator 介面，即 KeyIterator、HashIterator 才是真正實現 迭代器 的類

final class KeyIterator extends HashIterator
    implements Iterator<K> {
    public final K next() { return nextNode().key; }
}

當執行完 Iterator iterator = HashSet.iterator; 之後，此時的 iterator 物件中已經儲存了一個元素節點
1. 怎麼做到的？
2. 回到第 4 步，KeySet().iterator() 方法返回一個 KeyIterator 物件
3. new KeyIterator() 呼叫 KeyIterator 的無參構造器
4. 在這之前，會先呼叫其父類 HashIterator 的無參構造器
5. 因此，分析 HashIterator 的無參構造器就知道發生了什麼
```
/**
*         Node<K,V> next;        // next entry to return
*         Node<K,V> current;     // current entry
*         int expectedModCount;  // for fast-fail
*         int index;             // current slot
* HashIterator() {
*             expectedModCount = modCount;
*             Node<K,V>[] t = table;
*             current = next = null;
*             index = 0;
*             if (t != null && size > 0) { // advance to first entry
*                 do {} while (index < t.length && (next = t[index++]) == null);
*             }
*         }
*/
```
6. next、current、index 都是 HashIterator 的屬性
7. Node<K,V>[] t = table; 先把 Node 陣列 talbe 賦給 t
8. current = next = null; current、next 都置為 null
9. index = 0; index 置為 0
10. do {} while (index < t.length && (next = t[index++]) == null); 這個 do-while 會在 table 中遍歷 Node 結點
11. 一旦 (next = t[index++]) == null 不成立 時，就說明找到了一個 table 中的 Node 結點
12. 將這個節點賦給 next，並退出當前 do-while 迴圈
13. 此時 Iterator iterator = HashSet.iterator; 就執行完了
14. 當前 iterator 的執行型別其實是 HashIterator，而 HashIterator 的 next 中儲存著從 table 中遍歷出來的一個 Node 結點
執行 iterator.hasNext
1. 此時的 next 儲存著一個 Node，所以並不為 null，返回 true
```
public final boolean hasNext() {
    return next != null;
}
```
執行 iterator.next()
1. Node<K,V> e = next; 把當前儲存著 Node 結點的 next 賦值給了 e
2. (next = (current = e).next) == null 判斷當前結點的下一個結點是否為 null
  1. (a). 如果當前結點的下一個結點為 null，就執行 do {} while (index < t.length && (next = t[index++]) == null);，在 table 陣列中遍歷，尋找 table 陣列中的下一個 Node 並賦值給 next
  2. (b). 如果當前結點的下一個結點不為 null，就將當前結點的下一個結點賦值給 next，並且此刻不會去 table 陣列中遍歷下一個 Node 結點
3. 將找到的結點 e 返回
4. 之後每次執行 iterator.next() 都像 (a)、(b) 那樣去判斷遍歷，直到遍歷完成

HashSet 遍歷元素原始碼

/**
 * HashSet 原始碼分析
 */
public class HashSetSourceMain {
    public static void main(String[] args) {
        HashSet hashSet = new HashSet();
        hashSet.add("java");
        hashSet.add("php");
        hashSet.add("java");
        System.out.println("set = " + hashSet);
        // HashSet 迭代器實現原理
        // HashSet 底層是 HashMap，HashMap 底層是 陣列 + 連結串列 + 紅黑樹
        // HashSet 本身沒有實現迭代器，而是藉由 HashMap 來實現的
        // 1. hashSet.iterator() 實際上是去呼叫 HashMap 的 keySet().iterator()
        /**
         * public Iterator<E> iterator() {
         *         return map.keySet().iterator();
         *     }
         */
        // 2. KeySet() 方法返回一個 KeySet 物件，而 KeySet 是 HashMap 的一個內部類
        /**
         * public Set<K> keySet() {
         *         Set<K> ks = keySet;
         *         if (ks == null) {
         *             ks = new KeySet();
         *             keySet = ks;
         *         }
         *         return ks;
         *     }
         */
        // 3. KeySet().iterator() 方法返回一個 KeyIterator 物件，KeyIterator 是 HashMap的一個內部類
        /**
         * public final Iterator<K> iterator()     { return new KeyIterator(); }
         */
        // 4. KeyIterator 繼承了 HashIterator(HashMap的內部類) 類，並實現了 Iterator 介面
        // 即 KeyIterator、HashIterator 才是真正實現 迭代器的類
        /**
         * final class KeyIterator extends HashIterator
         *         implements Iterator<K> {
         *         public final K next() { return nextNode().key; }
         *     }
         */
        // 5. 當執行完 Iterator iterator = hashSet.iterator(); 後
        // 此時的 iterator 物件中已經儲存了一個元素節點
        // 怎麼做到的？
        // 回到第 3 步，KeySet().iterator() 方法返回一個 KeyIterator 物件
        // new KeyIterator() 呼叫 KeyIterator 的無參構造器
        // 在這之前，會先呼叫 KeyIterator 父類 HashIterator 的無參構造器
        // 因此分析 HashIterator 的無參構造器就知道發生了什麼
        /**
         *         Node<K,V> next;        // next entry to return
         *         Node<K,V> current;     // current entry
         *         int expectedModCount;  // for fast-fail
         *         int index;             // current slot
         * HashIterator() {
         *             expectedModCount = modCount;
         *             Node<K,V>[] t = table;
         *             current = next = null;
         *             index = 0;
         *             if (t != null && size > 0) { // advance to first entry
         *                 do {} while (index < t.length && (next = t[index++]) == null);
         *             }
         *         }
         */
        // 5.0 next, current, index 都是 HashIterator 的屬性
        // 5.1 Node<K,V>[] t = table; 先把 Node 陣列 table 賦給 t
        // 5.2 current = next = null; 把 current 和 next 都置為 null
        // 5.3 index = 0; index 置為 0
        // 5.4 do {} while (index < t.length && (next = t[index++]) == null);
        // 這個 do{} while 迴圈會在 table 中 遍歷 Node節點
        // 一旦 (next = t[index++]) == null 不成立時，就說明找到了一個 table 中的節點
        // 將這個節點賦給 next，並退出當前 do while迴圈
        // 此時 Iterator iterator = hashSet.iterator(); 就執行完了
        // 當前 iterator 的執行型別其實是 HashIterator，而 HashIterator 的 next 中儲存著從 table 中遍歷出來的一個 Node節點
        // 6. 執行 iterator.hasNext()
        /**
         * public final boolean hasNext() {
         *             return next != null;
         *         }
         */
        // 6.1 此時的 next 儲存著一個 Node，所以並不為 null，返回 true
        // 7. 執行 iterator.next()，其實是去執行 HashIterator 的 nextNode()
        /**
         * final Node<K,V> nextNode() {
         *             Node<K,V>[] t;
         *             Node<K,V> e = next;
         *             if (modCount != expectedModCount)
         *                 throw new ConcurrentModificationException();
         *             if (e == null)
         *                 throw new NoSuchElementException();
         *             if ((next = (current = e).next) == null && (t = table) != null) {
         *                 do {} while (index < t.length && (next = t[index++]) == null);
         *             }
         *             return e;
         *         }
         */
        // 7.1 Node<K,V> e = next; 把當前儲存著 Node 節點的 next 賦值給了 e
        // 7.2 (next = (current = e).next) == null
        // 判斷當前節點的下一個節點是否為 null
        // a. 如果當前節點的下一個節點為 null
        // 就執行 do {} while (index < t.length && (next = t[index++]) == null);
        // 再 table 陣列中 遍歷，尋找 table 陣列中的下一個 Node 並賦值給 next
        // b. 如果當前節點的下一個節點不為 null
        // 就將當前節點的下一個節點賦值給 next，並且此刻不會去 table 陣列中遍歷下一個 Node 節點
        // 7.3 將找到的節點 e 返回
        // 7.4 之後每次執行 iterator.next()，都像 a、b 那樣去判斷遍歷，直到遍歷完成
        Iterator iterator = hashSet.iterator();
        while (iterator.hasNext()) {
            Object next =  iterator.next();
            System.out.println(next);
        }
    }
}

vector容器1（新增元素，遍歷元素）
2015-10-12
HashSet原始碼分析
2019-05-02
原始碼
jQuery 元素操作——遍歷元素
2020-11-29
jQuery
原始碼分析–HashSet（JDK1.8）
2019-01-21
原始碼JDK
Java集合原始碼分析（九）——HashSet
2020-12-09
Java原始碼
DOM元素的遍歷
2019-04-14
Jquery之遍歷元素
2020-10-23
jQuery
Java容器類框架分析(5)HashSet原始碼分析
2019-03-04
Java框架原始碼
javascript遍歷陣列元素程式碼例項
2017-03-27
JavaScript陣列
HashSet原始碼解析
2016-11-04
原始碼
jQuery遍歷array陣列元素程式碼例項
2018-07-07
jQuery陣列
LinkedList 新增元素原始碼解析
2021-09-14
原始碼
集合框架-HashSet儲存字串、自定義物件並遍歷
2017-04-26
框架字串物件
遍歷List 同時 remove 元素
2013-08-24
REM
Java類集框架 —— HashSet、LinkedHashSet原始碼分析
2019-03-04
Java框架原始碼
java基礎：HashSet/LinkedHashSet/TreeSet — 原始碼分析
2019-01-04
Java原始碼
【筆記】jQuery原始碼（節點遍歷）
2018-03-25
筆記jQuery原始碼
關於二叉樹的前序遍歷、中序遍歷、刪除元素、插入元素
2017-03-10
二叉樹
Java原始碼系列 -- HashSet
2018-02-06
Java原始碼
HashSet原始碼詳解
2016-11-29
原始碼
jquery遍歷子元素的寫法
2016-10-27
jQuery
PHP 遍歷元素並分批處理
2017-11-06
PHP
Java面試題從原始碼角度分析HashSet實現原理？
2019-07-25
Java面試題原始碼
【集合框架】JDK1.8原始碼分析HashSet && LinkedHashSet（八）
2016-03-23
框架JDK原始碼
java陣列如何遍歷全部的元素
2021-09-11
Java陣列
JavaScript遍歷陣列每一個元素
2018-07-16
JavaScript陣列
for in語句遍歷陣列中的元素
2017-03-31
陣列
javascript使用for in語句遍歷陣列元素
2017-03-24
JavaScript陣列
js如何遍歷陣列中的元素
2017-03-20
JS陣列
C++11::遍歷tuple中的元素
2015-11-16
C++
二叉樹的遍歷演算法【和森林的遍歷】【PHP 原始碼測試】
2019-07-04
二叉樹演算法PHP原始碼
HashMap原始碼：聊聊Map的遍歷效能問題（一）
2021-06-08
HashMap原始碼
puppeteer 頁面爬取例項（元素遍歷）
2018-12-07
利用jQuery如何遍歷指定的li元素集合
2017-03-16
jQuery
Python字典的遍歷,包括key遍歷/value遍歷/item遍歷/
2020-12-07
Python
HashSet 如何保證元素不重複——hash碼
2021-11-24
站在巨人肩膀上看原始碼-HashSet
2019-01-19
原始碼
Java集合原始碼學習（4）HashSet
2018-10-23
Java原始碼

HashSet 新增/遍歷元素原始碼分析

HashSet 類圖

HashSet 簡單說明

HashSet 底層機制說明

模擬陣列+連結串列的結構

HashSet 新增元素底層機制

HashSet 新增元素的底層實現

HashSet 擴容機制

HashSet 新增元素原始碼

HashSet 遍歷元素底層機制

HashSet 遍歷元素底層機制

HashSet 遍歷元素原始碼

相關文章