再学Java基础-HashMap源码分析

266 阅读7分钟

1 前言

基础不牢,地动山摇!!! 日常业务开发HashMap我们用的非常多,最常用的做法一般是会先从数据库查询出查出一个List,转成我们需要的Map,根据Map中的key值找出业务中需要的value。

2 概述

本文基于JDK1.8分析,为了能对HashMap整体框架的把握,对某些细节不做过多的分析(例如红黑树是怎么实现的)。

2.1 继承体系

HashMap的继承体系如下:主要是实现了Map接口和继承AbstactMap类 image.png

2.2 底层数据结构

HashMap的底层数据结构是数组+链表或者红黑树,当发生hash碰撞时形成链表,当链表长度大于8并且数组长度不小于64(图中为了展示红黑树忽略了这点)时转成红黑树。 HashMap_基础数据结构.png

2.3 主要知识点

我们先通过思维导图整体了解下本文主要涉及的知识点。

uTools_1685721942529.png

3源码分析

3.1 成员变量

// HashMap底层的数据结构,是一个对象为Node的数组
transient Node<K,V>[] table;

// 阈值,等于table * loadFactor,当添加的元素数量超过阈值的大小数组就会扩容,
// 注意这里是添加的元素的个数不是table中数组下标不为空的个数
int threshold;

// 加载因子
final float loadFactor;

3.2 构造方法(初始化)

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

无参构造方法比较简单,只对加载因子赋初始值。

/**
* initialCapacity: 指定初始化容量,也就是table的大小
* loadFactor:指定加载因子大小
*/
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;
    // 返回大于输入参数且最近的2的整数次幂的数
    this.threshold = tableSizeFor(initialCapacity);
}

在这里我们主要是要知道tableSizeFor方法的作用,方法的细节不深究,为什么阈值threshold必须是2的整数次幂等,其实在put方法中添加第一个元素时,在resize方法会判断threshold是否大于0,如果大于0则赋值给新的数组,相当于threshold就等于table的大小,暂时不理解没关系,继续往下看。

3.3 put方法(添加元素)

put方法会调用putVal方法,整体逻辑并不复杂。

public V put(K key, V value) {
    // hash(key)方法算出key的hash值,比如对于整数1来说,hash值就是1
    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没有初始化则先通过resize方法进行初始化,阈值threshold和table都会初始化
    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;
        // 如果与第一个节点的key相同,把p赋值给e
        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);
                    // 链表长度大于8,转化成红黑树
                    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;
            }
        }
        // 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;
}

3.4 resize方法(扩容机制)

从我们上面分析的put方法可知,会有两种情况触发调用resize方法,第一种是当table数组没有初始化的时候,第二种是当添加元素超过阈值时候,那么我们可以猜测resize方法的作用就是初始化数组和扩容,先通过图片大致了解扩容机制。

HashMap.png

图1.4.1

