手撕HashMap源码

文章已同步至GitHub开源项目: Java超神之路

HashMap一直是面试的重点。今天我们来了解了解它的源码吧！

首先看一下Map的继承结构图

源码分析

什么是哈希

Hash，一般翻译做“散列”，也有直接音译为“哈希”的，就是把任意长度的输入，通过散列算法，变换成固定长度的输出，该输出就是散列值。这种转换是一种压缩映射，也就是，散列值的空间通常远小于输入的空间，不同的输入可能会散列成相同的输出，所以不可能从散列值来唯一的确定输入值。简单的说就是一种将任意长度的消息压缩到某一固定长度的消息摘要的函数。

衡量一个哈希函数的好坏的重要指标就是发生碰撞的概率以及发生碰撞的解决方案。

任何哈希函数基本都无法彻底避免碰撞两个不同的输入值，根据同一散列函数计算出的散列值相同的现象叫做碰撞。

HashMap 简介

HashMap 主要用来存放键值对，它基于哈希表的 Map 接口实现，是常用的 Java 集合之一。

HashMap 底层数据结构

JDK 1.8 之前 HashMap 底层是数组 + 链表 结合在一起使用，也就是 链表散列。数组是 HashMap 的主体，链表则是主要为了解决哈希冲突而存在的（”拉链法”解决冲突）。

JDK 1.8 之后 HashMap 底层是数组 + 红黑树 。

当链表长度大于阈值（默认为 8）时，会首先调用 treeifyBin() 方法。

这个方法会根据 HashMap 数组来决定是否转换为红黑树。

只有当数组长度大于或者等于 64 的情况下，才会执行转换红黑树操作，以减少搜索时间。否则，就是只是执行 resize() 方法对数组扩容。

源码分析

类的属性：

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;
    // 最大容量
    static final int MAXIMUM_CAPACITY = 1 << 30;
    // 默认的填充因子
    static final float DEFAULT_LOAD_FACTOR = 0.75f;
    // 当桶(bucket)上的结点数大于这个值时会转成红黑树
    static final int TREEIFY_THRESHOLD = 8;
    // 当桶(bucket)上的结点数小于这个值时树转链表
    static final int UNTREEIFY_THRESHOLD = 6;
    // 桶中结构转化为红黑树对应的 table 的最小值
    static final int MIN_TREEIFY_CAPACITY = 64;
    // 存储元素的数组，总是 2 的幂次倍
    transient Node<k,v>[] table;
    // 存放具体元素的集
    transient Set<map.entry<k,v>> entrySet;
    // 存放元素的个数，注意这个不等于数组的长度。
    transient int size;
    // 每次扩容和更改map结构的计数器
    transient int modCount;
    // 临界值 当实际大小(容量*填充因子)超过临界值时，会进行扩容
    int threshold;
    // 加载因子
    final float loadFactor;
}

• loadFactor 加载因子

  loadFactor 加载因子是控制数组存放数据的疏密程度。loadFactor 越趋近于 1，那么数组中存放的数据 ( entry ) 也就越多，也就越密，也就是会让链表的长度增加，loadFactor 越小，也就是趋近于 0，数组中存放的数据 (entry) 也就越少，也就越稀疏。

  loadFactor 太大导致查找元素效率低，太小导致数组的利用率低，存放的数据会很分散。loadFactor 的默认值为 0.75f 是官方给出的一个比较好的临界值。

  给定的默认容量为 16，负载因子为 0.75。Map 在使用过程中不断的往里面存放数据，当数量达到了 16 * 0.75 = 12 就需要将当前 16 的容量进行扩容，而扩容这个过程涉及到 rehash、复制数据等操作，所以非常消耗性能。

• threshold

  threshold = capacity * loadFactor，当 size>=threshold 的时候，那么就要考虑对数组的扩增了，也就是说，threshold 是衡量数组是否需要扩增的一个标准。

Node 节点类源码：

static class Node<K,V> implements Map.Entry<K,V> {
       final int hash;// 哈希值，存放元素到hashmap中时用来与其他元素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; }
        // 重写hashCode()方法
        public final int hashCode() {
            return Objects.hashCode(key) ^ Objects.hashCode(value);
        }

        public final V setValue(V newValue) {
            V oldValue = value;
            value = newValue;
            return oldValue;
        }
        // 重写 equals() 方法
        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;
        }
}

