Bootstrap

缓存之美:从根上理解 ConcurrentHashMap

缓存之美:从根上理解 ConcurrentHashMap

本文将详细介绍 ConcurrentHashMap 构造方法、添加值方法和扩容操作等源码实现。ConcurrentHashMap 是线程安全的哈希表,此哈希表的设计主要目的是在最小化更新操作对哈希表的占用,以保持并发可读性,次要目的是保持空间消耗与 HashMap 相同或更好,并支持利用多线程在空表上高效地插入初始值。在 Java 8 及之后的版本,使用 CAS 操作synchronized 关键字、合适的 自旋重试volatile关键字(保证可见性和禁止指令重排)来保证并发安全,并对节点进行了优化:采用了链表和红黑树的实现,在链表节点数量大于等于 8 且数组(在后文中会称每个元素位置为桶)大小大于等于 64 时会转变为红黑树,在扩容逻辑中,当树节点小于等于 6 时又会转换成链表(删除逻辑中链表转换红黑树的逻辑并不严格按照大小为 6 的阈值),优化空间利用并提高查询效率。它的默认大小为 16,负载因子为 0.75F,负载因子不支持指定其他值,这是与 HashMap 的不同点,在讲解构造方法的源码时,会提到这一点,大家需要留意,接下来步入正文:

构造方法