上图数组初始长度为4,加载因子是默认值0.75,可以得出阈值threshold = 4 * 0.75 = 3,假如添加元素顺序是(1,1)、(5,5)、(9,9)、(13,13),那么当添加(13,13),此时元素个数为4大于3则触发扩容。
final Node<K,V>[] resize() {
    Node<K,V>[] oldTab = table;
    int oldCap = (oldTab == null) ? 0 : oldTab.length;
    int oldThr = threshold;
    int newCap, newThr = 0;
    // 如果旧数组大小大于0
    if (oldCap > 0) {
        if (oldCap >= MAXIMUM_CAPACITY) {
            threshold = Integer.MAX_VALUE;
            return oldTab;
        }
        // 新数组和阈值都扩大到原来的两倍,oldCap << 1 算术左移相当于乘以2
        else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                 oldCap >= DEFAULT_INITIAL_CAPACITY)
            newThr = oldThr << 1; // double threshold
    }
    // 如果旧数组没有初始化,则把当前阈值大小赋值给新数组大小,这里就说明了在构造函数对threshold赋值
    // 为初始化容量大小的作用(对应HashMap(int initialCapacity, float loadFactor))
    else if (oldThr > 0) // initial capacity was placed in threshold
        newCap = oldThr;
    // 否则,初始化默认的大小(对应无参构造函数HashMap())
    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);
                // 如果是链表,则进行节点重新迁移,可参考图1.4.1
                else { // preserve order
                    // 重新计算下标位置,两个链表,一个是位置不变的链表lo,一个是旧下标+oldCap的链表hi
                    Node<K,V> loHead = null, loTail = null;
                    Node<K,V> hiHead = null, hiTail = null;
                    Node<K,V> next;
                    do {
                        next = e.next;
                        // 与旧数组大小做与运算,如果为0则放到lo链表,否则放到hi链表,
                        // 这里为什么和旧数组大小做与运算,我的理解是一个链表上的元素是差为oldCap的等
                        // 差数列(排好序),& oldCap出现为0和不为0的概率是相等的,所以lo和hi的数量大小基本是相同的
                        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;
}

通过上面的分析已经清晰了很多,最后这里还有个疑问重新计算下标的时候为什么不是通过hash值和新数组大小取模,而是通过与旧数组大小做与运算 判断是否为0的方式来重新定位,有知道的小伙伴可以评论下。

3.5 get方法和remove方法(查找和删除)

关于查找和删除方法逻辑和put方法其实差不太多,这里就不展开分析了。

3.6 HashMap遍历相关

HashMap遍历的方式有3种,但每种都有不同的实现,删除只有迭代器方式是安全的,本文只要分析迭代器(iterator)的方式,其他只给出使用的例子。

image.png

3.6.1 使用keySet迭代器进行遍历

下面是使用的例子,主要通过keySet()的方式迭代

HashMap<Integer, Integer> map = new HashMap<>();
map.put(1, 1);
map.put(2, 2);

// 使用迭代器方式遍历
Iterator<Integer> iterator = map.keySet().iterator();
while (iterator.hasNext()) {
    Integer key = iterator.next();
    System.out.println(key + "=" + map.get(key));
}

// 这种方式实际也是使用迭代器,会调用iterator方法,接着调用hasNext()、next()方法,实际和上面的方式是一样的
for (Integer key : map.keySet()) {
    System.out.println(key + "=" + map.get(key));
}

我们先看下keySet方法的源码

public Set<K> keySet() {
    Set<K> ks = keySet;
    if (ks == null) {
        ks = new KeySet();
        keySet = ks;
    }
    return ks;
}

这里返回了一个KeySet实例,KeySet继承了AbstractSet,再看迭代器方法iterator()返回了KeyIterator实例,最终可以看到KeyIterator继承了HashIterator,我们重点来看下HashIterator

abstract class HashIterator {
    Node<K,V> next;        // next entry to return
    Node<K,V> current;     // current entry
    int expectedModCount;  // for fast-fail
    int index;             // current slot

    HashIterator() {
        // 创建迭代器时,modCount赋值给expectedModCount,防止并发修改的情况
        expectedModCount = modCount;
        Node<K,V>[] t = table;
        current = next = null;
        index = 0;
        // 找到第一个数据不为空的桶的下标,赋值给index
        if (t != null && size > 0) { // advance to first entry
            do {} while (index < t.length && (next = t[index++]) == null);
        }
    }

    public final boolean hasNext() {
        return next != null;
    }

    // next方法最终会调用nextNode方法
    final Node<K,V> nextNode() {
        Node<K,V>[] t;
        // 把下一个节点赋值给e
        Node<K,V> e = next;
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        // 要先调用hasNext方法判断,否则可能会抛出NoSuchElementException异常
        if (e == null)
            throw new NoSuchElementException();
        // 如果当前桶已经遍历完,查找下一个有数据的桶
        if ((next = (current = e).next) == null && (t = table) != null) {
            do {} while (index < t.length && (next = t[index++]) == null);
        }
        return e;
    }

    public final void remove() {
        Node<K,V> p = current;
        if (p == null)
            throw new IllegalStateException();
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        current = null;
        K key = p.key;
        removeNode(hash(key), key, null, false, false);
        expectedModCount = modCount;
    }
}

KeyIterator和ValueIterator都继承了HashIterator,因此key遍历和value遍历基本上一样。

3.6.2 使用entrySet迭代器进行遍历

下面是使用的例子,主要通过entrySet()的方式迭代

HashMap<Integer, Integer> map = new HashMap<>();
map.put(1, 1);
map.put(2, 2);

// 使用迭代器方式遍历
Iterator<Map.Entry<Integer, Integer>> iterator = map.entrySet().iterator();
while (iterator.hasNext()) {
    Map.Entry<Integer, Integer> entry = iterator.next();
    System.out.println(entry.getKey() + "=" + entry.getKey());
}

// 这种方式实际也是使用迭代器,会调用iterator方法,
// 接着调用hasNext()、next()方法,实际和上面的方式是一样的
for (Map.Entry<Integer, Integer> entry : map.entrySet()) {
    System.out.println(entry.getKey() + "=" + entry.getKey());
}

继续来看源码

public Set<Map.Entry<K,V>> entrySet() {
    Set<Map.Entry<K,V>> es;
    return (es = entrySet) == null ? (entrySet = new EntrySet()) : es;
}


final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
    public final int size()                 { return size; }
    public final void clear()               { HashMap.this.clear(); }
    public final Iterator<Map.Entry<K,V>> iterator() {
        return new EntryIterator();
    }
    
    // 省略了其他源码
}

返回了EntrySet,和KeySet、ValueSet一样都继承了AbstractSet,里面的元素是Map.Entry<K,V>类型,实际类型是Node<K,V>,iterator方法返回了EntryIterator,EntryIterator同样也继承了HashIterator。到这里我们可以看到无论是KeySet、ValueSet还是EntrySet的迭代器的父类其实都是同一个,这里代码复用的思想可以学习下。

4 后语

对HashMap的源码分析就到此了,由于水平和精力都有限,还有很多细节和关键点都没有分析到,不知道这样写下来是否能表达明白,如果对大家有那么一点点帮助,实属荣幸!!