HashMap

HashMap

基本属性

    /**
     * 默认初始容量，必须是2的幂// 默认16
     */
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

    /**
     * map最大容量
     */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * 默认负载因子.
     */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;


    /**
     * 判断是用树去存储还是用列表存储的阈值。如果链表数据大于这个值将转换成树存储。
     * 该值必须大于2且至少为8，以便从树转回列表
     */
    static final int TREEIFY_THRESHOLD = 8;

	/**
	* 当链表长度小于6是，则由树退化成链表
	*/
	static final int UNTREEIFY_THRESHOLD = 6;


    /**
     * 当hash表容量大于64时，才可以将链表转换成树
     */
    static final int MIN_TREEIFY_CAPACITY = 64;


    /**
     * table，在第一次使用时初始化，并根据需要调整大小
     */
    transient Node<K,V>[] table;

构造器

指定初始容量和负载因子构造器

    /**
     * 指定初始容量和负载因子
     */
    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);
    }

指定初始容量构造器

    /**
     * 指定初始容量，默认负载因子（0.75）
     */
    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }

无参构造器

 /**
 * 默认初始容量16，默认负载因子0.75
 */
 public HashMap() {
        this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
    }

指定Map构造器

    /**
     * 根据指定map生产hashmap
     */
    public HashMap(Map<? extends K, ? extends V> m) {
    	//负载因子设置成默认值 0.75f
        this.loadFactor = DEFAULT_LOAD_FACTOR;
        putMapEntries(m, false);
    }

    final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
    	//判断map大小
        int s = m.size();
        if (s > 0) {
        	//判断是否是一个空的散列表
            if (table == null) { // pre-size
            	//计算下一次扩容的临界值
                float ft = ((float)s / loadFactor) + 1.0F;
                //如果这个值小于数组最大容量，则截取该值。
                //如果这个值大于数组最大值，则取数组最大值
                int t = ((ft < (float)MAXIMUM_CAPACITY) ?
                         (int)ft : MAXIMUM_CAPACITY);
                //如果t大于扩容阈值（临界值），计算下一次扩容的阈值
                if (t > threshold)
                    threshold = tableSizeFor(t);
            }
            //判断传入的map的size是否大于threshold，如果是则需要扩容
            else if (s > threshold)
            	//扩容
                resize();
            //循环添加数据
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet()) {
                K key = e.getKey();
                V value = e.getValue();
				//有可能会有resize操作
                putVal(hash(key), key, value, false, evict);
            }
        }
    }


    /**
     * Implements Map.put and related methods.
     *
     * @param hash hash for key
     * @param key the key
     * @param value the value to put
     * @param onlyIfAbsent if true, don't change existing value
     * @param evict if false, the table is in creation mode.
     * @return previous value, or null if none
     */
    final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        //如果hash表是null或者长度为0，则调用resize方法进行扩容
        if ((tab = table) == null || (n = tab.length) == 0)
        	//把扩容之后的值赋值给n
            n = (tab = resize()).length;
         //找当前要插入的数据应该在哈希表中的位置,如果没找到,代表哈希表中当前的位置是空的,直接插入即可。否则就代表找到数据了, 并赋值给变量 p
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            Node<K,V> e; K k;
            //当hash值相等，且key和目标上的key相等，则表明是替换原值
            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);
                        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不是null，返回e的oldValue
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        //操作次数自增1
        ++modCount;
        //判断是否需要扩容
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

常用方法

put方法

    /**
     * 向map中添加新值。如果key存在则替换该值
     */
    public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

get方法

    /**
     * 返回指定的值，不存在返回null
     */
    public V get(Object key) {
        Node<K,V> e;
        return (e = getNode(hash(key), key)) == null ? null : e.value;
    }


    /**
     * Implements Map.get and related methods.
     *
     * @param hash hash for key
     * @param key the key
     * @return the node, or null if none
     */
    final Node<K,V> getNode(int hash, Object key) {
        Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
        //如果表为null，并且key的hash值在表中不存在，返回null
        if ((tab = table) != null && (n = tab.length) > 0 &&
            (first = tab[(n - 1) & hash]) != null) {
            //判单链表第一个元素是否为要查找的值（hash相同，并且key相同），如果是直接返回第一个节点
            if (first.hash == hash && // always check first node
                ((k = first.key) == key || (key != null && key.equals(k))))
                return first;
            //如果第一个节点不是想要查找的，对比其他节点
            if ((e = first.next) != null) {
            	//判断第一个节点是否为树节点，如果是按照树的方式查找，如果不是遍历链表。如果都没有查到返回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;
    }

remove方法

    /**
     * 根据key删除指定值
     */
    public V remove(Object key) {
        Node<K,V> e;
        return (e = removeNode(hash(key), key, null, false, true)) == null ?
            null : e.value;
    }

    /**
     * Implements Map.remove and related methods.
     *
     * @param hash hash for key
     * @param key the key
     * @param value the value to match if matchValue, else ignored
     * @param matchValue if true only remove if value is equal
     * @param movable if false do not move other nodes while removing
     * @return the node, or null if none
     */
    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;
        //如果表为null，并且key的hash值在表中不存在，返回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都相等，则该节点事要查找的节点，把p赋值给node
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                node = p;
            //如果当前节点不是要找的，判断链表是否还有其元素
            else if ((e = p.next) != null) {
            	//判断p是否为树节点，如果是按照树去查找，不是的话遍历链表
                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是否为空，并且是否与value相等
            if (node != null && (!matchValue || (v = node.value) == value ||
                                 (value != null && value.equals(v)))) {
                //判断node是否为树，如果是按照树的方法删除
                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;
                ++modCount;
                --size;
                afterNodeRemoval(node);
                return node;
            }
        }
        return null;
    }

resize方法

    /**
     * 初始化或者扩容（2倍）
     *
     * @return the table
     */
    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) {
        	//之前的容量大于0，并且大于数组最大容量，则把阈值设置为Integer最大值，并返回之前的表
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //如果扩容后（2倍）小于最大容量，并且之前的容量大于默认容量（16），则新的阈值等于之前阈值的二倍
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
       /**
	     * 从构造方法我们可以知道
	     * 如果没有指定initialCapacity, 则不会给threshold赋值, 该值被初始化为0
	     * 如果指定了initialCapacity, 该值被初始化成大于initialCapacity的最小的2的次幂
		 * 这里这种情况指的是原table为空，并且在初始化的时候指定了容量，
		 * 则用threshold作为table的实际大小
		*/
        else if (oldThr > 0) // initial capacity was placed in threshold
            newCap = oldThr;
        //构造方法中没有指定容量，则使用默认值
        else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        // 计算指定了initialCapacity情况下的新的 threshold
        if (newThr == 0) {
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;
        
	   /** 从以上操作我们知道, 初始化HashMap时, 
	    *  如果构造函数没有指定initialCapacity, 则table大小为16
	    *  如果构造函数指定了initialCapacity, 则table大小为threshold,
	    *  即大于指定initialCapacity的最小的2的整数次幂
	    
	    *  从下面开始, 初始化table或者扩容, 实际上都是通过新建一个table来完成
	    */ 
        @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);
                    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;
    }