直击HashMap源码

HashMap源码分析

前言

我们在开发当中常常会用到HashMap这个对象，去存储key-value的数据，但是大多数时候我们都没去细细分析HashMap的源码。

今天我就来跟着HashMap源码来分析HashMap是如何实现存储，扩容，以及性能优化的。

为了方便查看可以快速检索文章大纲

HashMap数据结构

HashMap是通过 数组+单向链表+红黑树 3种数据结构来存储key和value的

这里先提前说一下 hashmap中key的寻址方法是

数组地址= （ hashcode ^ (hashcode >>> 16) ） & (数组长度 - 1)

等等会在源码当中详细讲解

源码部分

1.HashMap包含的字段分析

/**
* 初始化散列表大小  1 << 4 = 16  二进制的10000
*/
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

/**
* 最大的散列表大小 1 << 30 挺大一个数字基本不可能达到
*/
static final int MAXIMUM_CAPACITY = 1 << 30;

/**
* 默认加载因子 0.75f 扩容的阈值 = 容器当前大小 * 负载因子
* 默认16容器大小 所以 16 * 0.75 = 12
*/
static final float DEFAULT_LOAD_FACTOR = 0.75f;

/**
* 树化阈值 当链表长度 >= 8 时 进入树化的treeify方法 将链表变为红黑树
*/
static final int TREEIFY_THRESHOLD = 8;

/**
* 红黑树降级为链表的阈值 <= 6时 进入untreeify方法
*/
static final int UNTREEIFY_THRESHOLD = 6;

/**
* 最小树化的容器大小 散列表数组的长度 < 64时 是不会树化的
* 所以当某个桶位链表的长度 >= 8 且 散列表数组的长度 < 64时 会让其扩容
*/
static final int MIN_TREEIFY_CAPACITY = 64;

/**
* 散列表对象
*/
transient Node<K,V>[] table;

/**
* 散列表中元素的大小
*/
transient int size;

/**
* 操作次数 put remove的时候都会操作该对象 替换的时候不会操作
*/
transient int modCount;

/**
* 扩容阈值 在初始化散列表的时候会赋值
*/
int threshold;

/**
* 负载因子 在初始化HashMap的时候会赋值
*/
final float loadFactor;

2.构造函数

public HashMap(int initialCapacity, float loadFactor) {
    // initialCapacity 初始化散列表大小
    // loadFactor 负载因子
    
    //简单的判断 初始化容器的大小肯定不能 < 0
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal initial capacity: " +
                                           initialCapacity);
    //这里是判断 传入的容器大小是否大于 之前讲过的最大散列表大小 1 << 30
    if (initialCapacity > MAXIMUM_CAPACITY)
        //如果大于最大的限制，那么容器的设置就为最大的限制 1 << 30
        initialCapacity = MAXIMUM_CAPACITY;
    
    // 简单的判断 传入的负载因子是否 <= 0 是否为空
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal load factor: " +
                                           loadFactor);
    
    //赋值负载因子
    this.loadFactor = loadFactor;
    // 这里是赋值了扩容阈值
    // 接下来我们看看tableSizeFor方法 阅读tableSizeFor方法后可以知道
    // 当使用有参数构造函数 实例化HashMap时 初始化的扩容阈值等于传入的扩容阈值
    this.threshold = tableSizeFor(initialCapacity);
}

static final int tableSizeFor(int cap) {
    //这里一系列位运算操作 可以知道 HashMap散列表的大小肯定是 2的次方数
    //比如 传入的cap = 7 经过以下的运算后为8
    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;
}