树节点类源码：

static final class c<K,V> extends LinkedHashMap.Entry<K,V> {
        TreeNode<K,V> parent;  // 父
        TreeNode<K,V> left;    // 左
        TreeNode<K,V> right;   // 右
        TreeNode<K,V> prev;    // 删除后需要取消链接
        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;
       }

HashMap 源码分析

构造方法

        // 默认构造函数
    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);
     }

put 方法

HashMap 只提供了 put 用于添加元素，putVal 方法只是给 put 方法调用的一个方法，并没有提供给用户使用。

对 putVal 方法添加元素的分析如下：

1. 如果定位到的数组位置没有元素，就直接插入。
2. 如果定位到的数组位置有元素就和要插入的 key 比较，如果 key 相同就直接覆盖，如果 key 不相同，就判断 p 是否是一个树节点，如果是就调用 e = ((TreeNode)p).putTreeVal(this, tab, hash, key, value) 将元素添加进入。如果不是就遍历链表插入(插入的是链表尾部)。

// 执行 HashSet()
public HashSet() {
        map = new HashMap<>();
    }
// 执行add()
public boolean add(E e) {// e="java"
        return map.put(e, PRESENT)==null;// PRESENT(共享) 占位作用
    }
// 执行 V put(K key,V value)
// key = e = "java",value=PRESENT
public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }
// 执行 hash(Object key)，先求取出键值的 hashcode，然后在将 hashcode 得到的 int 值，对数组长度进行取模。为了考虑性能，Java总采用按位与操作实现取模操作。
static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);// 无符号，右移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;// 定义辅助变量 n,i
        // table 是 HashMap 的一个数组，类型是 Node[]
        // if 语句表示如果当前 table 是 null，或者大小为 0.
        // 那么此时是第一次扩容，大小是16个空间
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        // 根据传入的 key 得到 hash ，去计算该 key 应该存放在 table 表的哪个索引位置。
        // 并且把这个位置的对象，赋值给 p ，再判断 p 是否为 null
        // 如果 p 为空，那么就表示还没有存放过元素，就创建一个 Node (key="java" value=PRESENT)，就放在该位置 tab[i] = newNode(hash, key, value, null);
        // (n-1) & hash ，按位与运算，将 10 进制数值转换为二进制，同为 1 的为 true
        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 && // 如果当前索引位置对应的链表的第一个元素和准备添加的 key 的 hash 值一样，并且满足下面两个条件之一：
                // 1)准备加入的 key 和 p 指向的 Node 的结点 key 是同一个对象
                // 2)指向的 Node 结点的 key 的 equals()(该 equals() 应是程序员自定义) 和准备加入的 key 比较后相同
                // 就不能加入
                ((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 {// 如果 table 对应的索引位置，已经是一个链表了，那么就使用 for 循环依次比较。

                // 1）依次和该链表每个元素比较后都不相同，则加入到该链表的最后
                // 注意在把元素添加到链表后，立即判断该链表是否已经达到8个结点。
                // 如果达到了8个结点，那么就调用treeifyBin()对当前这个链表进行树化（转成红黑树）

                // 在转成红黑树时，要进行判断，如果该 table 数组的大小小于64，那么 table 会继续调用如下条件继续判断：
                //   if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
                //   resize();

                // 如果上述条件成立，就先对 table 扩容
                // 只有上面条件不满足时，才进行转成红黑树

                // 2）依次和该链表每个元素比较过程中，如果有相同情况，就直接break
               for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {
                        // 结点数量达到阈值(默认为 8 )，执行 treeifyBin 方法
                        // 这个方法会根据 HashMap 数组来决定是否转换为红黑树。
                        // 只有当数组长度大于或者等于 64 的情况下，才会执行转换红黑树操作，以减少搜索时间。否则，就是只是对数组扩容。
                        p.next = newNode(hash, key, value, null);
                        p.next = newNode(hash, key, value, null);
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        // 跳出循环
                        break;
                    }
                                        // 判断链表中结点的 key 与插入元素的 key 是否相等
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                                                // 相等，跳出循环
                        break;
                                        // 用于遍历桶中的链表，与前面的 e = p.next 组合，可以遍历链表
                    p = e;
                }
            }
                        // 表示在桶中找到 key hash 都与 插入元素相同结点
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        // size 就是我们每加入一个结点Node(k,v,next)，size就会++
        if (++size > threshold)
            resize();// 扩容
        afterNodeInsertion(evict);
        return null;
    }
