Java中的容器（集合）之HashMap源码解析

1、hashmap源码解析（jdk8）

基础原理：

• 对比上一篇《java中的容器（集合）之arraylist源码解析》而言，本篇只解析hashmap常用的核心方法的源码。
• hashmap是一个以键值对存储的容器。
• hashmap底层实现为数组+链表+红黑树（链表超过8时转为红黑树，jdk7为数组+链表）。
• hashmap会根据key的hashcode得到对应的hash值，再去数组中找寻对应的数组位置（下标）。
• hash方法如下：

static final int hash(object key) {
        int h;
        //hashcode()返回散列值，这是object中的一个方法
        // ^ 按位异或，& 按位与，|按位或；&&逻辑与，||逻辑或
        // >>> 无符号右移
        return (key == null) ? 0 : (h = key.hashcode()) ^ (h >>> 16);
        }

hashmap的一些属性：

• 关于其中加载因子属性（default_load_factor ，loadfactor），主要是针对元素量而言，越大元素放的越多，空间利用率高，不过容易碰撞，查找时间多；越小元素放的越少，不容易碰撞，不过浪费空间，查找时间少。
• 关于threshold属性，它是hashmap的扩容标准，计算规则为容量*加载因子，比如默认情况为16*0.75=12，达到这个值的时候就会进行扩容（扩容操作比较耗费性能）。
• 源码及释义如下：

public class hashmap<k,v> extends abstractmap<k,v> implements map<k,v>, cloneable, serializable {
    // 序列号
    private static final long serialversionuid = 362498820763181265l;
    // 默认的初始容量，需为2的幂次方（为了减少哈希碰撞），<< 表示左移，运算规则为乘以2的n次方，1<<4=16
    static final int default_initial_capacity = 1 << 4;
    // 最大容量，如果由某个带参构造函数隐式的指定了更高的值，需为2的幂次方且小于1 << 30
    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;
    // 红黑树中对应的最小表容量应该最少为4*treeify_threshold，以避免在调整大小和红黑树阈值之间的冲突。
    static final int min_treeify_capacity = 64;
    // 在第一次使用的时候初始化表，且根据需要设置大小，分配的大小总是2的幂次方
    transient node<k,v>[] table;
    // 保存元素的集，需要注意的是，它使用的abstractmap字段是keyset()和values()。
    transient set<map.entry<k,v>> entryset;
    // 此映射中包含的键值映射数，键值是一个整体，不等于数组的长度（因为存在哈希碰撞之后的链表和红黑树）
    transient int size;
    // 每次扩容和更改map结构的计数器
    transient int modcount;
    // 下一个要调整大小的大小值（容量*加载因子）
    int threshold;
    // hash表的加载因子
    final float loadfactor;
}

静态内部类node：

• 源码及释义如下：

//静态内部类，实现了map.entry<k,v>接口
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;
    }
}

jdk8增加了树节点静态内部类用于红黑树：

• 部分源码及释义如下：

static final class treenode<k,v> extends linkedhashmap.entry<k,v> {
    treenode<k, v> parent;  // red-black tree links
    treenode<k, v> left;
    treenode<k, v> right;
    treenode<k, v> prev;    // needed to unlink next upon deletion
    boolean red; //判断是否为红

    treenode(int hash, k key, v val, node<k, v> next) {
        super(hash, key, val, next);
    }

    /**
     * 返回包含此节点的树的根节点
     */
    final treenode<k, v> root() {
        for (treenode<k, v> r = this, p; ; ) {
            if ((p = r.parent) == null)
                return r;
            r = p;
        }
    }
}

hashmap的构造器：

• 主要有四个，源码及释义如下：

    /**
     * 指定容量以及加载因子构造一个空的hashmap
     */
    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构造一个空的hashmap
     */
    public hashmap(int initialcapacity) {
        this(initialcapacity, default_load_factor);
    }

    /**
     * 以默认容量16以及默认加载因子0.75构造一个空的hashmap
     */
    public hashmap() {
        this.loadfactor = default_load_factor; // all other fields defaulted
    }

    /**
     * 以另一个map的键值对构造一个新的hashmap。新hashmap的容量最少足够存储旧hashmap的键值对数，加载因子为默认加载因子0.75
     */
    public hashmap(map<? extends k, ? extends v> m) {
        this.loadfactor = default_load_factor;
        putmapentries(m, false);
    }