首先我们来看它的构造方法,重点关注注释信息:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {
    private transient volatile int sizeCtl;

    private static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * 构造方法,其他构造函数最终都会调用该方法,但实际上在构造方法中并没有完成初始化
     * 
     * @param initialCapacity  指定初始化大小
     * @param loadFactor       负载因子,注意该值并没有被任何字段记录下来,而是只参与了 size 的计算
     * @param concurrencyLevel 指定并发线程数,用于校正大小
     */
    public ConcurrentHashMap(int initialCapacity, float loadFactor, int concurrencyLevel) {
        if (!(loadFactor > 0.0f) || initialCapacity < 0 || concurrencyLevel <= 0)
            throw new IllegalArgumentException();
        // 如果指定的并发线程数大于初始化容量,那么以并发线程数为准
        if (initialCapacity < concurrencyLevel)
            initialCapacity = concurrencyLevel;
        long size = (long) (1.0 + (long) initialCapacity / loadFactor);
        int cap = (size >= (long) MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : tableSizeFor((int) size);
        this.sizeCtl = cap;
    }

    // 向上取整 2 的n次幂
    private static final int tableSizeFor(int c) {
        // Integer.numberOfLeadingZeros(c - 1) 用于计算 c-1 的二进制表示中最高位 1 之前有多少个 0
        // -1 的二级制表示为 11111111111111111111111111111111(32个1),无符号右移则会得到某 2的n次幂-1 的结果
        int n = -1 >>> Integer.numberOfLeadingZeros(c - 1);
        // 限制最大值的同时,结果永远为 2 的 n 次幂
        return (n < 0) ? 1 : (n >= MAXIMUM_CAPACITY) ? MAXIMUM_CAPACITY : n + 1;
    }
    
}

负载因子 loadFactor 作为局部变量计算完 size 后,并没有被记录下来,后续有关该值的逻辑,如扩容阈值的计算均使用了默认值 0.75F。这么做的原因在源码 JavaDoc 中有详细的解释:

理想情况下,容器中的节点遵循泊松分布,一个桶中有 k 个元素的概率分布如下:

0:0.60653066

1:0.30326533

2:0.07581633

3:0.01263606

4:0.00157952

5:0.00015795

6:0.00001316

7:0.00000094

8:0.00000006

更多:不到千万分之一

在随机散列下,两个线程访问不同元素的锁争用概率约为 1 / (8 * 元素数量)。

在负载因子为 0.75F 时,能够较好的防止多个元素发生碰撞,在随机散列的情况下,多线程发生锁争抢的概率较低。

ConcurrentHashMap#tableSizeFor 方法计算结果会将数组大小固定为 2 的 n 次幂,这样做是为了 提高性能和简化实现,以下为详细解释:

  1. 位运算优化:当哈希表的大小是 2 的 n 次幂时,可以使用位运算来代替取模运算(%),从而提高哈希表操作的性能。比如计算某元素在数组中的位置,index = hash % table.length 可以简化为 index = hash & (table.length - 1),位运算 & 通常比取模运算更快
  2. 哈希分布均匀性:2 的 n 次幂减 1 的 2 进制表示中低位均为 1,哈希值与它进行位与计算可直接获取索引值,这样可以减少哈希冲突的概率,使分布更加均匀
  3. 简化扩容逻辑:在扩容时,直接指定新表的大小是旧表的两倍(也是 2 的 n 次幂),元素的重新分配变得更加简便,要么元素的位置要么保持不变,要么移动到新位置 index + oldCapacity,这种移动逻辑可以通过简单的位运算实现

put 方法

put 方法是核心方法,需要重点关注添加值时使用到的 CAS + synchronized 的同步机制。更新元素计数的 addCount 方法采用了非常巧妙的实现,后文中我们会详细介绍。除此之外,扩容操作也会专门进行说明,它协调多线程共同完成扩容的解决方案也很值得学习,这些内容掌握之后,ConcurrentHashMap 中也再没有更难的内容。我们以 put 为切入点,重点关注注释信息:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {

    static final int TREEIFY_THRESHOLD = 8;

    // 最高位为 0,其余位为 1
    static final int HASH_BITS = 0x7fffffff;

    private static final int DEFAULT_CAPACITY = 16;
    
    transient volatile Node<K,V>[] table;

    private transient volatile int sizeCtl;
    
    public V put(K key, V value) {
        return putVal(key, value, false);
    }
    
    final V putVal(K key, V value, boolean onlyIfAbsent) {
        // key 和 value 均不能为 null
        if (key == null || value == null) throw new NullPointerException();
        // hash 扰动,用于使 hash 结果均匀分布
        int hash = spread(key.hashCode());
        int binCount = 0;
        for (Node<K,V>[] tab = table;;) {
            Node<K,V> f; int n, i, fh; K fk; V fv;
            // 懒加载实现初始化
            if (tab == null || (n = tab.length) == 0)
                tab = initTable();
            // 如果元素 hash (数组大小 - 1 & hash)到桶的位置没有元素(为 null)
            else if ((f = tabAt(tab, i = (n - 1) & hash)) == null) {
                // 通过 CAS 操作直接将元素放到该位置
                if (casTabAt(tab, i, null, new Node<K,V>(hash, key, value)))
                    break;
            }
            // 扩容相关逻辑,后续再讲解
            else if ((fh = f.hash) == MOVED)
                tab = helpTransfer(tab, f);
            // onlyIfAbsent 是入参,默认为 false,表示键不存在时才插入新值,否则相同键值不能覆盖
            // 该逻辑满足在此特定条件下,避免获取锁,从而提高性能
            else if (onlyIfAbsent && fh == hash && ((fk = f.key) == key || (fk != null && key.equals(fk))) && (fv = f.val) != null)
                return fv;
            // 执行到此处意味着该元素 hash 到的桶位置存在元素,需要追加到此处的链表或红黑树上,f 为该桶位置的第一个元素
            else {
                V oldVal = null;
                // 锁住第一个元素
                synchronized (f) {
                    // 校验此处元素并没有发生变更(类似单例模式的双重检测锁机制)
                    if (tabAt(tab, i) == f) {
                        // 头节点的 hash 值大于 0,说明是链表
                        if (fh >= 0) {
                            binCount = 1;
                            // 注意这里会对链表中元素数量进行累加
                            for (Node<K,V> e = f;; ++binCount) {
                                K ek;
                                // 如果发现了 key 值相同的元素,根据 onlyIfAbsent 字段判断是否需要覆盖
                                if (e.hash == hash && ((ek = e.key) == key || (ek != null && key.equals(ek)))) {
                                    oldVal = e.val;
                                    if (!onlyIfAbsent)
                                        e.val = value;
                                    break;
                                }
                                // 直到找到链表的尾巴节点,进行添加(尾插法)
                                Node<K,V> pred = e;
                                if ((e = e.next) == null) {
                                    pred.next = new Node<K,V>(hash, key, value);
                                    break;
                                }
                            }
                        }
                        // 如果该元素是红黑树
                        else if (f instanceof TreeBin) { 
                            Node<K,V> p;
                            binCount = 2;
                            // 调用红黑树添加元素的方法
                            if ((p = ((TreeBin<K,V>)f).putTreeVal(hash, key, value)) != null) {
                                oldVal = p.val;
                                if (!onlyIfAbsent)
                                    p.val = value;
                            }
                        }
                        // ReservationNode 为 computeIfAbsent 和 compute 方法中使用的占位节点,同样也是为了保证并发环境下的正确性和一致性
                        else if (f instanceof ReservationNode)
                            throw new IllegalStateException("Recursive update");
                    }
                }
                if (binCount != 0) {
                    // 如果链表中元素数量超过了树化阈值,则将链表转换为红黑树
                    if (binCount >= TREEIFY_THRESHOLD)
                        treeifyBin(tab, i);
                    if (oldVal != null)
                        return oldVal;
                    break;
                }
            }
        }
        // 更新元素计数
        addCount(1L, binCount);
        return null;
    }

    // 扰动函数,用于计算哈希值以减少碰撞的可能性
    static final int spread(int h) {
        // 右移 16 位后,使该 hash 值的高 16 位和低 16 位“混合”,使 hash 值均匀分布,位与操作则是限制哈希值的范围,并保证它为非负数
        return (h ^ (h >>> 16)) & HASH_BITS;
    }

    private final Node<K,V>[] initTable() {
        Node<K,V>[] tab; int sc;
        while ((tab = table) == null || tab.length == 0) {
            // 通过 CAS 操作将 sizeCtl 赋值为 -1,成功后 sizeCtl 为 -1 表示正在有线程在对它进行初始化
            // 如果此时再有其他线程来操作,CAS 操作会失败,会在 while 循环中自旋等待直到完成初始化
            if ((sc = sizeCtl) < 0)
                Thread.yield();
            else if (U.compareAndSetInt(this, SIZECTL, sc, -1)) {
                try {
                    if ((tab = table) == null || tab.length == 0) {
                        int n = (sc > 0) ? sc : DEFAULT_CAPACITY;
                        @SuppressWarnings("unchecked")
                        Node<K,V>[] nt = (Node<K,V>[])new Node<?,?>[n];
                        table = tab = nt;
                        // 计算扩容阈值,相当于原值的 0.75F,构造函数中指定的负载因子不会生效,均采用默认 0.75F 来计算
                        sc = n - (n >>> 2);
                    }
                } finally {
                    sizeCtl = sc;
                }
                break;
            }
        }
        return tab;
    }
}

在这段源码逻辑中,我能能发现一些具有“隐藏”性的赋值操作,比如在如下逻辑中,变量 n 的赋值:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {
    // ...
    
    final V putVal(K key, V value, boolean onlyIfAbsent) {
        // ...
        
        for (Node<K,V>[] tab = table;;) {
            Node<K,V> f; int n, i, fh; K fk; V fv;
            if (tab == null || (n = tab.length) == 0)
                tab = initTable();
            // ...
        }
    }
    
}

它是在 if 条件 判断中完成赋值的,这样写代码确实相对精简一些,但是也仅限于在此(或技术组件中),我觉得如果在业务代码中这样写,可读性就比较差了。

put 方法向数组中每个桶添加第一个元素时,都会使用 CAS 操作。为了节省空间,并没有为每个桶都创建一个锁,而是将每个桶中第一个元素作为锁,当发生哈希碰撞时,依赖 synchronized 完成锁定。这里值得关注的是:在获取到该元素的锁后,又重复判断了链表头节点是否仍然为该元素(双重检测),因为该元素可能被其他线程操作删除,在接下来的源码中还能看到很多在执行完同步操作后重新再判断是否符合条件的逻辑,这也是在提醒我们:写线程同步相关代码时有时需要再校验。当某个桶中第一个元素被锁定时,其他操作该桶元素的线程操作会被阻塞,如果 equals 方法耗时较长,可能会影响性能,但实际上,这种情况并不常见。

addCount 更新元素计数方法

接下来我们看一下 addCount 更新元素数量的方法,该方法实现的元素计数非常有意思:在更新元素数量时未发生冲突则始终使用 baseCount 来表示哈希表中元素适量,一旦 CAS 更新数量失败,它便会创建一个 CounterCell[] counterCells 来协助统计元素数量,总数量为 baseCountCounterCell[] counterCells 中计数值的累加。并且判断哈希表是否需要扩容也是在这里完成的。本节方法非常重要,需要大家重点关注:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {

   private static final int RESIZE_STAMP_BITS = 16;

   private static final int RESIZE_STAMP_SHIFT = 32 - RESIZE_STAMP_BITS;

   private static final int MAXIMUM_CAPACITY = 1 << 30;

   // 65535 允许最大操作扩容的线程数(好大...)
   private static final int MAX_RESIZERS = (1 << (32 - RESIZE_STAMP_BITS)) - 1;
   
   transient volatile Node<K,V>[] table;

   // 扩容操作后要使用的数组
   private transient volatile Node<K,V>[] nextTable;
    
   private transient volatile CounterCell[] counterCells;

   private static final long BASECOUNT;

   private transient volatile long baseCount;

   // counterCells 在创建元素或者在扩容的标志,使用 CAS 操作更新 
   transient volatile int cellsBusy;

   // CPU 核数
   static final int NCPU = Runtime.getRuntime().availableProcessors();
   
    final V putVal(K key, V value, boolean onlyIfAbsent) {
        // ...
       
        // 增加计数
        addCount(1L, binCount);
        return null;
    }
    
    private final void addCount(long x, int check) {
        CounterCell[] cs; long b, s;
        // 更新元素计数,注意这里有 cas 操作更新 baseCount 的值,如果 CAS 更新失败或 counterCells 已经被初始化,会进入 if 条件的执行逻辑
        if ((cs = counterCells) != null || !U.compareAndSetLong(this, BASECOUNT, b = baseCount, s = b + x)) {
            CounterCell c; long v; int m;
            boolean uncontended = true;
           // 负责 counterCells 的初始化和扩展
            if (cs == null || (m = cs.length - 1) < 0 || (c = cs[ThreadLocalRandom.getProbe() & m]) == null 
                    || !(uncontended = U.compareAndSetLong(c, CELLVALUE, v = c.value, v + x))) {
                fullAddCount(x, uncontended);
                return;
            }
            if (check <= 1)
                return;
            // 计算元素总和
            s = sumCount();
        }
        if (check >= 0) {
            Node<K,V>[] tab, nt; int n, sc;
            // 增加元素后元素数量大于当前 sizeCtl 大小 且 table 已被初始化 且未超过最大容量
            while (s >= (long)(sc = sizeCtl) && (tab = table) != null && (n = tab.length) < MAXIMUM_CAPACITY) {
                // n 为 table 的长度(length),以 n 为参数计算 resizeStamp(扩容戳),唯一标识,用来协调多个线程同时操作 transfer
                // 而再将其左移 16 位,会得到一个较大的负数,eg: -2145779712,这样其他线程只能调用到 sc < 0 的条件分支了
                int rs = resizeStamp(n) << RESIZE_STAMP_SHIFT;
                // sc < 0 表示正在进行扩容
                if (sc < 0) {
                    // 超过最大线程数量 或 最后一个扩容线程 或 扩容后数组为空 或 transferIndex小于等于0 则 退出循环
                    if (sc == rs + MAX_RESIZERS || sc == rs + 1 || (nt = nextTable) == null || transferIndex <= 0)
                        break;
                    // 将 sc 增加 1,表示增加一个扩容线程
                    if (U.compareAndSetInt(this, SIZECTL, sc, sc + 1))
                        // 执行扩容操作,接下来具体讲解
                        transfer(tab, nt);
                }
                // sc >= 0 表示没有扩容操作在执行,CAS 操作将 sizeCtl 更新为 rs + 2,表示启动扩容操作,此时 sc 已经为一个负数了
                else if (U.compareAndSetInt(this, SIZECTL, sc, rs + 2))
                    // 执行扩容操作,第二个入参 Node<K,V>[] nextTab 为 null,只有一个线程能够启动扩容是为了 nextTab 只能被初始化一遍
                    transfer(tab, null);
                // 计算元素总和
                s = sumCount();
            }
        }
    }

    // 与 longAdder 中实现原理一致
   private final void fullAddCount(long x, boolean wasUncontended) {
      int h;
      // 如果线程探针值为 0 证明它还没被初始化,那么对它初始化
      if ((h = ThreadLocalRandom.getProbe()) == 0) {
         ThreadLocalRandom.localInit();
         h = ThreadLocalRandom.getProbe();
         wasUncontended = true;
      }
      // 冲突标志,用于标记创建计数元素时发生碰撞;槽位引用发生变化;槽位已满;槽位中计数元素发生变更
      boolean collide = false;
      // 自旋操作尝试更新,直到成功为止
      for (;;) {
         CounterCell[] cs; CounterCell c; int n; long v;
         // 如果 counterCells 数组已经初始化,并且长度大于 0
         if ((cs = counterCells) != null && (n = cs.length) > 0) {
             // 如果槽位为空
            if ((c = cs[(n - 1) & h]) == null) {
               // 没有线程在创建计数元素
               if (cellsBusy == 0) {
                   // 创建计数元素,并记录计数值 x
                  CounterCell r = new CounterCell(x);
                  // 将 cellsBusy 更新为 1,标志该线程正在创建计数元素
                  if (cellsBusy == 0 && U.compareAndSetInt(this, CELLSBUSY, 0, 1)) {
                     boolean created = false;
                     try {               
                        CounterCell[] rs; int m, j;
                        // 双重校验该槽位未创建计数元素
                        if ((rs = counterCells) != null && (m = rs.length) > 0 && rs[j = (m - 1) & h] == null) {
                           // 为槽位赋值
                           rs[j] = r;
                           created = true;
                        }
                     } finally {
                         // 创建完成更新 cellsBusy 为 0,允许其他线程继续操作
                        cellsBusy = 0;
                     }
                     // 创建完成,结束循环
                     if (created)
                        break;
                     continue;
                  }
               }
               // 变更冲突标志
               collide = false;
            }
            // 标记 wasUncontended 为 true 后重试
            else if (!wasUncontended)
               wasUncontended = true;
            // 成功更新计算元素值,退出循环
            else if (U.compareAndSetLong(c, CELLVALUE, v = c.value, v + x))
               break;
            // 槽位引用已经发生变化或槽位已满
            else if (counterCells != cs || n >= NCPU)
                // 变更冲突标志
               collide = false;
            // 如果已经发生过冲突,标记为 true
            else if (!collide)
               collide = true;
            // 如果 counterCells 需要扩容
            else if (cellsBusy == 0 && U.compareAndSetInt(this, CELLSBUSY, 0, 1)) {
               try {
                   // 校验 counterCells 未发生变更
                  if (counterCells == cs)
                     counterCells = Arrays.copyOf(cs, n << 1);
               } finally {
                  cellsBusy = 0;
               }
               // 变更冲突标志位
               collide = false;
               // 扩容后重试
               continue;
            }
            h = ThreadLocalRandom.advanceProbe(h);
         }
         // 如果 counterCells 未被初始化,则尝试初始化
         else if (cellsBusy == 0 && counterCells == cs && U.compareAndSetInt(this, CELLSBUSY, 0, 1)) {
            boolean init = false;
            try {
                // 双重校验 
               if (counterCells == cs) {
                   // 初始大小为 2
                  CounterCell[] rs = new CounterCell[2];
                  rs[h & 1] = new CounterCell(x);
                  counterCells = rs;
                  init = true;
               }
            } finally {
               cellsBusy = 0;
            }
            // 完成初始化且创建好计数元素,结束循环
            if (init)
               break;
         }
         // 所有情况都不符合,直接在 baseCount 计数值上累加
         else if (U.compareAndSetLong(this, BASECOUNT, v = baseCount, v + x))
            break;
      }
   }

   // 计算元素总数量的方法,baseCount 累加 counterCells 中计数元素计数值
   final long sumCount() {
      CounterCell[] cs = counterCells;
      long sum = baseCount;
      if (cs != null) {
         for (CounterCell c : cs)
            if (c != null)
               sum += c.value;
      }
      return sum;
   }

   static final int resizeStamp(int n) {
      // n 前导 0 数量位或运算
      return Integer.numberOfLeadingZeros(n) | (1 << (RESIZE_STAMP_BITS - 1));
   }
   
}

在元素计数 fullAddCount 方法中,会为新增的元素数量 x 在 CounterCell[] 中找到一个槽位记录或累加,在进行该操作时使用了自旋重试保证执行成功。元素计数累加完成后,会对是否需要扩容进行判断,如果元素数量超过 sizeCtl 则会进行扩容操作,在扩容开始时,会将 sizeCtl 赋值为负数,这样在执行扩容方法时,只有一个线程能调用 transfer(tab, null); 方法,保证扩容后哈希表 nextTable 仅被初始化一次,完成多线程扩容的协调。这里弄明白之后,接下来重点看扩容方法 transfer

transfer 扩容方法

扩容方法 transfer 允许多线程协同扩容,实现协同扩容的方法很巧妙,它定义了全局变量 transferIndex 用于记录当前扩容操作的进度(为 0 时表示快完成或已经完成,初始值为哈希表长度),规定每个线程的处理步长 stride 最小值为 16,如果 transferIndex 大于步长值 stride 时,其他线程调用该方法时会被分配扩容任务协助完成扩容,这样每个线程便被分配了一段处理范围,线程与线程间扩容互不影响,提高了扩容效率。以下为源码,其中已经注明了详细注释,大家需要根据源码和注释信息理解该过程:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {

   private static final int RESIZE_STAMP_BITS = 16;

   private static final int RESIZE_STAMP_SHIFT = 32 - RESIZE_STAMP_BITS;
    
   private static final int MIN_TRANSFER_STRIDE = 16;

   // 转发节点 forwarding nodes 的 hash 值 -1
   static final int MOVED     = -1;
   
   static final int NCPU = Runtime.getRuntime().availableProcessors();

   static final int UNTREEIFY_THRESHOLD = 6;
   
   private transient volatile Node<K,V>[] nextTable;

   private transient volatile int transferIndex;

   private transient volatile int sizeCtl;
   
   /**
    * 扩容哈希表,将旧表 tab 中元素转移到 nextTab 中
    * 
    * @param tab      旧表
    * @param nextTab  新表
    */
    private final void transfer(Node<K, V>[] tab, Node<K, V>[] nextTab) {
        // n 为当前哈希表长度;stride 为步长,即每个线程负责处理的桶数
        int n = tab.length, stride;
        // 根据 CPU 核数,分配任务给多个线程,每个线程最小的处理步长为 16
        if ((stride = (NCPU > 1) ? (n >>> 3) / NCPU : n) < MIN_TRANSFER_STRIDE)
            stride = MIN_TRANSFER_STRIDE;
        // 当 nextTab == null 时,表示第一个启动扩容的线程执行,这段逻辑只会被执行一次
        if (nextTab == null) {
            try {
                // 右移 1 位,容量扩大两倍
                Node<K, V>[] nt = (Node<K, V>[]) new Node<?, ?>[n << 1];
                nextTab = nt;
            } catch (Throwable ex) {
                // 如果发生 OOME 内存不足错误,将 sizeCtl 指定为 最大值并返回
                sizeCtl = Integer.MAX_VALUE;
                return;
            }
            nextTable = nextTab;
            transferIndex = n;
        }
        // 扩容后哈希表长度
        int nextn = nextTab.length;
        // 转发节点,用于标记该节点已经被添加到新表中,它会被插入到桶中第一个元素的位置
        ForwardingNode<K, V> fwd = new ForwardingNode<K, V>(nextTab);
        // 前进标志,用于控制是否需要检查 去处理下一个桶 或 是否需要被分配下一组数据的执行任务
        boolean advance = true;
        // 即将完成标志,如果该值为 true 再重新检查一遍哈希表元素即完成扩容操作
        boolean finishing = false; 
        for (int i = 0, bound = 0; ; ) {
            // 桶中第一个节点
            Node<K, V> f;
            // 第一个节点的 hash 值
            int fh;
            while (advance) {
                int nextIndex, nextBound;
                // 在这里更新当前线程的处理索引 --i,如果 i 仍然在范围内 或 处于正在完成阶段
                if (--i >= bound || finishing)
                    // 结束循环去执行下面的节点转移操作
                    advance = false;
                // transferIndex 小于等于 0 说明所有桶的处理任务已经被分配完毕了,新线程无需再协助扩容了
                else if ((nextIndex = transferIndex) <= 0) {
                    i = -1;
                    // 结束循环去执行下面的节点转移操作
                    advance = false;
                }
                // 线程第一次循环都会来执行这段逻辑来分配要处理的数据范围
                // CAS 操作更新 transferIndex 为 transferIndex - stride,该值为下一个线程的处理范围的右边界 nextBound
                else if (U.compareAndSetInt(this, TRANSFERINDEX, nextIndex, nextBound = (nextIndex > stride ? nextIndex - stride : 0))) {
                    // 当前线程处理范围的左边界 bound
                    bound = nextBound;
                    // 此时 nextIndex 为 CAS 更新前 transferIndex 大小,减一即表示有效索引
                    // 所以线程处理数据的有效范围是 [bound, i] 的闭区间,从 i 倒序处理
                    i = nextIndex - 1;
                    // 结束循环去执行下面的节点转移逻辑
                    advance = false;
                }
            }
            // 如果 i 超出有效范围,检测是否需要结束扩容
            if (i < 0 || i >= n || i + n >= nextn) {
                int sc;
                // 扩容已完成
                if (finishing) {
                    nextTable = null;
                    table = nextTab;
                    // 0.75 倍容量大小,下次扩容的阈值
                    sizeCtl = (n << 1) - (n >>> 1);
                    return;
                }
                // CAS 操作更新 sizeCtl 为 sizeCtl - 1 表示执行扩容的其中之一线程已经操作完成了
                if (U.compareAndSetInt(this, SIZECTL, sc = sizeCtl, sc - 1)) {
                    // 这里就要和 addCount 方法中执行扩容更新 sizeCtl 的方法联系起来
                    // sizeCtl 在执行扩容时先被赋值为 resizeStamp(n) << RESIZE_STAMP_SHIFT + 2
                    // 每有一个线程帮助扩容则 +1;每有一个线程扩容完成便 -1
                    // 当再将 sizeCtl 减到 resizeStamp(n) << RESIZE_STAMP_SHIFT + 2 时,说明帮助扩容的线程都已经操作完成了
                    // 此时可以将 finishing 更新为 true 并重新循环检查所有桶
                    if ((sc - 2) != resizeStamp(n) << RESIZE_STAMP_SHIFT)
                        return;
                    finishing = advance = true;
                    i = n;
                }
            }
            // 如果当前桶为 null,那么直接将其更改为转发节点(ForwardingNode),标志该桶已被处理
            else if ((f = tabAt(tab, i)) == null)
                // 处理成功则会再去执行 while 循环中的方法,判断是处理下一个桶还是分配下一批数据的处理任务
                advance = casTabAt(tab, i, null, fwd);
            // 判断是否为转发节点(已经处理过)
            else if ((fh = f.hash) == MOVED)
                // 处理成功则会再去执行 while 循环中的方法,判断是处理下一个桶还是分配下一批数据的处理任务
                advance = true;
            // 否则处理该节点
            else {
                // 先对该节点加锁
                synchronized (f) {
                    // 双重判断该节点没有发生变化(删除或修改)
                    if (tabAt(tab, i) == f) {
                        // ln: lowNode 低位链表节点;hn: highNode 高位链表节点
                        Node<K, V> ln, hn;
                        // 检查当前节点的 hash 值是否为正整数,如果是则表示它是链表节点
                        if (fh >= 0) {
                            // 计算当前节点 hash 值与旧表长度 n 位与运算结果
                            int runBit = fh & n;
                            // 先初始化 lastRun 为当前节点,并遍历链表,根据位与运算结果找到链表的最后一个节点由 lastRun 引用
                            Node<K, V> lastRun = f;
                            for (Node<K, V> p = f.next; p != null; p = p.next) {
                                int b = p.hash & n;
                                if (b != runBit) {
                                    runBit = b;
                                    lastRun = p;
                                }
                            }
                            // 根据位与运算结果,来决定这个节点是被划分到新表的低位还是高位
                            if (runBit == 0) {
                                ln = lastRun;
                                hn = null;
                            } else {
                                hn = lastRun;
                                ln = null;
                            }
                            // 遍历该桶中链表的所有节点
                            for (Node<K, V> p = f; p != lastRun; p = p.next) {
                                int ph = p.hash;
                                K pk = p.key;
                                V pv = p.val;
                                // 根据 hash 值位与运算结果,采用头插法不断向两个高位和低位链表中添加节点
                                if ((ph & n) == 0)
                                    ln = new Node<K, V>(ph, pk, pv, ln);
                                else
                                    hn = new Node<K, V>(ph, pk, pv, hn);
                            }
                            // 低位链表赋值到新表中
                            setTabAt(nextTab, i, ln);
                            // 高位链表赋值到新表中
                            setTabAt(nextTab, i + n, hn);
                            // 将旧表的 i 索引处元素更新为转发节点,表示已处理
                            setTabAt(tab, i, fwd);
                            // 更新为 true,以便在上文的 while 循环中判断是否要被分配下一批任务或处理下一个桶
                            advance = true;
                        }
                        // 如果该节点为红黑树节点
                        else if (f instanceof TreeBin) {
                            TreeBin<K, V> t = (TreeBin<K, V>) f;
                            // 定义两组变量分别记录低位红黑树头尾节点和高位红黑树头尾节点
                            TreeNode<K, V> lo = null, loTail = null;
                            TreeNode<K, V> hi = null, hiTail = null;
                            // 分别记录低位、高位节点数量
                            int lc = 0, hc = 0;
                            // 与链表操作相似,都是根据 hash 值位与运算的结果来确定新节点的位置
                            for (Node<K, V> e = t.first; e != null; e = e.next) {
                                int h = e.hash;
                                TreeNode<K, V> p = new TreeNode<K, V>
                                        (h, e.key, e.val, null, null);
                                if ((h & n) == 0) {
                                    if ((p.prev = loTail) == null)
                                        lo = p;
                                    else
                                        loTail.next = p;
                                    loTail = p;
                                    ++lc;
                                } else {
                                    if ((p.prev = hiTail) == null)
                                        hi = p;
                                    else
                                        hiTail.next = p;
                                    hiTail = p;
                                    ++hc;
                                }
                            }
                            // 根据计数值判断是否要将红黑树转换为链表,注意这里红黑树转换成链表的阈值为 6
                            ln = (lc <= UNTREEIFY_THRESHOLD) ? untreeify(lo) :
                                    (hc != 0) ? new TreeBin<K, V>(lo) : t;
                            hn = (hc <= UNTREEIFY_THRESHOLD) ? untreeify(hi) :
                                    (lc != 0) ? new TreeBin<K, V>(hi) : t;
                            // 将节点封装到新哈希表中
                            setTabAt(nextTab, i, ln);
                            setTabAt(nextTab, i + n, hn);
                            // 更新该节点为转发节点
                            setTabAt(tab, i, fwd);
                            // 更新为 true,以便在上文的 while 循环中判断是否要被分配下一批任务或处理下一个桶
                            advance = true;
                        }
                    }
                }
            }
        }
    }

   // 转发节点,哈希值默认为 -1
   static final class ForwardingNode<K,V> extends Node<K,V> {
      final Node<K,V>[] nextTable;
      
      ForwardingNode(Node<K,V>[] tab) {
         super(MOVED, null, null);
         this.nextTable = tab;
      }

      // ...
   }
}

在我们分析完上述源码后再来看 helpTransfer 方法就非常容易了,该方法用于其他线程协助完成哈希表的扩容操作,本质上还是会调用 transfer 方法:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {

    // ...
    
    final Node<K, V>[] helpTransfer(Node<K, V>[] tab, Node<K, V> f) {
        Node<K, V>[] nextTab;
        int sc;
        // 当前哈希表已经被初始化;当前节点为转发节点,表示扩容进行中;新哈希表也完成了初始化
        if (tab != null && (f instanceof ForwardingNode) && (nextTab = ((ForwardingNode<K, V>) f).nextTable) != null) {
            // 扩容戳,我们在讨论 addCount() 方法时提到过
            int rs = resizeStamp(tab.length) << RESIZE_STAMP_SHIFT;
            // 扩容进行中:旧哈希表仍然为旧哈希表;新哈希表仍为新哈希表;sizeCtl 仍然小于 0
            while (nextTab == nextTable && table == tab &&
                    (sc = sizeCtl) < 0) {
                // 检查是否超过最大扩容线程数量
                if (sc == rs + MAX_RESIZERS || sc == rs + 1 ||
                        transferIndex <= 0)
                    break;
                // CAS 更新 sizeCtl + 1,表示扩容线程增加了一个 
                if (U.compareAndSetInt(this, SIZECTL, sc, sc + 1)) {
                    // 调用扩容方法
                    transfer(tab, nextTab);
                    break;
                }
            }
            return nextTab;
        }
        return table;
    }
}

到目前为止,相对复杂的逻辑已经全部讲解完了,接下来的内容在理解了上述内容后再看会非常简单,所以如果没理解上方的源码内容需要再去熟悉熟悉。

treeifyBin 树化方法

treeifyBin 方法用于将链表转换成红黑树,以提高查询效率,逻辑非常简单,关注注释信息即可,如下:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {

    // 链表树化的最小限制
    static final int MIN_TREEIFY_CAPACITY = 64;

    private final void treeifyBin(Node<K, V>[] tab, int index) {
        Node<K, V> b;
        int n;
        if (tab != null) {
            // 检查哈希表长度是否小于 64,如果小于的话执行的是扩容操作
            if ((n = tab.length) < MIN_TREEIFY_CAPACITY)
                tryPresize(n << 1);
            // 检验该节点的哈希值大于等于 0,表示该节点是链表节点
            else if ((b = tabAt(tab, index)) != null && b.hash >= 0) {
                // 同步锁住该节点
                synchronized (b) {
                    // 锁住后校验该节点没有别其他线程修改
                    if (tabAt(tab, index) == b) {
                        // 将链表转换为红黑树
                        TreeNode<K, V> hd = null, tl = null;
                        for (Node<K, V> e = b; e != null; e = e.next) {
                            TreeNode<K, V> p = new TreeNode<K, V>(e.hash, e.key, e.val, null, null);
                            if ((p.prev = tl) == null)
                                hd = p;
                            else
                                tl.next = p;
                            tl = p;
                        }
                        // 将原表中原表节点替换为红黑树节点
                        setTabAt(tab, index, new TreeBin<K, V>(hd));
                    }
                }
            }
        }
    }

    private final void tryPresize(int size) {
        // 计算目标容量大小,如果超过最大容量的一半,直接赋值为最大容量,否则计算出合适容量(tableSizeFor 方法已在上文提到过)
        int c = (size >= (MAXIMUM_CAPACITY >>> 1)) ? MAXIMUM_CAPACITY : tableSizeFor(size + (size >>> 1) + 1);
        int sc;
        while ((sc = sizeCtl) >= 0) {
            Node<K, V>[] tab = table;
            int n;
            // 哈希表为空或者长度为 0,表示哈希表还未完成初始化
            if (tab == null || (n = tab.length) == 0) {
                // Math.max(sc, c);
                n = (sc > c) ? sc : c;
                // 更新 sizeCtl 为 -1,表示哈希表正在初始化
                if (U.compareAndSetInt(this, SIZECTL, sc, -1)) {
                    try {
                        if (table == tab) {
                            Node<K, V>[] nt = (Node<K, V>[]) new Node<?, ?>[n];
                            table = nt;
                            sc = n - (n >>> 2);
                        }
                    } finally {
                        sizeCtl = sc;
                    }
                }
            } else if (c <= sc || n >= MAXIMUM_CAPACITY)
                break;
            // 尝试扩容
            else if (tab == table) {
                // 计算扩容戳
                int rs = resizeStamp(n);
                // 这段逻辑就与 addCount 中第一个操作扩容的线程逻辑一致了
                if (U.compareAndSetInt(this, SIZECTL, sc, (rs << RESIZE_STAMP_SHIFT) + 2))
                    transfer(tab, null);
            }
        }
    }
}

get 方法

get 方法非常简单,如下:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {

    public V get(Object key) {
        Node<K, V>[] tab;
        Node<K, V> e, p;
        int n, eh;
        K ek;
        // 计算出经过扰动的 hash 值
        int h = spread(key.hashCode());
        // 哈希表已经完成初始化且该索引处元素不为 null
        if ((tab = table) != null && (n = tab.length) > 0 && (e = tabAt(tab, (n - 1) & h)) != null) {
            // 哈希值相等,判断第一个节点是不是想要的节点
            if ((eh = e.hash) == h) {
                // key 相等则返回对应的值
                if ((ek = e.key) == key || (ek != null && key.equals(ek)))
                    return e.val;
            // 当节点哈希值小于 0 时,表示两种情况:要么为红黑树节点,要么正在扩容
            } else if (eh < 0)
                return (p = e.find(h, key)) != null ? p.val : null;
            // 遍历链表尝试找到要匹配的节点
            while ((e = e.next) != null) {
                if (e.hash == h && ((ek = e.key) == key || (ek != null && key.equals(ek))))
                    return e.val;
            }
        }
        return null;
    }
}

eh < 0 的条件下,表示两种情况:要么为红黑树节点,要么正在扩容(ForwardingNode),前者就不在这里赘述了。这里我们需要看一下在扩容时,哈希表是如何寻找对应节点的,如下为 ForwardingNode 中查找对应节点值的源码:

static final class ForwardingNode<K,V> extends Node<K,V> {
   final Node<K,V>[] nextTable;
   ForwardingNode(Node<K,V>[] tab) {
      super(MOVED, null, null);
      this.nextTable = tab;
   }

   Node<K,V> find(int h, Object k) {
      // 注意这里的 outer 标志,如果在寻找节点中发现 e 为转发节点,那么需要再去新的被扩容后的表中寻找对应节点
      outer: for (Node<K,V>[] tab = nextTable;;) {
         Node<K,V> e; int n;
         // 要找的对象为 null 或者 tab 未初始化 或者 桶对应的位置为 null
         if (k == null || tab == null || (n = tab.length) == 0 || (e = tabAt(tab, (n - 1) & h)) == null)
            return null;
         for (;;) {
            int eh; K ek;
            // 找到了对应的节点
            if ((eh = e.hash) == h && ((ek = e.key) == k || (ek != null && k.equals(ek))))
               return e;
            if (eh < 0) {
               // 发现了转发节点,说明该节点已经再次被转移到了新的哈希表中,需要去新的哈希表寻找
               if (e instanceof ForwardingNode) {
                  tab = ((ForwardingNode<K,V>)e).nextTable;
                  continue outer;
               }
               else
                  // 调用 node 的 find 方法
                  return e.find(h, k);
            }
            // 找完了所有节点仍然没找到
            if ((e = e.next) == null)
               return null;
         }
      }
   }

   static class Node<K,V> implements Map.Entry<K,V> {
      
      // 简单地遍历查找
      Node<K,V> find(int h, Object k) {
         Node<K,V> e = this;
         if (k != null) {
            do {
               K ek;
               if (e.hash == h &&
                       ((ek = e.key) == k || (ek != null && k.equals(ek))))
                  return e;
            } while ((e = e.next) != null);
         }
         return null;
      }
   }
}

由以上源码可知,在寻找某节点时如果发现了 转发节点,那么证明该节点已经被转移到新的哈希表中,那么需要去新的哈希表中寻找。

remove 方法

remove 方法也非常简单,当某节点被删除时需要更新计数,addCount 我们在上文也介绍过,就不在赘述了。在红黑树中移除节点(removeTreeNode 方法)时,可能会调用到 untreeify 方法,这里的将红黑树转换成链表的逻辑与在 transfer 中根据节点数量小于等于阈值 6 的转换判断逻辑不同,removeTreeNode 决定将链表转换成红黑树时判断的依据是红黑树是否太小(too small):root == null || r.right == null || (rl = r.left) == null || rl.left == null,感兴趣的大家可以去源码中了解一下,在这里就不再贴源码了。以下为删除方法主要逻辑,重点关注注释信息:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {
    
    public V remove(Object key) {
        return replaceNode(key, null, null);
    }
    
    final V replaceNode(Object key, V value, Object cv) {
        // 计算 key 对应的 hash 值
        int hash = spread(key.hashCode());
        for (Node<K,V>[] tab = table;;) {
            Node<K,V> f; int n, i, fh;
            // 如果未完成初始化或要删除的节点不存在
            if (tab == null || (n = tab.length) == 0 || (f = tabAt(tab, i = (n - 1) & hash)) == null)
                break;
            // 节点为转移节点,协助扩容
            else if ((fh = f.hash) == MOVED)
                tab = helpTransfer(tab, f);
            // 处理对应节点
            else {
                V oldVal = null;
                // 某节点被修改或删除,标记为 true
                boolean validated = false;
                // 先加锁
                synchronized (f) {
                    // 加锁完成后重复校验该节点是否被修改过
                    if (tabAt(tab, i) == f) {
                        // 处理链表节点
                        if (fh >= 0) {
                            validated = true;
                            for (Node<K,V> e = f, pred = null;;) {
                                K ek;
                                // 如果匹配到了对应的节点
                                if (e.hash == hash && ((ek = e.key) == key || (ek != null && key.equals(ek)))) {
                                    V ev = e.val;
                                    if (cv == null || cv == ev || (ev != null && cv.equals(ev))) {
                                        // 记录原节点值
                                        oldVal = ev;
                                        // value 不为 null 才更新为新节点值
                                        if (value != null)
                                            e.val = value;
                                        // 删除中间节点或尾节点
                                        else if (pred != null)
                                            pred.next = e.next;
                                        else
                                        // 删除头节点
                                            setTabAt(tab, i, e.next);
                                    }
                                    break;
                                }
                                // 向后遍历,变更引用
                                pred = e;
                                if ((e = e.next) == null)
                                    break;
                            }
                        }
                        // 处理红黑树节点
                        else if (f instanceof TreeBin) {
                            validated = true;
                            TreeBin<K,V> t = (TreeBin<K,V>)f;
                            TreeNode<K,V> r, p;
                            if ((r = t.root) != null && (p = r.findTreeNode(hash, key, null)) != null) {
                                V pv = p.val;
                                if (cv == null || cv == pv || (pv != null && cv.equals(pv))) {
                                    oldVal = pv;
                                    if (value != null)
                                        p.val = value;
                                    else if (t.removeTreeNode(p))
                                        setTabAt(tab, i, untreeify(t.first));
                                }
                            }
                        }
                        else if (f instanceof ReservationNode)
                            throw new IllegalStateException("Recursive update");
                    }
                }
                if (validated) {
                    // 原值不为空则返回该值
                    if (oldVal != null) {
                        // 节点被删除则更新计数
                        if (value == null)
                            addCount(-1L, -1);
                        return oldVal;
                    }
                    break;
                }
            }
        }
        return null;
    }
}

computeIfAbsent 方法

先前我们提到过 ReservationNode 用于占位,那么我们就以 computeIfAbsent 方法为例,来简单看一下它是怎么来占位的,其中大部分逻辑我们在上文中已经介绍过,主要关注它的不同点:

public class ConcurrentHashMap<K,V> extends AbstractMap<K,V> implements ConcurrentMap<K,V>, Serializable {

    // 该方法用于某个键未被添加到哈希表中时,使用给定的函数计算值并将其添加到哈希表中
    public V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction) {
        if (key == null || mappingFunction == null)
            throw new NullPointerException();
        int h = spread(key.hashCode());
        V val = null;
        int binCount = 0;
        for (Node<K, V>[] tab = table; ; ) {
            Node<K, V> f;
            int n, i, fh;
            K fk;
            V fv;
            // 初始化操作
            if (tab == null || (n = tab.length) == 0)
                tab = initTable();
            // 未在桶中匹配到元素
            else if ((f = tabAt(tab, i = (n - 1) & h)) == null) {
                // 创建占位符节点,并加锁
                Node<K, V> r = new ReservationNode<K, V>();
                synchronized (r) {
                    // CAS 操作将桶中的 null 更新成占位节点 
                    if (casTabAt(tab, i, null, r)) {
                        binCount = 1;
                        Node<K, V> node = null;
                        try {
                            // 计算 key 对应的 value
                            if ((val = mappingFunction.apply(key)) != null)
                                // value 不为 null 创建链表节点
                                node = new Node<K, V>(h, key, val);
                        } finally {
                            // 将链表节点添加到桶中
                            setTabAt(tab, i, node);
                        }
                    }
                }
                if (binCount != 0)
                    break;
            }
            // 协助扩容
            else if ((fh = f.hash) == MOVED)
                tab = helpTransfer(tab, f);
            // 如果桶中的第一个节点 key 能和现在这个 key 完成匹配,那么直接返回它的值
            else if (fh == h && ((fk = f.key) == key || (fk != null && key.equals(fk))) && (fv = f.val) != null)
                return fv;
            // 否则,遍历寻找
            else {
                boolean added = false;
                synchronized (f) {
                    if (tabAt(tab, i) == f) {
                        if (fh >= 0) {
                            binCount = 1;
                            for (Node<K, V> e = f; ; ++binCount) {
                                K ek;
                                // 匹配到对应节点,为 val 赋值并结束循环
                                if (e.hash == h && ((ek = e.key) == key || (ek != null && key.equals(ek)))) {
                                    val = e.val;
                                    break;
                                }
                                Node<K, V> pred = e;
                                // 没找到这个节点创建一个
                                if ((e = e.next) == null) {
                                    if ((val = mappingFunction.apply(key)) != null) {
                                        if (pred.next != null)
                                            throw new IllegalStateException("Recursive update");
                                        added = true;
                                        pred.next = new Node<K, V>(h, key, val);
                                    }
                                    break;
                                }
                            }
                        } else if (f instanceof TreeBin) {
                            binCount = 2;
                            TreeBin<K, V> t = (TreeBin<K, V>) f;
                            TreeNode<K, V> r, p;
                            if ((r = t.root) != null &&
                                    (p = r.findTreeNode(h, key, null)) != null)
                                val = p.val;
                            else if ((val = mappingFunction.apply(key)) != null) {
                                added = true;
                                t.putTreeVal(h, key, val);
                            }
                        } else if (f instanceof ReservationNode)
                            throw new IllegalStateException("Recursive update");
                    }
                }
                if (binCount != 0) {
                    if (binCount >= TREEIFY_THRESHOLD)
                        treeifyBin(tab, i);
                    if (!added)
                        return val;
                    break;
                }
            }
        }
        if (val != null)
            addCount(1L, binCount);
        return val;
    }
}

到这里 ConcurrentHashMap 中的源码大部分已经介绍完了,接下来我们简单谈一些有意思的问题。


key 和 value 不能为 null 的妙用

ConcurrentHashMapHashMap 不同,它是不允许 key 和 value 为 null 的,这是为什么呢?根据源码分析,我觉得主要原因是为了 简化并发逻辑,提高处理效率,这样当遇到某桶中元素为 null 时便能判定此处无元素并不需要为 null 做特殊处理。当然这样做也能 避免歧义,比如我们在使用 get 方法获取某 key 的值时,为 null 就表示该键值对不存在,而不会发生认为这个 key 存在但 value 为 null 的情况。

ConcurrentHashMap 对代码的编排

ConcurrentHashMap 为了增加可读性,它首先排列了主要的静态常量声明和内部常用的静态方法,再声明了字段,然后才是主要的公有方法,最后是通用的扩容方法、树的定义、迭代器和批量操作方法。之后我们在写代码时也可以参考它对字段方法的排列。

;