HashMap源码简解(二)

63 阅读5分钟

​静态变量

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

    /** 集合初始化容量,必须是2的n次幂,默认的初始容量是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;

    /** 当链表元素数量超过该值,则会转为红黑树(jdk1.8新增) */
    static final int TREEIFY_THRESHOLD = 8;

    /** 当链表的值小于6,则会从红黑树转回链表 */
    static final int UNTREEIFY_THRESHOLD = 6;

    /** 当存放元素数量超过该值,表中的桶才能转换为红黑树,否则桶内元素超过指定条件时只会进行扩容 */
    static final int MIN_TREEIFY_CAPACITY = 64;

    /** 数组结构 */
    transient Node<K,V>[] table;

    /**存放缓存数据 */
    transient Set<Map.Entry<K,V>> entrySet;

    /**存放元素数量 */
    transient int size;

    /** 用来记录HashMap修改次数,即每次扩容和更改map结构的计数器 */
    transient int modCount;

    /** 扩容临界值,当存放元素数量超过临界值(容量*负载因子)时,会进行扩容 */
    int threshold;

    /** 哈希表加载因子 */
    final float loadFactor;

​存放元素的数据结构 ​

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

构造函数

1、自定义容量和负载因子

2、自定义容量,默认负载因子0.75

3、默认容量16,默认负载因子0.75

4、传入一个map ​

/**
     *  指定容量大小和负载因子的构造函数
     *  @param initialCapacity 容量
     *  @param loadFactor 负载因子
     */
    public HashMap(int initialCapacity, float loadFactor) {
        // 判断初始化容量initialCapacity是否小于0,如果小于0,则抛出非法的参数异常IllegalArgumentException
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " +
                                               initialCapacity);

        // 判断初始化容量initialCapacity是否大于集合的最大容量MAXIMUM_CAPACITY,如果是,则使用最大值
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;

        // 判断负载因子loadFactor是否小于等于0或者是否是一个非数值
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " +
                                               loadFactor);

        // 将指定的负载因子赋值给HashMap成员变量的负载因子loadFactor
        this.loadFactor = loadFactor;
        this.threshold = tableSizeFor(initialCapacity);
    }

    /**
     * 制定容量大小的构造函数。负载因子使用默认的0.75
     * @param  initialCapacity 容量.
     */
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

    /**
     * 使用默认容量16和默认负载因子0.75的构造函数
     */
    public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

    /**
     构造一个新的HashMap,其映射与指定的map相同。
     */
    public HashMap(Map<? extends K, ? extends V> m) {
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

​以上1,2,3种构造方法都会调用以下方法 ​

/**
     * 返回比指定初始化容量大的最小的2的n次幂,
     * 例如:制定的容量是11,返回16
     */
    static final int tableSizeFor(int cap) {
        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;
    }

​如果自定义的容量大于2的30次幂,则容量默认2的30次幂;如果自定义的容量不是2的n次幂,则容量改成大于自定义容量的最接近自定义的2的n次幂,例如, ​

/**  实际上的容量是16 */
Map<String, String> map = new HashMap<>(11);

put操作

步骤:

1、先对key进行hash运算,得出要存的桶的下标

2、判断该桶上是否有值,如果没有,直接存入;如果有,则遇到了哈希冲突:

        a、判断要插入的key与冲突的key值是否一致,如果是则更新value;

        b、判断该桶冲突的节点是否是TreeNode(红黑树结构),如果是,则调用红黑树的插入方法putTreeNode()

        c、最后的情况就是冲突节点使用的是链表结构,循环遍历链表,如果有相同的key则更新value,如果没有,则在末尾插入节点;判断链表长度是否大于等于8,如果是则调用转换成红黑树的方法treeifyBin,该方法中会对数组长度进行检查,如果小于MIN_TREEIFY_CAPACITY=64会对数组进行扩容,所以并不一定会转成红黑树。

3、如果 size 大于阈值 threshold(容量*负载因子),则进行扩容; ​

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;

        // 判断集合是否新创建,即tab为null
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;

        // 计算结点位置是否已存在元素,存在则表示有希碰撞冲突情况,不存在直接将元素插入该位置
        // 将已存在的桶数据保存到变量p中
        if ((p = tab[i = (n - 1) & hash]) == null)
            // 创建一个新的结点存入到桶中
            tab[i] = newNode(hash, key, value, null);

        // 执行else说明tab[i]不等于null,表示这个位置已经有值了
        else {
            Node<K,V> e; K k;

            // 1. 元素hash值相等,但是不能确定是同一个值
            // 2. key是否是同一实例,或者值是否相等
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                // 说明:两个元素哈希值相等,并且key的值也相等,将旧的元素整体对象赋值给e,用e来记录
                e = p;

            // 如果hash值不相等或者key不相等;判断p是否为红黑树结点
            else if (p instanceof TreeNode)
                // 放入树中
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);

            // 说明是链表结点
            // 1)如果是链表的话需要遍历到最后结点然后插入
            // 2)采用循环遍历的方式,判断链表中是否有重复的key
            else {
                for (int binCount = 0; ; ++binCount) {
                    // 判定p.next是否到达链表的尾部
                    // 取出p.next赋值给e
                    if ((e = p.next) == null) {
                        // 将节点插入到链表的尾部
                        p.next = newNode(hash, key, value, null);

                        // 判断是否达到转换为红黑树的临界条件,如果是则调用treeifyBin转换为红黑树
                        // 注意:treeifyBin方法会对数组长度进行检查,如果小于MIN_TREEIFY_CAPACITY会对数组进行扩容
                        if (binCount >= TREEIFY_THRESHOLD - 1)
                            // 这里虽然判断是7>=7,但是因为binCount是从0开始的,所以走到这第八个节点已经插入了
                            // 转换为红黑树
                            treeifyBin(tab, hash);
                        // 跳出循环
                        break;
                    }

                    // 没有到达链表尾部,判断key值是否相同
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        // 如果key相等,则跳出循环
                        break;
                    // 说明新添加的元素和当前结点不相等,继续查找下一个结点。
                    // 用于遍历桶中的链表,与前面的e = p.next组合,可以遍历链表
                    p = e;
                }
            }

            // 表示在桶中找到key值、hash值与插入元素相等的结点
            // 也就是说通过上面的操作找到了重复的键,所以这里就是把该键的值变为新的值,并返回旧值
            // 这里完成了put方法的修改功能
            if (e != null) { // existing mapping for key
                // 记录e的value
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    // 更新值
                    e.value = value;
                // 访问后回调
                afterNodeAccess(e);
                // 返回旧值
                return oldValue;
            }
        }
        // 修改记录次数
        ++modCount;
        // 判断实际大小是否大于threshold阈值,如果超过则扩容
        if (++size > threshold)
            // 扩容
            resize();
        // 插入后回调
        afterNodeInsertion(evict);
        return null;
    }