public HashMap(int initialCapacity) {
    //这里是套娃的方法
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

public HashMap() {
    //初始化的时候 赋值默认的负载因子
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

2.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;
            }
            // oldCap << 1 可以粗略理解为 oldCap * 2 并且赋值给newCap
            // 1. 判断老的散列表大小*2 是否 < 大的散列表大小
            // 2. 判断老的散列表大小 是否 = 表大小 1 << 4 = 16
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                //以上两种情况满足 新的扩容阈值 = 老的扩容阈值 * 2
                newThr = oldThr << 1; // double threshold
            //以上可以看出 HashMap扩容策略 是 当前的数组长度 << 1
        }
     	
     	// 老的扩容阈值 > 0 这种情况什么时候会存在 
     	// 当调用有参构造器初始化hashmap的时候散列表数组大小可以手动设置为0
     	// 此时的扩容阈值 = 1 这种情况会进入此方法
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
     
        // 这里是指hashmap的散列表还没有被初始化的时候 执行的方法
     	else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            // 扩容阈值 = 默认负载因子 * 默认散列表大小 = 0.75f * 16 = 12
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
     
     	// 当进入 else if (oldThr > 0) 时会执行以下代码
        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;
                    // 三种情况 桶位没有Node对象 直接就赋值了
                    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;
                        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;
    }

3. put方法

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

可以看到put方法是个套娃的方法，套了putVal方法并且方法的参数中调用了hash(key)的方法

我们先分析hash(key)方法

static final int hash(Object key) {
    int h;
    //这里是一个扰乱的方法 将key原本的hashCode异或上 h >>> 16 位
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

这里可以看到实际上HashMap不是直接拿key.hashCode()来做剩下的操作的

接下来我们看putVal方法

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
    	//tab 散列表对象
    	//p 寻址后散列表某个索引桶位上的节点对象
    	//n 散列表数组的长度
    	//i 寻址算法找到的散列表索引
        Node<K,V>[] tab; Node<K,V> p; int n, i;
    	
    	// 如果HashMap中的table没有初始化 执行resize()初始化 并且将初始化后的散列表数组长度赋值给n
    	// 这里可以看出 HashMap中的散列表不是在实例化HashMap时初始化的 而是懒加载
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
    	// 这里有两种情况
    	// 1.寻址后桶位上的节点正好没有值
   		// 2.寻址后桶位上的节点有值
    	
    	// 寻址算法 之前hash（key）方法扰乱后的hash值 & 当前散列表长度 - 1 = 散列表中应当存放的索引
        if ((p = tab[i = (n - 1) & hash]) == null)
            //简单的初始化Node对象 赋值给tab[i]
            tab[i] = newNode(hash, key, value, null);
    
    	// 寻址后桶位上节点有值的情况
        else {
            // e 节点
            // k 存入hashMap的key
            Node<K,V> e; K k;
            
            //这里可以看到 hashMap比较对象的时候 有3步
            //1.比较扰乱后的hash值 这里需要注意 不是key原本的hashCode而是之前hash(key)方法扰乱后的hash
            //2. 比较key在内存中的地址
            //3. 调用key对象的equals方法对比
            //所以当HashMap中要存入自定义对象的时候 要重写hashCode方法和equals方法
            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) {
                        //找到空位 插入Node
                        p.next = newNode(hash, key, value, null);
                        // 这里就是判断是否达到树化阈值
                        // TREEIFY_THRESHOLD - 1 比较 是因为 binCount从0开始的
                        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;
                }
            }
            
            //这里是判断当找到 key相同的Node节点时 是否替换值
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                // onlyIfAbsent == false 或者 null时 会替换原来的值为新值
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
    	//操作数 自增
        ++modCount;
    	//散列表元素数量 自增  并且判断是否大于扩容阈值
        if (++size > threshold)
            //扩容
            resize();
    	//此处是LinkedHashMap调用的方法 HashMap此方法内没有执行任何操作
        afterNodeInsertion(evict);
        return null;
    }

结束语

该片文章只是起到抛转引玉的作用 HashMap最核心的方法实际上就是putVal和remove方法，当明白了putVal方式，我想聪明的你们肯定自己看remove方法或者其他方法没有问题。

自律使人成长，自律使人成功~ 大家一起加油！