hashmap.md

Java HashMap 简介

HashMap是 Java 实现的哈希表数据容器，存放键值对，最常用的 Java 集合容器实现类之一。HashMap并不是线程安全的集合容器。

HashMap 继承体系

图：HashMap 继承关系图

HashMap 数据结构

图：HashMap 底层数据结构 - 示意图

在 Java 8 之前，HashMap 底层数据结构为：「数组」+「链表」。

在 Java 8 以后，HashMap 底层数据结构为：「数组」+「链表」+「红黑树」。

图：HashMap 数据结构 - Java 7

图：HashMap 数据结构 - Java 8

HashMap 源码剖析

从 JDK 源码角度深入分析 HashMap 实现。

HashMap 数据字段

看看 HashMap 类中的重要数据结构字段，包括：

• 哈希桶数组

• Node链表节点

• TreeNode红黑树节点

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable {

    /* 序列化号 */
    private static final long serialVersionUID = 362498820763181265L;

    /* 哈希表默认初始容量: 16 */
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4;

    /* 哈希表最大容量: 2^30 */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /* 默认负载因子: 0.75 */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    /* 当哈希桶（Bucket）节点数大于该值时：[链表]转[红黑树] */
    static final int TREEIFY_THRESHOLD = 8;

    /* 当哈希桶（Bucket）节点数小于该值时：[红黑树]转[链表] */
    static final int UNTREEIFY_THRESHOLD = 6;

    /* 哈希桶中节点结构转化为[红黑树]时对应表的最小容量 */
    static final int MIN_TREEIFY_CAPACITY = 64;

    /* 存储元素的数组，元素数量总为2的幂次 */
    transient Node<K,V>[] table;

    /* 存放具体元素的集合 */
    transient Set<Map.Entry<K,V>> entrySet;

    /* 哈希表已存放元素数量（不等于数组长度） */
    transient int size;

    /* 扩容或更改哈希结构时的计数器 */
    transient int modCount;

    /* 临界值: 当实际大小（容量 * 负载因子）超过临界值时，触发扩容 */
    int threshold;

    /* 负载因子 */
    final float loadFactor;
}

代码清单：HashMap 数据字段

/**
 * 基础 Node 链表节点数据结构，
 * 静态内部类，实现 Map.Entry<K,V> 接口
 */
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节点类源码

/**
 * 红黑树节点数据结构，继承自 LinkedHashMap.Entry<K,V>
 */
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);
    }
    /**
     * 返回红黑树根节点
     */
    final TreeNode<K,V> root() {
        for (TreeNode<K,V> r = this, p;;) {
            if ((p = r.parent) == null) {
                return r;
            }
            r = p;
        }
    }
    /* 红黑树具体实现... */
}

代码清单：TreeNode红黑树节点类源码

构造函数

Java HashMap 允许 4 种形式的构造函数：

• 无参默认构造

• 指定容量大小构造

• 指定容量大小与负载因子构造

• 以另一Map构造

/* 默认构造函数 */
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
}
/* 以另一个 Map 构造 */
public HashMap(Map<? extends K, ? extends V> m) {
    this.loadFactor = DEFAULT_LOAD_FACTOR;
    putMapEntries(m, false);
}
/* 指定[容量大小]构造 */
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}
/* 指定[容量大小]和[负载因子]构造 */
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;
    this.threshold = tableSizeFor(initialCapacity);
}

代码清单：HashMap 构造函数

HashMap 哈希计算

HashMap 中键哈希值计算使用了哈希扰动函数hash()，具体计算方法：取对象哈希码hashCode()，右移16位，再做一次异或XOR操作。

图：HashMap 哈希计算方法

/**
 * 哈希扰动函数
 * key.hashCode()：返回对象哈希值（hashCode）
 * ^             ：按位异或
 * >>>           ：无符号右移，忽略符号位，空位以 0 补齐
 */
static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

代码清单：hash()哈希扰动函数

HashMap 获取方法

HashMapget()方法根据哈希键获取哈希值。如果哈希表中存在键值对则返回目标值，不存在则返回空值null。

方法执行流程：

1. 调用hash()函数计算传入键的哈希值hash；

2. 根据键哈希值计算该键位于哈希桶数组的索引下标，计算方法：hash % n，当数组长度为2的幂次时，表达式等价于(n - 1) & hash；

3. 根据索引下标定位至哈希桶数组，先检查头节点，键匹配成功则直接返回头节点，匹配方式：first.hash == hash && key.equals(e.key)；

4. 如果发现哈希冲突（头节点存在后继节点），判断节点链类型，为红黑树则使用红黑树方法查找目标节点，为链表则遍历链表查找目标节点，找到后返回匹配的节点元素；

5. 头节点为空或节点链找不到目标键，说明当前哈希表中不存在该键值对，返回空值null。

/**
 * 根据键获取值
 */
public V get(Object key) {
    Node<K,V> e;
    return (e = getNode(hash(key), key)) == null ? null : e.value;
}
/**
 * Map.get() 方法实现
 *
 * @param hash 键哈希值
 * @param key 键
 * @return 目标节点，无匹配则返回空
 */