• 其中第四个构造函数有用到putmapentries()这个方法，其源码如下：

    /**
     * 实现map.putall和map构造函数
     */
    final void putmapentries(map<? extends k, ? extends v> m, boolean evict) {
        int s = m.size();
        //判断m是否为空
        if (s > 0) {
            //判断table是否初始化
            if (table == null) { // pre-size
                //计算m的总容量，计算规则为使用容量/加载因子+1
                float ft = ((float)s / loadfactor) + 1.0f;
                //将m总容量与hashmap规定的最大容量相比得到最终容量
                int t = ((ft < (float)maximum_capacity) ?
                        (int)ft : maximum_capacity);
                //判断最终容量是否大于扩容阈值（扩容阈值计算规则：容量*加载因子）
                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);
            }
        }
    }

• 针对putmapentries()方法中的扩容操作，可以查看resize()方法，源码及释义如下：

    /**
     * 初始化表或者将表容量翻倍，如果为空则分配初始容量，否则以2的幂次方扩容，需要保持索引一致
     * @return
     */
    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;
            }
            //判断旧容量的两倍容量（左移表示乘以2的n次方）是否小于最大容量，且旧容量是否大于等于默认容量
            else if ((newcap = oldcap << 1) < maximum_capacity &&
                    oldcap >= default_initial_capacity)
                //扩容两倍
                newthr = oldthr << 1; // double threshold
        }
        //否则如果旧阈值大于0，则初始化容量设置为旧阈值
        else if (oldthr > 0) // initial capacity was placed in threshold
            newcap = oldthr;
        else {               // zero initial threshold signifies using defaults
            //否则新容量设置为默认容量（因为旧容量小于0）
            newcap = default_initial_capacity;
            //新阈值设置为默认容量乘以默认加载因子，即16*0.75
            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"})
        node<k,v>[] newtab = (node<k,v>[])new node[newcap];  //此方法返回的新table
        //如果旧table为空，则初始化
        table = newtab;
        //否则将旧table的值放入新table
        if (oldtab != null) {
            //旧table的值循环放入新table
            for (int j = 0; j < oldcap; ++j) {
                node<k,v> e;
                //判断当前节点是否有值
                if ((e = oldtab[j]) != null) {
                    //旧table节点置为空
                    oldtab[j] = null;
                    //如果该节点没有子节点，则返回新table，元素放入的位置为e的哈希值按位与（新容量-1）
                    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);
                        //旧索引放入table
                        if (lotail != null) {
                            lotail.next = null;
                            newtab[j] = lohead;
                        }
                        //新索引放入table
                        if (hitail != null) {
                            hitail.next = null;
                            newtab[j + oldcap] = hihead;
                        }
                    }
                }
            }
        }
        return newtab;
    }

• 关于put的源码及释义如下（对应原理可以查看《java中的容器（集合）》第七条）：

    //put元素到map中
    public v put(k key, v value) {
        //实际调用的是putval()方法
        return putval(hash(key), key, value, false, true);
    }

    //putval()方法用于实际操作插入元素
    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未初始化，调用resize()进行扩容（使用的都是默认值）
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        //判断(n - 1) & hash]索引处的table是否为空，为空，则插入新节点（table为空，此时插入的节点是在数组中）
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newnode(hash, key, value, null);
        //table不为空
        else {
            node<k,v> e; k k;
            //判断节点的hash以及key是否相等，是则覆盖。
            if (p.hash == hash &&
                    ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            //否则如果属于树节点，使用puttreeval插入节点数据（puttreeval是针对红黑树的putval方法），有兴趣的可以看一下puttreeval方法
            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);
                        //如果大于规则节点数（8），则转为红黑树存储
                        if (bincount >= treeify_threshold - 1) // -1 for 1st
                            treeifybin(tab, hash);
                        //跳出循环
                        break;
                    }
                    //判断插入元素与链表中原有元素的hash以及key是否相等
                    if (e.hash == hash &&
                            ((k = e.key) == key || (key != null && key.equals(k))))
                        //相等，跳出循环
                        break;
                    //循环链表
                    p = e;
                }
            }
            //存在键值对的key
            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;
    }

• 关于get的源码及释义如下：

    //通过指定key从map中get值
    public v get(object key) {
        node<k,v> e;
        //实际调用的是getnode()方法
        return (e = getnode(hash(key), key)) == null ? null : e.value;
    }

    //getnode()方法用于实际操作查询元素值
    final node<k,v> getnode(int hash, object key) {
        node<k,v>[] tab; node<k,v> first, e; int n; k k;
        //判断存在table是否初始化
        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) {
                //如果属于红黑树，则调用红黑树中的gettreenode方法查询，有兴趣的可以看一下gettreenode方法
                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;
    }

 （以上所有内容皆为个人笔记，如有错误之处还望指正。）