Java中HashMap源码分析

HashMap的结构

HashMap是由数组，链表，红黑树组成的。

HashMap会把Key进过计算（**hash & (length - 1)**）得到一个索引，再按照索引值存入哈希表中。

如果有两个Key值计算出来的索引一致(哈希冲突)，则会形成一个链表。

如果链表长度大于8，这是查询效率会变慢，链表就会转化为红黑树，提升查询效率。

数组的默认容量为16，如果整个HashMap存放的节点数大于某个值，这时候HashMap已经链化严重，查询效率低，对HashMap进行扩容（容量翻倍）能缓解hash冲突，链化严重。

成员变量

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;

static final int TREEIFY_THRESHOLD = 8;

static final int UNTREEIFY_THRESHOLD = 6;

static final int MIN_TREEIFY_CAPACITY = 64;

transient Node<K,V>[] table;

transient Set<Map.Entry<K,V>> entrySet;

transient int size;

transient int modCount;

int threshold;

final float loadFactor;

• DEFAULT_INITIAL_CAPACITY：初始化容量大小，2^4=16
• MAXIMUM_CAPACITY：最大容量，2^30
• DEFAULT_LOAD_FACTOR：负载因子，容量到达多少时进行扩容
• TREEIFY_THRESHOLD：链表变成红黑树的阈值
• UNTREEIFY_THRESHOLD：红黑树变成链表的阈值
• MIN_TREEIFY_CAPACITY：链表变成红黑树的阈值
• table：存放map的KV值的数组
• size：map中KV的数量
• loadFactor：负载因子

内部类

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; }

    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;
    }
}

Node用来存放KV值，同时它还包含了下一个Node，可以形成一个单向链表。

构造方法

public HashMap(int initialCapacity, float loadFactor) {
    // 初始化容量必须大于或等于0
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    // 初始化容量不能大于最大容量
    if (initialCapacity > MAXIMUM_CAPACITY)
        initialCapacity = MAXIMUM_CAPACITY;
    // 负载因子大于0，而且必须为数字
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                           loadFactor);
    this.loadFactor = loadFactor;
    // tableSizeFor()方法可以返回一个大于输入参数，并且为2的次方的数
    this.threshold = tableSizeFor(initialCapacity);
}

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

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

public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

HashMap除了初始化为一个空HashMap对象，还可以指定初始容量，负载因子；还可以用一个Map的子类做为参数初始化。

