Java类集框架 —— HashMap源码分析

HashMap是基于Map的键值对映射表，底层是通过数组、链表、红黑树（JDK1.8加入）来实现的。

HashMap结构

HashMap中存储元素，是将key和value封装成了一个Node，先以一个Node数组的来存储，通过key的hashCode来计算hash值，根据hash值和HashMap的大小确定存入元素在数组中的位置。当hashCode相同时，即产生了相同的数组索引位置，那么就会通过单向链表的形式来继续存储。

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

    // 省略部分代码...        

}

HashMap中所有的映射都保存在节点Node中，同时为了解决发生hash碰撞的冲突，节点可以持有下一个节点的引用，以形成一个单向链表。

在JDK1.8，HashMap又做了一些改动，当数组table某个索引位置的上链表的长度大于8的话，则会将链表转化为红黑树。

static final class TreeNode<K,V> extends LinkedHashMap.Entry<K,V> {
    TreeNode<K,V> parent;  // red-black tree links
    TreeNode<K,V> left;
    TreeNode<K,V> right;
    TreeNode<K,V> prev;    // needed to unlink next upon deletion
    boolean red;

    TreeNode(int hash, K key, V val, Node<K,V> next) {
        super(hash, key, val, next);
    }

    // 省略部分代码...        

}

同样地，映射的key-value就保存在TreeNode中。parent、left、right持有相应节点的引用形成红黑树。

HashMap源码分析

主要属性：

transient Node<K,V>[] table; // 数组
transient int size;          // 大小
int threshold                 // 扩容阈值
final float loadFactor;      // 加载因子，默认值为0.75

构造方法：

// 使用默认的初始容量和加载因子
public HashMap() {
    this(DEFAULT_INITIAL_CAPACITY, DEFAULT_LOAD_FACTOR);
}

// 指定初始容量，使用默认的加载因子
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

// 用现有的Map来构造一个新的HashMap
public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}

// 根据自定义的初始容量和加载因子来构造HashMap
public HashMap(int initialCapacity, float loadFactor) {
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    if (initialCapacity > MAXIMUM_CAPACITY) {
        initialCapacity = MAXIMUM_CAPACITY;
    } else if (initialCapacity < DEFAULT_INITIAL_CAPACITY) {
        initialCapacity = DEFAULT_INITIAL_CAPACITY;
    }

    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                           loadFactor);
    threshold = initialCapacity;
    init();
}

构造函数主要是设置HashMap的初始容量，以及扩容的加载因子。HashMap(Map<? extends K, ? extends V> m)构造函数根据已有的映射来构造新的HashMap，它同样采用的默认的加载因子，并将m中的元素添加到新构造的HashMap中。

数据存放：

public void putAll(Map<? extends K, ? extends V> m) {
    putMapEntries(m, true);
}

final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
    int s = m.size();
    if (s > 0) {
        if (table == null) { // pre-size
            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();
        for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
            K key = e.getKey();
            V value = e.getValue();
            putVal(hash(key), key, value, false, evict);
        }
    }
}

putAll方法直接调用putMapEntries。putMapEntries方法中先根据已有的Map中的元素数量对新构造的HashMap进行扩容，然后遍历旧的Map，取出元素存放到新的HashMap中。

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

// 根据key的hashCode来计算hash值
static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

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为null的话，进行初始化
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    // 根据（n-1）&hash来计算出元素在数组中的位置i
    if ((p = tab[i = (n - 1) & hash]) == null)
        // 如果数组中该位置没有元素，即tab[i]==null,则直接构建Node存放在该位置
        tab[i] = newNode(hash, key, value, null);
    else { // tab[i]不为null
        Node<K,V> e; K k;
        // 如果数组中已有的节点tab[i]与需要新存入的元素的key相同，则直接替换掉tab[i]
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        else if (p instanceof TreeNode)
            // 如果tab[i]为红黑树节点，则直接存入红黑树
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            // tab[i]为链表的第一个节点，遍历链表，将新的节点加入到链表的末尾
            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;
                }
                // 如果链表中存在与新加入的元素key相同，则直接替换掉
                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);
            return oldValue;
        }
    }
    ++modCount;
    // 添加完成后，检查是否需要扩容
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

put方法的主要逻辑：根据添加节点的hash值计算计算它在数组中的位置i，判断tab[i]是否为空，为空则直接加入；不为空的话，需要判断该节点的key是否与新加入的节点的key相同，相同的话直接替换；如果不同则需要判断tab[i]节点是否是红黑树节点，如果是红黑树节点，则直接加入到红黑树中；如果不是红黑树节点，那肯定就是链表的第一个节点了，遍历链表，在遍历的过程中还需要判断是否与链表中已有节点的key相同，如果相同，同样直接替换掉，都不同的话就直接添加到链表的末尾。并且呢，加入链表后还需要判断链表的长度是否超过了阈值8，超过了的话，需要将链表转换为红黑树。

HashMap在添加数据的时候，会判断当前数据量是否超过设定的阈值，如果超过的话会进行扩容，在扩容过程中会将已添加的数据进行重新添加，以致原来添加元素的顺序和位置都改变了，所以HashMap不能保证元素的存入取出顺序。

删除数据：

// 根据key删除数据
public V remove(Object key) {
    Node<K,V> e;
    return (e = removeNode(hash(key), key, null, false, true)) == null ?
        null : e.value;
}

// 根据key-value删除数据
@Override
public boolean remove(Object key, Object 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) {
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    // 根据hash值得到数组索引位置的节点p
    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;
        // p节点的key与需要删除的节点的key相同的话，则说明p就是需要删除的节点
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;    // 赋值给node
        else if ((e = p.next) != null) {
            if (p instanceof TreeNode)
                // p节点为红黑树节点，从红黑树中获取匹配的删除节点
                node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
            else {
                // p节点为链表的第一个节点，遍历链表，找到匹配的删除节点
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key ||
                         (key != null && key.equals(k)))) {
                        node = e;
                        break;
                    }
                    p = e;
                } while ((e = e.next) != null);
            }
        }
        // 匹配的删除节点node不为null的话，删除node
        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;
        }
    }
    return null;
}

remove的逻辑和加入元素的逻辑相似，依次从数组、红黑树、链表中找到匹配的删除节点来删除。

clear方法：

public void clear() {
    Node<K,V>[] tab;
    modCount++;
    if ((tab = table) != null && size > 0) {
        size = 0;
        for (int i = 0; i < tab.length; ++i)
            tab[i] = null;
    }
}

clear方法要简单些，直接遍历数组tab，将数组中所有元素都置空即可。

最后

对于HashMap，我们只要知道了它的底层结构，要理解它的实现原理还是非常简单。在JDK1.8之后，加入了红黑树的结构，使HashMap的效率比之前的版本又优化了很多，关于链表转化为红黑树，以及红黑树转链表的具体实现等细节后续再做分析。