final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;// 定义辅助变量 n,i
        // table 是 HashMap 的一个数组，类型是 Node[]
        // if 语句表示如果当前 table 是 null，或者大小为 0.
        // 那么此时是第一次扩容，大小是16个空间
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        // 根据传入的 key 得到 hash ，去计算该 key 应该存放在 table 表的哪个索引位置。
        // 并且把这个位置的对象，赋值给 p ，再判断 p 是否为 null
        // 如果 p 为空，那么就表示还没有存放过元素，就创建一个 Node (key="java" value=PRESENT)，就放在该位置 tab[i] = newNode(hash, key, value, null);
        // (n-1) & hash ，按位与运算，将 10 进制数值转换为二进制，同为 1 的为 true
        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 && // 如果当前索引位置对应的链表的第一个元素和准备添加的 key 的 hash 值一样，并且满足下面两个条件之一：
                // 1)准备加入的 key 和 p 指向的 Node 的结点 key 是同一个对象
                // 2)指向的 Node 结点的 key 的 equals()(该 equals() 应是程序员自定义) 和准备加入的 key 比较后相同
                // 就不能加入
                ((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 {// 如果 table 对应的索引位置，已经是一个链表了，那么就使用 for 循环依次比较。

                // 1）依次和该链表每个元素比较后都不相同，则加入到该链表的最后
                // 注意在把元素添加到链表后，立即判断该链表是否已经达到8个结点。
                // 如果达到了8个结点，那么就调用treeifyBin()对当前这个链表进行树化（转成红黑树）

                // 在转成红黑树时，要进行判断，如果该 table 数组的大小小于64，那么 table 会继续调用如下条件继续判断：
                // if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
                // resize();

                // 如果上述条件成立，就先对 table 扩容
                // 只有上面条件不满足时，才进行转成红黑树

                // 2）依次和该链表每个元素比较过程中，如果有相同情况，就直接break
               for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {
                        // 结点数量达到阈值(默认为 8 )，执行 treeifyBin 方法
                        // 这个方法会根据 HashMap 数组来决定是否转换为红黑树。
                        // 只有当数组长度大于或者等于 64 的情况下，才会执行转换红黑树操作，以减少搜索时间。否则，就是只是对数组扩容。
                        p.next = newNode(hash, key, value, null);
                        p.next = newNode(hash, key, value, null);
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        // 跳出循环
                        break;
                    }
                    // 判断链表中结点的 key 与插入元素的 key 是否相等
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        // 相等，跳出循环
                        break;
                    // 用于遍历桶中的链表，与前面的 e = p.next 组合，可以遍历链表
                    p = e;
                }
            }
            // 表示在桶中找到 key hash 都与 插入元素相同结点
            if (e != null) { // existing mapping for key
                // 记录 e 的 value
                V oldValue = e.value;
                // onlyIfAbsent 为 false 或者旧值为 null
                if (!onlyIfAbsent || oldValue == null)
                    // 用新值替换旧值
                    e.value = value;
                // 访问后回调
                afterNodeAccess(e);
                // 返回旧值
                return oldValue;
            }
        }
        // 结构性修改
        ++modCount;
        // size 就是我们每加入一个结点Node(k,v,next)，size就会++
        // 如果实际大小大于阈值则扩容
        if (++size > threshold)
            resize();// 扩容
        afterNodeInsertion(evict);
        return null;
    }

我们再来对比一下 JDK1.7 put 方法的代码

对于 put 方法的分析如下：

• ① 如果定位到的数组位置没有元素 就直接插入。
• ② 如果定位到的数组位置有元素，遍历以这个元素为头结点的链表，依次和插入的 key 比较，如果 key 相同就直接覆盖，不同就采用头插法插入元素。

public V put(K key, V value)
    if (table == EMPTY_TABLE) {
    inflateTable(threshold);
}
    if (key == null)
        return putForNullKey(value);
    int hash = hash(key);
    int i = indexFor(hash, table.length);
    for (Entry<K,V> e = table[i]; e != null; e = e.next) { // 先遍历
        Object k;
        if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
            V oldValue = e.value;
            e.value = value;
            e.recordAccess(this);
            return oldValue;
        }
    }

    modCount++;
    addEntry(hash, key, value, i);  // 再插入
    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) {
            // 在树中get
            if (first instanceof TreeNode)
                return ((TreeNode<K,V>)first).getTreeNode(hash, key);
            // 在链表中get
            do {
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    return e;
            } while ((e = e.next) != null);
        }
    }
    return null;
}