put(K key, V value)

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

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放值，调用resize()方法
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // (n - 1) & hash得到索引，如果数组索引处没有值，就放在里面
    if ((p = tab[i = (n - 1) & hash]) == null)
        // 在索引处放一个Node对象，且next=null
        tab[i] = newNode(hash, key, value, null);
    else { //索引处有值
        Node<K,V> e; K k;
        // 如果待存数据和数组中的数据，hash值和key值都相同
        // e = p，进入37行if语句块中的语句
        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);
        // 如果待存数据和数组中的数据，hash值和key值不同
        // 遍历链表
        else {
            for (int binCount = 0; ; ++binCount) {
                // 如果到链表尾部都没找到hash值和key值相同的
                // 就放入链表末尾
                if ((e = p.next) == null) {
                    p.next = newNode(hash, key, value, null);
                    // 如果链表长度大于TREEIFY_THRESHOLD，调用treeifyBin()方法
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        treeifyBin(tab, hash);
                    break;
                }
                // 如果在链表找到hash值和key值相同的
                // 对value进行替换
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        // 如果待存数据和数组中的数据，hash值和key值都相同
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                // 替换value的值
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

转化为流程图

resize()

final Node<K,V>[] resize() {
    // 原数组
    Node<K,V>[] oldTab = table;
    // 原数组容量
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    // 原数组扩容阈值
    int oldThr = threshold;
    // 新数组容量，下一次扩容阈值
    int newCap, newThr = 0;
    
    // 计算新数组容量，下一次扩容阈值
    
    // 数组已经初始化过了
    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
    }
    // 数组没有初始化，但是阈值已经指定
    // 大家可以自行看HashMap的构造方法，看看这种情况什么时候会发生
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    // 数组没有初始化过
    else {               // zero initial threshold signifies using defaults
        // 设定为初始值
        newCap = DEFAULT_INITIAL_CAPACITY; // 16
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY); // 0.75 * 16 = 12
    }
    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;
    // 如果oldTab == null表示还没有存放任何数据，直接返回
    // oldTab != null表示原来的HashMap有数据
    if (oldTab != null) {
        // 遍历数组
        for (int j = 0; j < oldCap; ++j) {
            Node<K,V> e;
            // 如果数组下标处有值
            if ((e = oldTab[j]) != null) {
                oldTab[j] = null;
                // 单个值，没有形成树或者链表
                if (e.next == null)
                    // 计算该值在新数组的下标
                    newTab[e.hash & (newCap - 1)] = e;
                // 如果节点已经形成红黑树
                else if (e instanceof TreeNode)
                    ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                // 节点已经形成链表
                else { // preserve order
                    // 把一个链表拆成两个链表
                    // 通过e.hash & oldCap计算新数组下标
                    // 这样同一个链表的数据可能计算出两个下标
                    // 根据计算出来的下标存储，就能把原来的一个链表，拆成两个链表
                    Node<K,V> loHead = null, loTail = null;
                    Node<K,V> hiHead = null, hiTail = null;
                    Node<K,V> next;
                    // 链表存储代码
                    do {
                        next = e.next;
                        if ((e.hash & oldCap) == 0) {
                            if (loTail == null)
                                loHead = e;
                            else
                                loTail.next = e;
                            loTail = e;
                        }
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    if (loTail != null) {
                        loTail.next = null;// GC
                        newTab[j] = loHead;
                    }
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

get() & remove()

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) {
    // tab：HashMap中的数组
    // first：通过哈希值定位数组中的头节点
    // n：数组长度
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    // 判断数据是否存在，数组不能为null，数组长度大于0，头节点不为null
    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;
}

public V remove(Object key) {
    // 只匹配key
    Node<K,V> e;
    return (e = removeNode(hash(key), key, null, false, true)) == null ?
        null : e.value;
}

@Override
public boolean remove(Object key, Object value) {
    // 匹配key和value
    return removeNode(hash(key), key, value, true, true) != null;
}

final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    // tab：HashMap中的数组
    // p：通过哈希值定位数组中的头节点
    // n：数组长度
    // index：头节点下标
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    // 判断数据是否存在，数组不能为null，数组长度大于0，头节点不为null
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (p = tab[index = (n - 1) & hash]) != null) {
        Node<K,V> node = null, e; K k; V v;
        // 如果头节点的哈希值和key值都匹配
        // node = p
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;
        // 如果该节点已经变为链表或者树
        else if ((e = p.next) != null) {
            // 如果该节点已经是红黑树
            if (p instanceof TreeNode)
                // 红黑树查找
                node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
            // 不是树，遍历链表查找
            // 如果找到node = e
            else {
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key ||
                         (key != null && key.equals(k)))) {
                        node = e;
                        break;
                    }
                    p = e;
                } while ((e = e.next) != null);
            }
        }
        // 如果找到了key
        // 判断一下value是否一致，通过matchValue判断是否需要判断value
        if (node != null && (!matchValue || (v = node.value) == value ||
                             (value != null && value.equals(v)))) {
            // 树删除操作
            if (node instanceof TreeNode)
                ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
            // 头节点删除操作
            else if (node == p)
                tab[index] = node.next;
            // 中间节点删除操作
            else
                p.next = node.next;
            ++modCount;
            --size;
            afterNodeRemoval(node);
            return node;
        }
    }
    // 没找到，返回null
    return null;
}

replace()

@Override
public boolean replace(K key, V oldValue, V newValue) {
    // 匹配key和value
    Node<K,V> e; V v;
    // 通过哈希值找到节点，再进行匹配
    if ((e = getNode(hash(key), key)) != null &&
        ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
        // value替换
        e.value = newValue;
        afterNodeAccess(e);
        return true;
    }
    return false;
}

@Override
public V replace(K key, V value) {
    // 只匹配key
    Node<K,V> e;
    // 通过哈希值找到节点，再进行匹配
    if ((e = getNode(hash(key), key)) != null) {
        V oldValue = e.value;
        // value替换
        e.value = value;
        afterNodeAccess(e);
        return oldValue;
    }
    return null;
}

总结

• 如果先了解HashMap的结构，知道数据存储方式后，再来看源码会容易很多。
• HashMap扩容十分消耗性能，如果我们能大概估计我们需要的大小，应该在初始化时就定义。
• 如果不知道寻址按位与运算是怎么进行的，可以参考其他人的博客，写得很清楚。
• 链表变成红黑树其实有两个条件

从下面代码可以看出，在数组长度大于MIN_TREEIFY_CAPACITY(64)时才构建树，否则进行扩容。

final void treeifyBin(Node<K,V>[] tab, int hash) {
    int n, index; Node<K,V> e;
    if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
        resize();
    else if ((e = tab[index = (n - 1) & hash]) != null) {
        TreeNode<K,V> hd = null, tl = null;
        do {
            TreeNode<K,V> p = replacementTreeNode(e, null);
            if (tl == null)
                hd = p;
            else {
                p.prev = tl;
                tl.next = p;
            }
            tl = p;
        } while ((e = e.next) != null);
        if ((tab[index] = hd) != null)
            hd.treeify(tab);
    }
}

总结一下HashMap什么时候会扩容：

• 第一次放入元素
• 放入元素后，HashMap中元素个数大于扩容阈值
• 有某一条链表长度大于8，且数组容量小于64