HashMap的源码查看

HashMap是常见的,以K-V存储的数据结构.

在看源码之前，先需要了解HashMap的结构情况，前面的代码中也可以看到主体数据是由Node<K,V>组成的数组构成，而Node还有指向下一节点的指针，参考下图：

Node节点

首先看到hashmap中的node类继承了map.Entry<k,v>结构，有类型为K的key和类型为V的value；其次node是一个单链表结构。

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

HashMap源码

基本属性

/* 实际上结构就是一个类型为Node的数组,使用transient 防止对整个table全部序列化 */
transient Node<K,V>[] table;

/**
 * Holds cached entrySet(). Note that AbstractMap fields are used
 * for keySet() and values().
 * 得到entryset
 */
transient Set<Map.Entry<K,V>> entrySet;

/**
 * The number of key-value mappings contained in this map.
   map的大小
 */
transient int size;

/* 操作次数 */
transient int modCount;

/* 阈值，如果超过临界值就会自动扩充数组 */
int threshold;

/* 加载因子  */
final float loadFactor;

hashMap的三个构造方法

/* 第一个参数 是默认的初始化阈值大小，第二个是加载因子大小 */
public HashMap(int initialCapacity, float loadFactor) {
    if (initialCapacity < 0)
    /* 如果制定的初始化阈值小于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);
}

/* 使用this调用上面的方法 */
public HashMap(int initialCapacity) {
    this(initialCapacity, DEFAULT_LOAD_FACTOR);
}

/**
 * 使用默认的阈值和因子，大小分别为16和0.75
 * Constructs an empty <tt>HashMap</tt> with the default initial capacity
 * (16) and the default load factor (0.75).
 */
public HashMap() {
    this.loadFactor = DEFAULT_LOAD_FACTOR; // all other fields defaulted
}

hashMap的方法源码

在大致了解完HashMap的结构后，通过查看put方法，来分析元素是如何放到这种结构中的。大致步骤可以参考下图：

put方法

public V put(K key, V value) {
  /* 调用putVal方法 */
    return putVal(hash(key), key, value, false, true);
}
/**
 * Implements Map.put and related methods
 *
 * @param hash hash for key key的hash码
 * @param key the key key值
 * @param value the value to put value值
 * @param onlyIfAbsent if true, don't change existing value 如果是true 不改变当前值
 * @param evict if false, the table is in creation mode. 如果是false，那么table就属于创建模式 （？）
 * @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;
    /* 当Map为空的时候  这时候tab为16也就是n为16*/
    /* 这是当map中的内容为空的时候
     * newCap = DEFAULT_INITIAL_CAPACITY;
     * newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
    */
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;
    /* 如果当前tab的length&hash值再tab列表中不重复 */
    if ((p = tab[i = (n - 1) & hash]) == null)
    /* 新建一个noede 再tab[i]的位置上 */
        tab[i] = newNode(hash, key, value, null);
    else {
        Node<K,V> e; K k;
        /* 当添加重复的key的时候 这时候hash和key的值都相等，就相当于不添加 */
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            e = p;
        else if (p instanceof TreeNode)
        /* 如果e是treeNode的时候  */
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            for (int binCount = 0; ; ++binCount) {
                if ((e = p.next) == null) {
                // 将新值添加到p的后面
                    p.next = newNode(hash, key, value, null);
                    if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                    /* 如果当前列表中的长度大于等于 8-1 的时候，把这个列表整理成树形结构 */
                        treeifyBin(tab, hash);
                    break;
                }
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                p = e;
            }
        }
        if (e != null) { // existing mapping for key
            V oldValue = e.value;
            if (!onlyIfAbsent || oldValue == null)
                e.value = value;
            afterNodeAccess(e);
            return oldValue;
        }
    }
    ++modCount;
    /* 如果当前size大于threshold的时候扩充table */
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

在看get方法之前先看和put方法息息相关的resize方法

如果 hash&length-1 的值重复的话，说明位置冲突，首先会添加在这个位置元素后面，如果大小超过 TREEIFY_THRESHOLD - 1 的时候自动为这列整理成树形状。这样就会变为数组和横向列表或树的组合结构。

在未重复hash的前提下，如果table的大小超过设置的 threshold 的大小的时候，就会触发 resize 方法。在resize时会将HashMap中的所有元素进行重新排列，以便与防治分布不均匀的情况发生。下面就来看看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;
            } //newcap是oldcap的2倍
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold
        }
        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);
        }
        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) {
        //循环原table数组 ？因为在扩容后 hash & (size-1) 的位置发生了变化 ，所以应当进行重排
            for (int j = 0; j < oldCap; ++j) { 
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
                    if (e.next == null)//说明e不存在hash冲突
                        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 { //再去循环bin
                            next = e.next;
                            if ((e.hash & oldCap) == 0) { //如果在低位 （老）数组中也就是元素hast和就数组取模为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; //高位数组在旧数组+j的位置上
                        }
                    }
                }
            }
        }
        return newTab;
    }

get方法

get方法是根据hash和key值进行查找,同理containKey方法也是调用getNode方法进行判断。

public V get(Object key) {
    Node<K,V> e;
    return (e = getNode(hash(key), key)) == null ? null : e.value;
}

final Node<K,V> getNode(int hash, Object key) {
    Node<K,V>[] tab; Node<K,V> first, e; int n; K k;
    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 {
              /* 从第二个节点开始循环 查找hash和key分别相同  */
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    return e;
            } while ((e = e.next) != null);
        }
    }
    return null;
}

remove方法

使用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 key的hash值
 * @param key 键值
 * @param value 如果想匹配的话就是value，否则空
 * @param matchValue 如果是ture那么就移除和value equal的
 * @param movable 如果是false的话，移除这个节点不要移动其他节点
 * @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;
    /* 确定节点 */
    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值也相同 说明就是这个节点 */
        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 {
                    /* 省略-------- */
                } while ((e = e.next) != null);
            }
        }
        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);
                /* 接下来把tab中对应的index remove掉 */
            else if (node == p)
                tab[index] = node.next;
            else
                p.next = node.next;
            ++modCount;
            --size;
            afterNodeRemoval(node);
            return node;
        }
    }
    return null;
}

keySet方法

ketSet方法也是经常用到的方法，keySet方法实际上就是返回新建的keyset结构。具体结构可以看如下代码，可以看到只有使用forEach和Iterator方法的时候才会循环tab来找key的set数据。数据结构中都是调用外部方法的方法。

final class KeySet extends AbstractSet<K> {
    public final int size()                 { return size; } //返回当前size
    public final void clear()               { HashMap.this.clear(); } //直接调用hashMap的clear方法
    public final Iterator<K> iterator()     { return new KeyIterator(); }
    public final boolean contains(Object o) { return containsKey(o); }
    public final boolean remove(Object key) {
        return removeNode(hash(key), key, null, false, true) != null;
    }
    public final Spliterator<K> spliterator() {
        return new KeySpliterator<>(HashMap.this, 0, -1, 0, 0);
    }
    public final void forEach(Consumer<? super K> action) {
        Node<K,V>[] tab;
        if (action == null)
            throw new NullPointerException();
        if (size > 0 && (tab = table) != null) {
            int mc = modCount;
            /* 把当前操作数记下来  */
            for (int i = 0; i < tab.length; ++i) {
                for (Node<K,V> e = tab[i]; e != null; e = e.next)
                    action.accept(e.key);
            }
            if (modCount != mc)
                throw new ConcurrentModificationException();
        }
    }
}

这是几个非常常用的hashMap的方法和基本的数据结构源码的分析查看。就当做笔记记录一下。