HashMap源码核心方法简单分析

HashMap源码分析

介绍

层次关系

public class HashMap<K,V> extends AbstractMap<K,V>
    implements Map<K,V>, Cloneable, Serializable

HashMap类继承了抽象类AbstractMap，实现了Map接口。

基本思想

HashMap的底层实现基于数组+链表+红黑树。

类属性

// 默认的初始哈希表容量
static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

// 哈希表容量的允许的最大值
static final int MAXIMUM_CAPACITY = 1 << 30;

// 默认的装载因子
static final float DEFAULT_LOAD_FACTOR = 0.75f;

// 从链表进化为红黑树的所需的最少节点个数
static final int TREEIFY_THRESHOLD = 8;

// 从红黑树退化为链表的节点个数
static final int UNTREEIFY_THRESHOLD = 6;

// 从链表转进化为红黑树所需的最小的哈希表容量
static final int MIN_TREEIFY_CAPACITY = 64;

基本结构

Node

static class Node<K,V> implements Map.Entry<K,V> {
  final int hash;  // key的hash值，
  final K key;     // key
  V value;         // value
  Node<K,V> next;  // next Node

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

hash函数

static final int hash(Object key) {
  int h;
  // 如果key为null，hash值为0，否则：key的hashCode结果的高16位与低16位做异或运算。
  return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

核心方法分析

初始化

// 第一种初始化：指定数组初始容量和加载因子
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);// ?
}

// tableSizeFor方法：对于给定的capacity，返回不小于它的2的幂次的新的capacity
// 比如：给定5-8会返回8，给定9-16会返回16，给定17-32会返回32。
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;
}

// 方法二：指定数组初始容量，使用默认装载因子，调用方法一构造一个空的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构造，先使用方法三构造，在将Map保存到HashMap中
public HashMap(Map<? extends K, ? extends V> m) {
  this.loadFactor = DEFAULT_LOAD_FACTOR;
  putMapEntries(m, false);
}

// putMapEntries方法：批量插入元素
final void putMapEntries(Map<? extends K, ? extends V> m, boolean evict) {
  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);
      if (t > threshold)
        threshold = tableSizeFor(t);
    }
    else if (s > threshold)  // 如果m元素数量大于阈值，需要扩容
      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);
    }
  }
}

插入元素put

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;  // key对应的数组下标所在的首个节点元素
  int n;  // 哈希表容量，数组长度
  int i;  // key对应的数组下标
  // 步骤一：预计算：如果原来的哈希表为空，新哈希表的长度为扩容后的长度
  if ((tab = table) == null || (n = tab.length) == 0)
    n = (tab = resize()).length;
  
  // 分支1：如果key的哈希值对应的数组下标所在的元素为空，直接构建新的节点插入即可
  if ((p = tab[i = (n - 1) & hash]) == null)
    tab[i] = newNode(hash, key, value, null);
  else {  // 分支2：如果key对应的数组下标存储不为空
    Node<K,V> e;  // 根据传入的key找到的节点
    K k;  // 首个节点元素的key
    // 分支2.1：如果传入的key与首个节点元素的key相等，则首个节点元素即为找到的节点
    if (p.hash == hash && ((k = p.key) == key || (key != null && key.equals(k))))
      e = p;
    else if (p instanceof TreeNode)  // 分支2.2：如果是红黑树，使用相应的方法找到节点
      e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
    else {  // 分支2.3：头结点不是要找的节点&链表结构：遍历链表
      for (int binCount = 0; ; ++binCount) {
        // 分支2.3.1：如果遍历完链表都没有找到，在链表末尾插入新的节点
        if ((e = p.next) == null) {
          p.next = newNode(hash, key, value, null);
          // 如果插入新的结点后，当前链表长度大于树化的阈值，对链表进行树化转变为红黑树结构
          if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
            treeifyBin(tab, hash);
          break;
        }
        // 分支2.3.2：如果遍历链表过程中找到了对应结点，中断遍历，此时结点e为找到的节点
        if (e.hash == hash && ((k = e.key) == key || (key != null && key.equals(k))))
          break;
        p = e;  // 通过移动p指针来遍历链表
      }
    }
    // 找到结点之后的赋值操作
    // 分支2.3.1插入了新的结点同时进行了赋值，其余分支都是修改了原来的结点值
    if (e != null) { // existing mapping for key
      V oldValue = e.value;
      if (!onlyIfAbsent || oldValue == null)
        e.value = value;
      afterNodeAccess(e);
      return oldValue; // 对于修改了原有结点值的情况，返回原来的值，且修改次数modCount和哈希表元素数量size都不变
    }
  }
  // 只有对于分支2.3.1的情况，有新的结点插入，修改次数加一，元素个数加一，可能需要扩容，且原来的值为null。
  ++modCount;
  if (++size > threshold)
    resize();
  afterNodeInsertion(evict);
  return null;
}