final Node<K,V> getNode(int hash, Object key) {
    /**
     * 准备临时变量
     * tab  : 哈希桶数组
     * n    : 数组长度
     * first: 头节点
     * e    : 临时节点
     * k    : 临时节点键
     */
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    /**
     * 哈希数组不为空
     * 数组长度大于0
     * 数组目标位置存在元素
     *
     * 元素位于数组索引下标位置的计算方法：(n - 1) & hash
     */
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (first = tab[(n - 1) & hash]) != null) {
        /* 总是先检查头节点，
           键匹配成功则直接返回头节点 */
        if (first.hash == hash &&
            ((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);
        }
    }
    /* 没找到：当前哈希表中不存在该键值对，返回 null */
    return null;
}

代码清单：HashMap get()方法实现

HashMap 插入方法

HashMapput()方法用于向哈希表中插入键值对，如果哈希表中已经存在键值对，则更新值，返回旧值。

方法执行流程：

1. 如果哈希桶数组为空或数组长度为0， 执行初始化操作；

2. 调用hash()函数计算传入键的哈希值；

3. 根据键哈希值计算该键应位于的哈希桶数组索引下标；

4. 目标位置哈希未冲突，新建节点直接插入；

5. 发生哈希冲突，判断节点链类型，为红黑树则使用红黑树方法插入节点，为链表则使用尾插法插入节点；

6. 更新哈希表存放元素数量，超过临界值则执行扩容。

/**
 * 将键值对插入哈希表中
 */
public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}
/**
 * Map.put() 方法实现
 *
 * @param hash 键哈希值
 * @param key 目标键
 * @param value 目标值
 * @param onlyIfAbsent 如果设为true，则不改变已存在的值
 * @param evict 如果设为false，哈希表为creation mode
 * @return 先前的值，如果无先前键值对则返回 null
 */
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
               boolean evict) {
    /**
     * 准备临时变量
     * tab: 哈希桶数组
     * n  : 数组长度
     * i  : 数组索引
     * p  : 临时节点
     */
    Node<K,V>[] tab; Node<K,V> p; int n, i;
    /* 如果哈希桶数组为空或数组长度为0：扩容 */
    if ((tab = table) == null || (n = tab.length) == 0) {
        n = (tab = resize()).length;
    }
    /* 哈希未冲突 */
    if ((p = tab[i = (n - 1) & hash]) == null) {
        /* 新建节点直接插入 */
        tab[i] = newNode(hash, key, value, null);
    }
    /* 哈希冲突 */
    else {
        Node<K,V> e; K k;
        /* 头节点键与目标键冲突：取得头节点 */
        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;
                }
                /* 与 if((e = p.next) == null) 呼应 */
                p = e;
            }
        }
        /* 侦测到哈希表中已存在目标键 */
        if (e != null) {
            /* 取得已存在的值 */
            V oldValue = e.value;
            /**
             * 更新键值对
             *
             * onlyIfAbsent 参数在这里发挥了作用
             *   true:  不更新键值对
             *   false: 更新键值对
             */
            if (!onlyIfAbsent || oldValue == null) {
                e.value = value;
            }
            /* 节点访问后操作 */
            afterNodeAccess(e);
            /* 返回旧值 */
            return oldValue;
        }
    }
    /* 操作计数器 + 1 */
    ++modCount;
    /* 哈希表存放元素个数 + 1
       节点插入后哈希表元素个数大于临界值：扩容 */
    if (++size > threshold) {
        resize();
    }
    /* 节点插入后操作，为 LinkedHashMap 准备的回调函数 */
    afterNodeInsertion(evict);
    return null;
}

代码清单：HashMap put()方法实现

HashMap 扩容方法

当 HashMap 中存放元素数量超过临界值threshold时，会触发扩容resize()机制：重新计算容量，创建新容量数组替换旧数组。

在JDK 1.8中，哈希桶数组容量为2的幂次，每次扩容都为原容量的2倍，元素在新数组中的索引位置要么是在原位置，要么是原位置再移动2次幂（原位置 + 原数组长度）位置。

图：HashMap 扩容时元素位置变化 - JDK 1.8

/**
 * 初始化或双倍扩容哈希表
 *
 * @return 扩容后哈希桶数组
 */
final Node<K,V>[] resize() {
    /**
     * 准备临时变量
     *
     * oldTab: 旧数组
     * oldCap: 旧数组长度
     * oldThr: 旧临界值
     * newCap: 新容量
     * newThr: 新临界值
     */
    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;
        }
        /* 扩容 2 倍 */
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY) {
            newThr = oldThr << 1;
        }
    }
    else if (oldThr > 0) { // initial capacity was placed in threshold
        newCap = oldThr;
    }
    else {               // zero initial threshold signifies using defaults
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    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;
    /* 旧数组不为空：移动节点至新数组 */
    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
                    Node<K,V> loHead = null, loTail = null;
                    Node<K,V> hiHead = null, hiTail = null;
                    Node<K,V> next;
                    /**
                     * 将原链表拆分为两条链表
                     * 拆分条件：e.hash & oldCap
                     */
                    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;
                        newTab[j] = loHead;
                    }
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

代码清单：HashMap 扩容方法resize()源码