jdk源码——hashmap

/**
 * HashMap是基于哈希表的 Map 接口的实现。此实现提供全部可选的映射操做，并容许使用 null 值和 null 键。当null为键值时，其键的hash值为0
 * 此类不保证映射的顺序，特别是它不保证该顺序恒久不变。 
 * HashMap与Hashtable的区别：HashMap是非synchronized的，并能够接受null的键(key)和值(value)，而Hashtable的每一个方法都是synchronized的，且不可接受null的键(key)和值(value)。
 * Hashtable与ConCurrentHashMap的区别：Hashtable由于是对每一个方法加上synchronized进行同步的，所以其是对整个对象进行同步，而ConCurrentHashMap使用分段所技术，所以其性能要好一些。
 * 
 */
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; // aka 16

    /**
     * 容量的最大值为2^30个
     */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * 默认的填充因子为0.75
     */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    /**
     * 当桶中元素个数超过这个值时须要使用红黑树结构替换单向链表结构
     */
    static final int TREEIFY_THRESHOLD = 8;

    /**
     * 当扩容时，桶中元素个数小于这个值就会把树形的桶元素还原为链表结构
     */
    static final int UNTREEIFY_THRESHOLD = 6;

    /**
     * 在转变成树以前，还会有一次判断，只有键值对数量大于 64 才会发生转换。这是为了不在哈希表创建初期，多个键值对刚好被放入了同一个链表中而致使没必要要的转化。
     */
    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;

    /**
     * 返回大于等于cap的最小的二次幂数值。
     */
    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;
    }

    /**
     * 
     */
    public HashMap(int initialCapacity, float loadFactor) {
    	// 初始容量不能小于0，不然报错
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal initial capacity: " + initialCapacity);
        // 初始容量不能大于最大值，不然为最大值
        if (initialCapacity > MAXIMUM_CAPACITY)
            initialCapacity = MAXIMUM_CAPACITY;
        // 填充因子不能小于或等于0，不能为非数字
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
        // 初始化填充因子
        this.loadFactor = loadFactor;
        // 初始化threshold大小
        this.threshold = tableSizeFor(initialCapacity);
    }

    /**
     * 将m的全部元素存入本HashMap实例中
     */
    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
        int s = m.size();
        if (s > 0) {
        	// 判断table是否已经初始化
            if (table == null) {
            	// 未初始化，s为m的实际元素个数
                float ft = ((float)s / loadFactor) + 1.0F;
                int t = ((ft < (float)MAXIMUM_CAPACITY) ? (int)ft : MAXIMUM_CAPACITY);
                // 计算获得的t大于阈值，则初始化阈值
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            // 已初始化，而且m元素个数大于阈值，进行扩容处理
            else if (s > threshold)
                resize();
            // 将m中的全部元素添加至HashMap中
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
                putVal(hash(key), key, value, false, evict);
            }
        }
    }

    /**
     * 在hash表中寻找hash值为hash，键为key的节点
     */
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        // 若是table已经初始化，长度大于0，根据hash寻找table中的项也不为空则开始寻找，不然返回null
        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);
            }
        }
        return null;
    }

    /**
     * 判断是否存在键为key的键值对
     */
    public boolean containsKey(Object key) {
        return getNode(hash(key), key) != null;
    }

    /**
     * 添加一个键为key值为value的键值对
     */
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

    /**
     * 向map中添加一个元素，onlyIfAbsent为false时，若是存在与键key相等的元素，将其值替换为value，并将原来的值返回，不然不作替换
     */
    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未初始化或者长度为0，进行扩容
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        // (n - 1) & hash 肯定元素存放在哪一个桶中，桶为空，新生成结点放入桶中(此时，这个结点是放在数组中)
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        // 桶中已经存在元素
        else {
            Node<K,V> e; K k;
            //与桶中第一个元素(数组中的结点)比较，若是hash值相等，key相等，
            if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k))))
            	// 将第一个元素赋值给e，用e来记录
                e = p;
            //若是hash值不相等，即key不相等；且节点为红黑树结点
            else if (p instanceof TreeNode)
            	// 放入树中
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            //若是为链表结构
            else {
            	// 在链表最末插入结点
                for (int binCount = 0; ; ++binCount) {
                	// 经过e = p.next和p = e遍历该桶中的链表，直到链表的尾部
                    if ((e = p.next) == null) {
                    	// 在尾部插入新结点
                        p.next = newNode(hash, key, value, null);
                        // 结点数量达到阈值，转化为红黑树
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    //在循环链表时再次对其中的元素进行判断，看是否有元素的hash和键重复，若是重复则跳出循环
                    if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            // 若是此时e不为null，表示在桶中找到key值、hash值与插入元素相等的结点
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                // onlyIfAbsent为false或者旧值为null为false或者旧值为null时替换其值
                if (!onlyIfAbsent || oldValue == null)
                	//用新值替换旧值
                    e.value = value;
                // 访问后回调
                afterNodeAccess(e);
                // 返回旧值
                return oldValue;
            }
        }
        //结构性修改，计数器+1
        ++modCount;
        // 实际大小大于阈值则扩容
        if (++size > threshold)
            resize();
        // 插入后回调
        afterNodeInsertion(evict);
        return null;
    }

    /**
     * 扩容，从新设置map中hash表的大小，而且将桶中的元素从新摆放
     * 进行扩容，会伴随着一次从新hash分配，而且会遍历hash表中全部的元素，是很是耗时的。在编写程序中，要尽可能避免resize。
     * 即尽可能预估好元素的个数，在hashmap初始化时就指定容量
     * 须要注意的一点是，由于resize后的table的大小为原来的两倍，所以原来table中的元素resize后的位置只有两种可能一种就是原来的桶中，一种是原来的桶的位置加上原来table的长度的位置。
     */
    final Node<K,V>[] resize() {
    	// 将当前table保存
        Node<K,V>[] oldTab = table;
        // 保存当前table大小
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        // 保存当前阈值
        int oldThr = threshold;
        int newCap, newThr = 0;
        // 若是以前table大小大于0
        if (oldCap > 0) {
        	// 若是以前table的大小大于最大容量
            if (oldCap >= MAXIMUM_CAPACITY) {
            	// 将阈值设置为最大整形
                threshold = Integer.MAX_VALUE;
                //返回旧的table
                return oldTab;
            }
            //若是原来的容量大于初始容量，且将其增为两倍后仍然小于最大容量
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY && oldCap >= DEFAULT_INITIAL_CAPACITY)
            	// 阈值翻倍
                newThr = oldThr << 1; //
        }
        // 若是以前阈值大于0
        else if (oldThr > 0) //
            newCap = oldThr;
        //若是oldCap = 0而且oldThr = 0，使用缺省值
        //当使用如使用HashMap()构造函数，以后再插入一个元素会调用resize函数，会进入这一步
        else {
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // 若是新阈值为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"})
        /**
         * 初始化一个存储节点的数组，其大小由上面的代码获得是2的整数次幂
         */
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];
        table = newTab;
        // 若是以前的table已经初始化过
        if (oldTab != null) {
        	// 复制元素，从新进行hash
            for (int j = 0; j < oldCap; ++j) {
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
                    //若是原来的桶中只有一个元素，则直接放到resize后相应的桶中
                    if (e.next == null)
                        newTab[e.hash & (newCap - 1)] = e;
                    //若是桶的数据结构为红黑树，则对红黑树进行裁剪
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    //若是桶的数据结构为链表，则将同一桶中的元素根据(e.hash & oldCap)是否为0进行分割，分红两个不一样的链表，完成rehash
                    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;
                            }
                            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;
    }

    /**
     * 若是存在节点的键为key的节点则将其删除并返回此节点，不然不作更改
     * matchValue为true时还须要判断值相等才能进行删除
     * movable是否将删除节点后新的红黑树的根节点移到链表的开头位置
     */
    final Node<K,V> removeNode(int hash, Object key, Object value, boolean matchValue, boolean movable) {
        Node<K,V>[] tab; Node<K,V> p; int n, index;
        //若是table不为null，且table的长度大于0，而且hash值对应的桶中元素不为null，则进入下一步，不然返回null
        if ((tab = table) != null && (n = tab.length) > 0 && (p = tab[index = (n - 1) & hash]) != null) {
            Node<K,V> node = null, e; K k; V v;
            //若是桶中的第一项的hash和key值与给定的值相等，即第一项为要寻找的元素，则将其值赋值给node
            if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k))))
                node = p;
            //若是等一项不是要找的元素，且不仅它一个元素
            else if ((e = p.next) != null) {
            	//若是该桶的数据结构为红黑树，则在树上寻找该节点
                if (p instanceof TreeNode)
                    node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
                //若是该桶的数据结构为链表，则在链表中找到该节点
                else {
                    do {
                        if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k)))) {
                            node = e;
                            break;
                        }
                        p = e;
                    } while ((e = e.next) != null);
                }
            }
            //若是node不为null，说明找到了key值相等的节点，可是若是还须要对比值相等的话，则还要知足value值相等
            if (node != null && (!matchValue || (v = node.value) == value || (value != null && value.equals(v)))) {
            	//若是该桶的数据结构为红黑树，则从红黑树中删掉该节点
                if (node instanceof TreeNode)
                    ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
                //若是该桶的数据结构为链表，且要寻找的元素是该桶的第一项
                else if (node == p)
                    tab[index] = node.next;
                //若是该桶的数据结构为链表，且要寻找的元素不是该桶的第一项
                else
                    p.next = node.next;
                //HashMap的修改次数+1
                ++modCount;
                //HashMap的元素个数-1
                --size;
                //调用afterNodeRemoval方法，该方法HashMap没有任何实现逻辑，目的是为了让子类根据须要自行覆写
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }
}