哈希表扩容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;  // 初始化新哈希表的容量和扩容阈值为0
  
  // 步骤一：计算新的哈希表的容量和扩容阈值
  // 1.1 如果原来的哈希表不为空
  if (oldCap > 0) {
    // 1.1.1 如果原来的哈希表的容量已经不小于允许的最大容量，则无法进行扩容
    if (oldCap >= MAXIMUM_CAPACITY) {
      threshold = Integer.MAX_VALUE;
      return oldTab;
    } // 1.1.2 新哈希表容量翻倍，扩容阈值翻倍
    else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY && oldCap >= DEFAULT_INITIAL_CAPACITY)
      newThr = oldThr << 1; // double threshold
  } // 1.2 如果旧哈希表为空但是其扩容阈值大于0（？），则新哈希表的容量等于就哈希表的扩容阈值。
  else if (oldThr > 0) // initial capacity was placed in threshold
    newCap = oldThr;
  else { // 1.3 旧哈希表为空&&扩容阈值为0（旧哈希表使用无参构造且没有执行其他任何操作），使用默认值
    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"})
  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;  // 删除旧哈希表的结点便于JVM的GC
        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 { // 情况三：如果当前的桶是链表，将链表拆分为两个新链表，插入到新哈希表的对应桶中
          Node<K,V> loHead = null, loTail = null;  // 旧哈希表当前bin的链表拆分后的头结点和尾结点（低位）
          Node<K,V> hiHead = null, hiTail = null;  // 旧哈希表当前bin的链表拆分后的头结点和尾结点（高位）
          Node<K,V> next;
          // 步骤1：对于链表中的每个结点，判断在新哈希表中的位置，据此构建两个链表
          do {
            next = e.next;
            if ((e.hash & oldCap) == 0) {  // 与旧哈希表中的位置相等
              if (loTail == null)  // 用head指向第一个结点
                loHead = e;
              else
                loTail.next = e;
              loTail = e;  // tail始终指向最后一个结点
            }
            else {  // ((e.hash & oldCap) == 1)，新的位置=旧的位置+旧哈希表的容量
              if (hiTail == null)
                hiHead = e;
              else
                hiTail.next = e;
              hiTail = e;
            }
          } while ((e = next) != null);
          // 步骤2：将两个链表分别插入到新哈希表中去
          if (loTail != null) {
            loTail.next = null; // 对于新哈希表中的链表，需要使其尾结点的next指向null
            newTab[j] = loHead;
          }
          if (hiTail != null) {
            hiTail.next = null;
            newTab[j + oldCap] = hiHead;
          }
        }
      }
    }
  }
  return newTab;
}

哈希表取值get

// 给定key，获取在哈希表中的值
public V get(Object key) {
  Node<K,V> e;
  return (e = getNode(hash(key), key)) == null ? null : e.value;
}

// hash函数：给定key，使用key的hashCode方法结果的高16位和低16位做异或运算得到
static final int hash(Object key) {
  int h;
  return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}

final Node<K,V> getNode(int hash, Object key) {
  Node<K,V>[] tab; 
  Node<K,V> first, e; 
  int n; K k;
  // 哈希表存在且不为空，key所在的bin不为空
  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)  // 如果bin为红黑树结构，调用相应的方法
        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;
}

删除remore方法

// 给定key，删除哈希表中的对应结点，返回删除的结点值
public V remove(Object key) {
  Node<K,V> e;
  return (e = removeNode(hash(key), key, null, false, true)) == null ? null : e.value;
}

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;
  
  // 哈希表存在且不为空，key所在的bin不为空
  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;
    // 步骤一：找到待删除的结点
    // 情况一：如果第一个结点即为要找的结点
    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);
      }
    }
    // 步骤二：删除对应结点
    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;
      ++modCount;
      --size;
      afterNodeRemoval(node);
      return node;
    }
  }
  return null;
}

元素替换replace

// 将哈希表中的键等于key、值等于oldValue的结点的值更新为newValue
// 返回是否更新成功（即输入的key:oldValue是否存在）
public boolean replace(K key, V oldValue, V newValue) {
  Node<K,V> e; V v;
  if ((e = getNode(hash(key), key)) != null &&
      ((v = e.value) == oldValue || (v != null && v.equals(oldValue)))) {
    e.value = newValue;
    afterNodeAccess(e);
    return true;
  }
  return false;
}

// 将哈希表中的键等于key的结点（不论原来的value是什么）的值更新为value
// 返回key对应的原来的value
public V replace(K key, V value) {
  Node<K,V> e;
  if ((e = getNode(hash(key), key)) != null) {
    V oldValue = e.value;
    e.value = value;
    afterNodeAccess(e);
    return oldValue;
  }
  return null;
}