resize 方法

进行扩容，会伴随着一次重新 hash 分配，并且会遍历 hash 表中所有的元素，是非常耗时的。在编写程序中，要尽量避免 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;
        }
        // 没超过最大值，就扩充为原来的2倍
        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 {
        // signifies using defaults
        newCap = DEFAULT_INITIAL_CAPACITY;
        newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    }
    // 计算新的resize上限
    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) {
        // 把每个bucket都移动到新的buckets中
        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 {
                    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;
                        }
                        // 原索引+oldCap
                        else {
                            if (hiTail == null)
                                hiHead = e;
                            else
                                hiTail.next = e;
                            hiTail = e;
                        }
                    } while ((e = next) != null);
                    // 原索引放到bucket里
                    if (loTail != null) {
                        loTail.next = null;
                        newTab[j] = loHead;
                    }
                    // 原索引+oldCap放到bucket里
                    if (hiTail != null) {
                        hiTail.next = null;
                        newTab[j + oldCap] = hiHead;
                    }
                }
            }
        }
    }
    return newTab;
}

HashMap 常用方法测试

package map;

import java.util.Collection;
import java.util.HashMap;
import java.util.Set;

public class HashMapDemo {

    public static void main(String[] args) {
        HashMap<String, String> map = new HashMap<String, String>();
        // 键不能重复，值可以重复
        map.put("san", "张三");
        map.put("si", "李四");
        map.put("wu", "王五");
        map.put("wang", "老王");
        map.put("wang", "老王2");// 老王被覆盖
        map.put("lao", "老王");
        System.out.println("-------直接输出hashmap:-------");
        System.out.println(map);
        /**
         * 遍历HashMap
         */
        // 1.获取Map中的所有键
        System.out.println("-------foreach获取Map中所有的键:------");
        Set<String> keys = map.keySet();
        for (String key : keys) {
            System.out.print(key+"  ");
        }
        System.out.println();//换行
        // 2.获取Map中所有值
        System.out.println("-------foreach获取Map中所有的值:------");
        Collection<String> values = map.values();
        for (String value : values) {
            System.out.print(value+"  ");
        }
        System.out.println();//换行
        // 3.得到key的值的同时得到key所对应的值
        System.out.println("-------得到key的值的同时得到key所对应的值:-------");
        Set<String> keys2 = map.keySet();
        for (String key : keys2) {
            System.out.print(key + "：" + map.get(key)+"   ");

        }
        /**
         * 如果既要遍历key又要value，那么建议这种方式，因为如果先获取keySet然后再执行map.get(key)，map内部会执行两次遍历。
         * 一次是在获取keySet的时候，一次是在遍历所有key的时候。
         */
        // 当我调用put(key,value)方法的时候，首先会把key和value封装到
        // Entry这个静态内部类对象中，把Entry对象再添加到数组中，所以我们想获取
        // map中的所有键值对，我们只要获取数组中的所有Entry对象，接下来
        // 调用Entry对象中的getKey()和getValue()方法就能获取键值对了
        Set<java.util.Map.Entry<String, String>> entrys = map.entrySet();
        for (java.util.Map.Entry<String, String> entry : entrys) {
            System.out.println(entry.getKey() + "--" + entry.getValue());
        }

        /**
         * HashMap其他常用方法
         */
        System.out.println("after map.size()："+map.size());
        System.out.println("after map.isEmpty()："+map.isEmpty());
        System.out.println(map.remove("san"));
        System.out.println("after map.remove()："+map);
        System.out.println("after map.get(si)："+map.get("si"));
        System.out.println("after map.containsKey(si)："+map.containsKey("si"));
        System.out.println("after containsValue(李四)："+map.containsValue("李四"));
        System.out.println(map.replace("si", "李四2"));
        System.out.println("after map.replace(si, 李四2):"+map);
    }

}

我是开源君，关注一波，以后还会带来更多的源码分析。让我们一起在java学习之路上进步！

文章已同步至GitHub开源项目: Java超神之路 更多Java相关知识，欢迎访问！