hashMap源碼學習記錄

時間 2019-11-13

標籤 hashmap 源碼學習記錄简体版

原文原文鏈接

hashMap做爲java開發面試最常考的一個題目之一，有必要花時間去閱讀源碼，瞭解底層實現原理。html

首先，讓咱們看看hashMap這個類有哪些屬性java

  // hashMap初始數組容量
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16
    // 最大容量
    static final int MAXIMUM_CAPACITY = 1 << 30;

   // 裝載因子
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

   // 當某一桶下（key）的鏈表長度大於等於8時，該桶下的數據將由list結構轉成紅黑樹結構
    static final int TREEIFY_THRESHOLD = 8;
    
    // hashMap 中的數組結構
    transient Node<K,V>[] table;

   // 當某一桶下的紅黑樹節點數小於等於6時，將變回list
    static final int UNTREEIFY_THRESHOLD = 6;

    // hashmap 進行紅黑樹化的桶數量最小大小，就是說即便某一個桶中已達到8個，但並不必定會轉成紅黑樹，還要判斷桶數量是否達到64，若沒達到，但仍是有一些桶中元素達到8個及以上，說明碰撞較爲嚴重，進行擴容
    static final int MIN_TREEIFY_CAPACITY = 64;

    // 存放具體元素的集合
    transient Set<map.entry<k,v>> entrySet;
    // hashMap結構被修改的次數
    transient int modCount;
    // 臨界值 當實際大小超過臨界值時，hashMap會進行擴容
    int threshold

View Code

其次，來看看hashMap的構造方法node

 public HashMap(int initialCapacity, float loadFactor) {
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
　　　　　
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                                               loadFactor);
        this.loadFactor = loadFactor;
　　　　 // tableSizeFor()這個方法並無創建 table數組，只是返回了不小於initialCapacity 的最小2次冪數如initialCapacity=15，那麼返回16
        this.threshold = tableSizeFor(initialCapacity);
    }

    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

// 經過此構造方法，table將再也不爲空，具體緣由下面會說
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

tableForSize() 方法沒有將table初始化，只是返回了不小於initialCapacity 的最小2次冪數，看看他是怎麼作到的面試

static final int tableSizeFor(int cap) {
        int n = cap - 1;
        n |= n >>> 1;
        n |= n >>> 2;
        n |= n >>> 4;
        n |= n >>> 8;
        n |= n >>> 16;
        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
    }

第一步：將傳入的cap-1，這是由於當傳入的cap原本就是2的某次冪能夠那麼就不變數組

第二步：右移1位，而後進行或操做，這個操做把cap最左邊的1和左邊第二個1保留了下來，如cap=10，二進制表示位1010，右移1位得0101，進行或運算得1111，左邊兩位都爲1；app

第3、第4、第五步操做與第二步的原理同樣；ide

第五步就獲得了cap首個最左邊1後面全是1的一個數，如cap本來爲1001 -> 1111；函數

最後返回 n + 1 就是2的某冪次方。學習

經過使用傳入map的構造方法能將table初始化，那麼咱們就去看看 putMapEntries()這個方法this

 final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        int s = m.size();
        if (s > 0) {
            if (table == null) { // pre-size
                // 後面爲何還 +1.0F，應該是補轉整型時丟失的精度，如6.66666轉整型會變成6, 丟失了後面的那些小數
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            else if (s > threshold)
                resize();// 就是它，在table==null時會初始化table數組
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
                // putVal() 方法裏會有是否resize的判斷，在table==null，將會執行resize()方法
                putVal(hash(key), key, value, false, evict);
            }
        }
    }

上面提到 resize() 方法會初始化 table 數組，去源碼看看是怎麼回事