​hash值的运算 ​

    /**
     * 返回key的哈希值
     */
    static final int hash(Object key) {
        int h;
        /*
            1)如果key等于null:返回的是0.
            2)如果key不等于null:首先计算出key的hashCode赋值给h,然后与h无符号右移16位后的
                二进制进行按位异或得到最后的hash值
        */
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

putTreeNode()

先找到根节点,然后判断是从左边找还是右边找key。
找到了则直接返回找到的节点。
没找到则新建节点将该新建节点放到适当的位置,同时考虑红黑树跟双向链表的节点插入情况 ​

        /**
         * 红黑树的节点插入
         */
        final TreeNode<K,V> putTreeVal(HashMap<K,V> map, Node<K,V>[] tab,
                                       int h, K k, V v) {
            Class<?> kc = null; // 定义k的class对象
            boolean searched = false; // 标识是否已经遍历过一次树,未必是从根节点遍历的
            TreeNode<K,V> root = (parent != null) ? root() : this; // 父节点不为空则查找根节点,为空则自身就是根节点

            // 从根节点开始遍历,没有终止条件,只能从内部退出
            for (TreeNode<K,V> p = root;;) {
                // 声明查找方向,当前节点的hash值,当前节点
                int dir, ph; K pk;
                if ((ph = p.hash) > h) // 如果当前节点的hash值大于指定key的hash值
                    dir = -1;  // 要插入的节点应在当前节点的左边
                else if (ph < h) // 如果当前节点的hash值小于指定key的hash值
                    dir = 1;   // 要插入的节点应在当前节点的右边
                else if ((pk = p.key) == k || (k != null && k.equals(pk))) // 如果当前节点的hash值和key跟指定的key一样
                    return p; // 返回该节点
                else if ((kc == null &&
                          (kc = comparableClassFor(k)) == null) ||
                         (dir = compareComparables(kc, k, pk)) == 0) {
                    if (!searched) {
                        TreeNode<K,V> q, ch;
                        searched = true;
                        if (((ch = p.left) != null &&
                             (q = ch.find(h, k, kc)) != null) ||
                            ((ch = p.right) != null &&
                             (q = ch.find(h, k, kc)) != null))
                            return q;
                    }
                    dir = tieBreakOrder(k, pk);
                }

                TreeNode<K,V> xp = p;
                if ((p = (dir <= 0) ? p.left : p.right) == null) {
                    Node<K,V> xpn = xp.next;
                    TreeNode<K,V> x = map.newTreeNode(h, k, v, xpn);
                    if (dir <= 0)
                        xp.left = x;
                    else
                        xp.right = x;
                    xp.next = x;
                    x.parent = x.prev = xp;
                    if (xpn != null)
                        ((TreeNode<K,V>)xpn).prev = x;
                    moveRootToFront(tab, balanceInsertion(root, x));
                    return null;
                }
            }
        }

流程图

​​​编辑​