源码阅读系列——基础篇(HashMap 集合源码分析)

HashMap是一种插入、查询效率都较高的集合,我们看一下他是如何实现的。首先我们以插入数据来看一下源码:

1、类定义

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable {
     transient Node<K,V>[] table;  // table数组
    transient Set<Map.Entry<K,V>> entrySet;  // 元素集合
    transient int size;   // 当前hashmap的真实元素数量
    transient int modCount;  // 修改次数,fast-fail机制关键字
    int threshold; // 阈值
    final float loadFactor; // 阈值因子,hashmap的扩容方式跟List的那些实现不太一样,他是通过一个设定的阈值,来判断何时扩容的,这种扩容方式,可以一定程度上减少元素的碰撞(后面会解释碰撞)
 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);
    }

    public HashMap(int initialCapacity) {
        this(initialCapacity, DEFAULT_LOAD_FACTOR);
    }
    }

2、插入数据

// 获取对象的hash值,至于什么hashcode,见注1
static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}
public V put(K key, V value) {
    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; // node节点解释见注2
    if ((tab = table) == null || (n = tab.length) == 0) // table为空,则创建table并初始化大小
        n = (tab = resize()).length; // resize函数就是包含了扩容和初始化,我们后面在单独说
    if ((p = tab[i = (n - 1) & hash]) == null)  // 如果原table位置没有节点,则直接新建一个节点,并赋值。(n - 1) & hash实际就是hash值/16取余,只是通过位运算书写
        tab[i] = newNode(hash, key, value, null);
    else { 
        // 如果原位置有节点
        Node<K,V> e; K k;
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            // 如果元素一样,直接赋值
            e = p;
        else if (p instanceof TreeNode)
            // 如果table当前位置的元素有节点,且为树type,详见putTreeVal解释
            e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
        else {
            // 如果table当前位置的元素有节点,且不为树type
            for (int binCount = 0; ; ++binCount) {
                if ((e = p.next) == null) {
                   // 遍历当前节点的next元素,实际上每一个节点都是一个链表,实际就是遍历到当前节点的尾部,并将生成节点,加入到链表尾部。
                    p.next = newNode(hash, key, value, null);
                    if (binCount >= TREEIFY_THRESHOLD - 1) // 如果链表的长度超过了TREEIFY_THRESHOLD,默认值为8,则转换为树结构
                        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;
    if (++size > threshold)
        resize();
    afterNodeInsertion(evict);
    return null;
}

1、从插入元素的过程来看,我们可以发现,每个元素存入时,会根据hash值除以容量的余数,作为index,存在table数组中,如果发现table数组中对应index有元素table[index],则设置为table[index]所在链表的尾结点(或者是所在树的尾元素中),链表的方式,上段代码已经给出,至于树的方式,我们看后面的putTreeVal方法解释。
2、所以我们可以理解table数组中的元素,实际就是一个链表或者树。
3、这种方式的时间负责度,很低,以链表为例,比如取元素,好的情况下O(1),当然如果某一个链表非常长,那最差的情况就是O(n)。所以这边就讲到一个碰撞,什么是碰撞,很简单,就是很多元素,在hash值取余之后相等,这样就会频繁的遍历链表。而我们减少碰撞最好的途径当然是自己设定hashcode的取值方式,这样可以减少碰撞。当然合理的阈值因子loadFactor,也可以减少table本身的拥挤程度,已减少碰撞。
4、从上面的流程也能够看出来,当对应index下,没有元素的时候,创建的实际是Node元素,这个元素参考注2,可以看到其实就是链表的方式,而当我们增加元素的过程中,如果发现链表长度大于了阈值TREEIFY_THRESHOLD(默认为8),才会进行树结构转变。

注1:什么是hashcode,我们看一下java的Object就包含了

@Override
	public int hashCode() {
	}

这个方法是通过运行时对象内存地址计算得到的,所以每个对象的hash值是唯一的,而我们也可以定制修改方法,比如String,他就自己改写了hash方法

public int hashCode() {
    int h = hash;
    final int len = length();
    if (h == 0 && len > 0) {
        for (int i = 0; i < len; i++) {
            h = 31 * h + charAt(i);
        }
        hash = h;
    }
    return h;
}

可以看到他的值跟他包含的字符有关,所以,如果两个子串equals的话,他也是一样的。
注2:看一下Node的实现:

static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;  // 对应的hash值
        final K key;  // 对应的key值
        V value;  // 对应key的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;
        }
    }

从node的数据结构可以看出来,它包含了在我们map的key value对,还包含了一个next的node元素,所以实际上node可以理解为一个链表的节点,通过的这个节点,我们可以遍历到他后面的所有元素。

3、树的建立和元素增加

前面我们讲到,默认table中元素其实是一个链表,当大于阈值的时候,才设为了树结构,转换树结构的函数:

 final void treeifyBin(Node<K,V>[] tab, int hash) {
        int n, index; Node<K,V> e;
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
        // 如果当前table的长度小于MIN_TREEIFY_CAPACITY(64),则首先扩容,不转换为树结构
            resize(); 
        else if ((e = tab[index = (n - 1) & hash]) != null) {
            TreeNode<K,V> hd = null, tl = null;
            do {
                // 转换当前节点的头节点为树节点,并且按照链表里的顺序建立节点之间的pre和next关系
                TreeNode<K,V> p = replacementTreeNode(e, null);
                if (tl == null)
                    hd = p;
                else {
                    p.prev = tl;
                    tl.next = p;
                }
                tl = p;
            } while ((e = e.next) != null);
            if ((tab[index] = hd) != null)
                hd.treeify(tab);  // 生成树结构
        }
    }

看一下生成树结构的函数

final void treeify(Node<K,V>[] tab) {
            TreeNode<K,V> root = null;
            for (TreeNode<K,V> x = this, next; x != null; x = next) {
                next = (TreeNode<K,V>)x.next;
                x.left = x.right = null;
                if (root == null) {
                    x.parent = null;
                    x.red = false;
                    root = x;
                }
                else {
                    K k = x.key;
                    int h = x.hash;
                    Class<?> kc = null;
                    for (TreeNode<K,V> p = root;;) {
                        int dir, ph;
                        K pk = p.key;
                        if ((ph = p.hash) > h)
                            dir = -1;
                        else if (ph < h)
                            dir = 1;
                        else if ((kc == null &&
                                  (kc = comparableClassFor(k)) == null) ||
                                 (dir = compareComparables(kc, k, pk)) == 0)
                            dir = tieBreakOrder(k, pk);

                        TreeNode<K,V> xp = p;
                        if ((p = (dir <= 0) ? p.left : p.right) == null) {
                            x.parent = xp;
                            if (dir <= 0)
                                xp.left = x;
                            else
                                xp.right = x;
                            root = balanceInsertion(root, x);
                            break;
                        }
                    }
                }
            }
            moveRootToFront(tab, root);
        }

实际上就是一个红黑树的过程,并且会将table原有index的元素,替换为红黑平衡树的root节点。
至于红黑树的理解,本篇先不做介绍。

4、Resize函数

resize函数包含两种值,一种是当前table的容量cap,也就是当前table的真实长度(数组长度,并不是数组包含的非空元素数量),他可以包含未初始化的空元素。一种是阈值threshold,阈值顾名思义,就是当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;
        if (oldCap > 0) {
            // 如果容量之前初始化过
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            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
            // 如果均为初始化过,容量设为默认值16,阈值设为0.75 *16
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
        if (newThr == 0) {
            // 如果阈值为0,重新设置一下阈值,保证阈值与容量的比例关系
            float ft = (float)newCap * loadFactor; // loadFactor默认是0.75,可通过初始化改变
            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) { //遍历当前table中所有的值
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {
                    oldTab[j] = null;
                    if (e.next == null)  // 如果当前节点没有next
                        newTab[e.hash & (newCap - 1)] = e; // 取余的方式,存储数据,因为容量的递增方式是翻倍,故而总是初始值16的倍数,这种方式,实际上就变成了除以容量取余了
                    else if (e instanceof TreeNode) // 如果节点已经变成红黑树节点
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { // preserve order
                        // 重新将原链表元素排序,并设置到新的table中
                        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) { // 如果节点位置不变,则直接将链表放在原位置,位置不变的值等于oldcap * 2n + j,所以一定满足上面的位运算
                                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; // 原位置不变,原位置不变的参数是什么,就是等于oldcap * 2n + j
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead; // 位置变化,就是oldcap * (2n+1) + j , 那么他整除的余数就是oldcap+j。
                        }
                    }
                }
            }
        }
        return newTab;
    }

5、总结

从整个代码阅读发现,HashMap是一个查找,存储都很快的集合,并且再数据非常庞大的时候,仍然拥有很好的读写性能。这一点可以弥补我们前面讲过的List集合的一些缺点,当然我们发现HashMap是一种键值对的存储方式,所以对于有键值对的应用场景,是非常适用的。
实际上List也是可以转换为HashMap的实现方式,即HashMap就可以类比ArrayList,Integer就表示ArrayList的index,但是我们要针对场景去使用,比如我们没有频繁的插入行为,那ArrayList实际上性能肯定是要好于HashMap的,毕竟计算Integer的hashcode是存在函数调用的,而且遇到碰撞还需要遍历链表。

你可能感兴趣的:(java,android)