final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table;
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        int oldThr = threshold; 
        int newCap, newThr = 0;
        // 原table不爲null
        if (oldCap > 0) {
            // 容量大於最大值了，就設置爲最大值
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr; // 有舊擴容閾值賦值個新容量，這也是爲何在構造器傳入初始容量是賦值給擴容閾值的
        else {               // zero initial threshold signifies using defaults 設置爲默認初始容量16
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // 若是cap大小是構造函數傳入的，那麼oldCap == 0，oldThr > 0, 下面的if條件成立
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;
        @SuppressWarnings({"rawtypes","unchecked"})
            Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        
        // 本來table不爲null，進行resize操做
        if (oldTab != null) {
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null; // 本來地址賦值爲null，讓gc回收
                    if (e.next == null)  // 桶中只有一個元素，直接從新哈希而後經過與運算來求餘，這也是爲何容量必須設置爲2的冪數的緣由
                        newTab[e.hash & (newCap - 1)] = e;
                    else if (e instanceof TreeNode)  // 如是個紅黑樹節點，將對此node下的樹進行重排  
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { // preserve order
                        Node<K,V> loHead = null, loTail = null;
                        Node<K,V> hiHead = null, hiTail = null;
                        Node<K,V> next;
                       // 將此node下的同一鏈元素一分爲二
                        do {
                            next = e.next;
                            //與原容量進行與操做，等於0說明在該鏈下node的hash值映射的索引範圍是在oldCap內的，那麼保持索引不變
                            if ((e.hash & oldCap) == 0) { 
                                if (loTail == null)
                                    loHead = e;
                                else
                                    loTail.next = e;
                                loTail = e;
                            }
                            else { //映射範圍超過oldCap，由於 newCap 等於 2 * oldCap,那麼新的映射索引可方便計算爲 j+oldCap        
                                if (hiTail == null)
                                    hiHead = e;
                                else
                                    hiTail.next = e;
                                hiTail = e;
                            }
                        } while ((e = next) != null);
             
                        if (loTail != null) {
                            loTail.next = null;
                            newTab[j] = loHead; //放入新table,索引和以前同樣
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead; //放入新table,索引爲原索引+oldCap
                        }
                    }
                }
            }
        }
        return newTab;
    }

下面說說 hashMap 中較經常使用的 put 方法

 public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

// put()方法實際是使用該方法
// onlyIfAbsent if true, don't change existing value
// evict 應該是表示是否須要進行回調
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length; // 以前說到的在put的時候初始table
        if ((p = tab[i = (n - 1) & hash]) == null) // 沒有發生衝突，直接存入
            tab[i] = newNode(hash, key, value, null);
        else {
            Node<K,V> e; K k;
            // hashMap中已存在key對象，更新值便可        
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            else if (p instanceof TreeNode)
            // 該節點是個紅黑樹節點，插入紅黑樹
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                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;
                }
            }
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e); // 回調函數，hashMap中爲空實現，主要爲hashMap的子類linkedHashMap服務
                return oldValue;
            }
        }
    // 增長hashMap結構改變次數
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict); // 回調函數
        return null;
    }

下面將輪到 get() 方法了，去源碼一探究竟

    public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }
    // 比較容易理解，先在數組指針比較，一致則返回，不然去該數組指針下的紅黑樹或鏈表找
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            if (first.hash == hash && // always check first node
                ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
            if ((e = first.next) != null) {
                if (first instanceof TreeNode)
                    return ((TreeNode<K,V>)first).getTreeNode(hash, key);
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        return e;
                } while ((e = e.next) != null);
            }
        }
        return null;
    }

hashMap 中每一個元素都是以 Node 的形式的，讓咱們具體看看 Node 這個類

   static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;
        final K key;
        V value;
        Node<K,V> next;

        Node(int hash, K key, V value, Node<K,V> next) {
            this.hash = hash;
            this.key = key;
            this.value = value;
            this.next = next;
        }

        public final K getKey()        { return key; }
        public final V getValue()      { return value; }
        public final String toString() { return key + "=" + value; }

       // 由於重寫了equal方法，爲保持約束，hashCode也需重寫，能夠看到該類重寫的hashCode()方法是經過計算key和value這兩個對象哈希值後進行異或獲得的
        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }

        public final boolean equals(Object o) {
            if (o == this)
                return true;
            if (o instanceof Map.Entry) {
                Map.Entry<?,?> e = (Map.Entry<?,?>)o;
                if (Objects.equals(key, e.getKey()) &&
                    Objects.equals(value, e.getValue()))
                    return true;
            }
            return false;
        }
    }

可是，在進行 put 操做時，並非直接拿上面代碼中計算獲得的 hashCode，而是使用 hashMap 這個外部類的 hash() 方法

static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

能夠看到計算 哈希值 是把 高16位 和 低16位 進行了異或，這是爲了增大 哈希值 的隨機性，由於桶數組的長度爲2^n，取模運算(hash & (len-1))只取低位，故直接使用 key 的 hashcode() 做爲 hash 很容易發生碰撞。

hashMap源碼學習暫時到這裏，關於紅黑樹，以前有看過關於它的具體原理，如今也基本忘了，下次再去學習一下而後用博客記錄下來。

參考連接：

https://blog.csdn.net/qazwyc/article/details/76686915

https://www.cnblogs.com/xiaoxi/p/7233201.html

https://blog.csdn.net/kenzhang28/article/details/80212936