Java并发包同步工具之Phaser
前言
Phaser是从JDK7开始提供的一个可重复使用的同步机制，它在功能上类似于CyclicBarrier和CountDownLatch，但它支持更灵活的使用场景。使用Phaser不仅能够替代CyclicBarrier和CountDownLatch，还能够做到它们做不到的功能。
通过前面的章节我们知道，CyclicBarrier用于一组线程相互等待到达公共的屏障，而CountDownLatch用于一个或一组线程等待另一个或另一组线程（其实也相当于有一个公共屏障），不同的是CyclicBarrier的屏障能够被重复使用，而CountDownLatch却不能重复利用，但是它们有一个共同特点，那就是它们的参与线程(个数)在一开始构造各自的实例对象时就已经被指定，在往后的执行过程中无法改变，而Phaser却提供了动态注册和撤销功能，能够在执行过程中的任意时刻，添加新的参与线程和撤销原有的参与线程。
从大体上说，Phaser与CyclicBarrier相似的地方很多，它们都存在可重复使用的公共屏障，并且在参与者都到达屏障点之后，可以执行屏障点的特殊任务，但Phaser更精细化，它分离出了“到达”与“等待”机制，它还支持结束整个同步Phaser，并且还能对外提供内部的执行状态监控。Phaser还可以被构造成树型分层结构，这种父子关系的树形结构能够有效降低同步竞争，增加吞吐量，因为通过这种父子分层结构，相当于将参与者进行了分组，更小的分组将拥有更少的同步竞争参与者，当然这也导致创建更多的Phaser实例所带来的更多消耗。
CyclicBarrier的内部维护着三个在Phaser中也存在的概念：总的参与者线程个数parties、还未达到屏障点的参与线程个数count、由一个布尔变量表示屏障是否有效的屏障对象Generation。在Phaser中，代表屏障的对象不再是简单的布尔值，而是一个取值范围为0~Integer.MAX_VALUE的int变量phase（以下被称为阶段数），不过这个phase变量与总的参与者个数parties、未到达屏障的参与者个数unarrived以及当前Phaser是否终止的标记全部由一个long型的64字节变量state包装表示，如下所示：
Phaser将所有状态都由一个变量保存的方式能够高效的保证操作的原子性， 还能缩短竞争的窗口期提高并发速度。从上图可以看出，低32位中的2个16位用于表示参与者个数，所以一个Phaser支持的参与者上限为65535。但是，你可以而且应该创建分层的树型Phaser结构来适应任意大量超过这个最大值的参与者。高32位中的低31位用于表示屏障的阶段数phase，即0~Integer.MAX_VALUE的范围，当达到最大值，将会再次从0开始。最高位的一个bit位标识该Phaser是否被终止，如果是1表示被终止。
源码解析
先来看Phaser的内部结构：
1 public class Phaser { 2 /** 3 * 主状态state，分为4部分： 4 * 5 * unarrived -- 还没有到达栅栏的参与者计数。 (bits 0-15) 6 * parties -- 栅栏全部参与者的计数。 (bits 16-31) 7 * phase -- 栅栏当前所处的阶段 (bits 32-62) 8 * terminated -- 栅栏的结束标记 (bit 63 / sign) 9 */ 10 private volatile long state; 11 12 //下面是一些辅助常量用于对state进行位运算得出以上四种状态的值 13 private static final int MAX_PARTIES = 0xffff; // 最大参与者个数parties 65535，低16位全1 14 private static final int MAX_PHASE = Integer.MAX_VALUE; //最大阶段数phase 15 private static final int PARTIES_SHIFT = 16; //总参与者位移个数，16位 16 private static final int PHASE_SHIFT = 32; //阶段数位移个数，32位 17 private static final int UNARRIVED_MASK = 0xffff; // 未到达参与者掩码，低16位全1，高16位全0 18 private static final long PARTIES_MASK = 0xffff0000L; // 总参与者个数掩码，高16位全1，低16位全0 19 private static final long COUNTS_MASK = 0xffffffffL; // 掩码，低32位全1，高32位全0 20 private static final long TERMINATION_BIT = 1L << 63; //终止标记 21 22 // some special values 一些特殊值 23 private static final int ONE_ARRIVAL = 1; 24 private static final int ONE_PARTY = 1 << PARTIES_SHIFT; //一个参与者，1左移16位即2^16=十进制65536 25 private static final int ONE_DEREGISTER = ONE_ARRIVAL|ONE_PARTY; //按位或运算，十进制65537 26 private static final int EMPTY = 1; //注意，Empty并不是0而是1 27 28 //下面是利用辅助常量的位运算方法，获取不同域的值 29 //注意如果state为1时返回的是0，因为在没有注册任何参与者时，state的初始值为1，具体在构造方法中详解 30 private static int unarrivedOf(long s) {//获取未到达个数 31 int counts = (int)s; //long强转为int后为一个负数，溢出导致低32位不变，高32位都是1 32 //按位与低16位都是1的掩码，得到低16位表达的值，即未达到个数 33 return (counts == EMPTY) ? 0 : (counts & UNARRIVED_MASK); 34 } 35 //无符号右移16位，得到低32位中的高16位，即总参与者个数 36 private static int partiesOf(long s) { 37 return (int)s >>> PARTIES_SHIFT; 38 } 39 //无符号右移32位，取高32位，表示是否终止的最高位也在里面，所以如果已经终止（最高位为1）得到的结果将是负数 40 private static int phaseOf(long s) { 41 return (int)(s >>> PHASE_SHIFT); 42 } 43 //已经到达的个数，即总的参与者个数减去还未到达的个数。 44 private static int arrivedOf(long s) { 45 int counts = (int)s; 46 return (counts == EMPTY) ? 0 : 47 (counts >>> PARTIES_SHIFT) - (counts & UNARRIVED_MASK); 48 } 49 50 //当前Phaser的父Phaser，如果没有父节点则为null 51 private final Phaser parent; 52 53 //当前Phaser的根节点，如果不是树型结构则指向this 54 private final Phaser root; 55 56 //Treiber Stack的无锁并发栈分别来保存阶段数为奇偶数时的等待线程节点。 57 private final AtomicReference<QNode> evenQ;//当阶段数phase为偶数时的等待线程节点 58 private final AtomicReference<QNode> oddQ;//当阶段数phase为奇数时的等待线程节点 59 60 //等待队列的节点QNode类 61 static final class QNode implements ForkJoinPool.ManagedBlocker { 62 final Phaser phaser; 63 final int phase; 64 final boolean interruptible; //支持中断 65 final boolean timed; //支持超时 66 boolean wasInterrupted; 67 long nanos; 68 final long deadline; 69 volatile Thread thread; //节点线程，取消等待之后为null 70 QNode next; //指向下一个节点 71 72 QNode(Phaser phaser, int phase, boolean interruptible, 73 boolean timed, long nanos) { 74 this.phaser = phaser; 75 this.phase = phase; 76 this.interruptible = interruptible; 77 this.nanos = nanos; 78 this.timed = timed; 79 this.deadline = timed ? System.nanoTime() + nanos : 0L; 80 thread = Thread.currentThread(); 81 } 82 83 //返回true表示可以释放等待阻塞，false表示需要继续阻塞等待 84 public boolean isReleasable() { 85 if (thread == null) 86 return true; 87 if (phaser.getPhase() != phase) { 88 thread = null; 89 return true; 90 } 91 if (Thread.interrupted()) 92 wasInterrupted = true; 93 if (wasInterrupted && interruptible) { 94 thread = null; 95 return true; 96 } 97 if (timed) { 98 if (nanos > 0L) { 99 nanos = deadline - System.nanoTime(); 100 } 101 if (nanos <= 0L) { 102 thread = null; 103 return true; 104 } 105 } 106 return false; 107 } 108 109 //阻塞方法，在需要阻塞时阻塞当前线程 110 public boolean block() { 111 if (isReleasable()) 112 return true; 113 else if (!timed) 114 LockSupport.park(this); 115 else if (nanos > 0L) 116 LockSupport.parkNanos(this, nanos); 117 return isReleasable(); 118 } 119 } 120 //其他省略 121 }
从以上的内部结构可以看出：
- Phaser包含一个被volatile修饰的主状态字段state，我们知道它被划分为了四个域，分别存储相应的信息，所以Phaser还提供了从主状态中获取这些域的静态辅助方法。另外，Phaser内部也是采用的CAS方式对state变量进行更新的，所以CAS+volatile再一次保证了并发过程中的原子性、可见性、有序性。
- Phaser内部维护了父Phaser和树形分层结构的根Phaser，如果没有父Phaser则为空，如果不是树形分层结构则根Phaser等于自身。
- Phaser采用了两个Treiber Stack结构（即一种基于CAS的无锁并发栈） 分别保存当阶段数phase为奇偶数时的等待参与者线程节点，这样奇偶分离的方式能够在一定程度上避免释放和添加线程节点的竞争。节点内部类QNode的结构很简单，主要保存了一些线程等待的相关信息，还有指向下一个QNode节点的域next，isReleasable方法中的逻辑比较简单：当QNode中的thread为null、或者和phaser的阶段值不相等、或者被中断、或者等待超时，方法都返回true即释放阻塞等待，而block方法就是一个阻塞的过程。另外，QNode实现了ForkJoinPool.ManagedBlocker接口，它的作用这里暂且不提，在我们后面分析ForkJoin框架的时候在研究。
构造方法
接下来，我们分析Phaser的构造方法：
1 public Phaser() { 2 this(null, 0); 3 } 4 5 public Phaser(int parties) { 6 this(null, parties); 7 } 8 9 public Phaser(Phaser parent) { 10 this(parent, 0); 11 } 12 13 public Phaser(Phaser parent, int parties) { 14 if (parties >>> PARTIES_SHIFT != 0) //无符号右移16位，即32位的高16位，parties不能超过65535 15 throw new IllegalArgumentException("Illegal number of parties"); 16 int phase = 0; 17 this.parent = parent; 18 if (parent != null) { 19 final Phaser root = parent.root; 20 this.root = root; 21 //如果父级不为空，共享父级的线程等待队列 22 this.evenQ = root.evenQ; 23 this.oddQ = root.oddQ; 24 if (parties != 0) //如果参与者不为0，注册1个参与者到父级 25 phase = parent.doRegister(1); 26 } 27 else { //如果父级为空，root就是自身 28 this.root = this; 29 this.evenQ = new AtomicReference<QNode>(); 30 this.oddQ = new AtomicReference<QNode>(); 31 } 32 this.state = (parties == 0) ? (long)EMPTY : 33 ((long)phase << PHASE_SHIFT) | // 将pahse左移32位，即阶段数 34 ((long)parties << PARTIES_SHIFT) | //将参与者个数左移16位，即总的参与者个数 35 ((long)parties); //直接作为低16位，即未到达个数 36 }
所有的构造方法最终都是调用的同一个构造方法Phaser(Phaser parent, int parties)。通过构造方法可以知道如下几点：
- 构造Phaser的时候，参与者个数不能超过65535.
- 当有父级Phaser的时候，当前Phaser会共享父Phaser的线程等待队列.
- 当有父级Phaser的时候，并且参与者个数不为0时，会将当前Phaser作为一个参与者注册到父Phaser.同时阶段数phase也来至父级。所以子Phaser的阶段数和终止标记始终保持和父节点相同。
- 最后初始化当前Phaser的state成员时，如果参与者为0，那么state为1而不是0.
Register动态注册
通过构造方法我们知道在没有父级的存在下，Phaser非常简单，但存在父级的时候，需要将当前Phaser注册为父级的一个参与者，下面来看看doRegister(int)方法：
1 private int doRegister(int registrations) { 2 // adjustment to state 3 long adjust = ((long)registrations << PARTIES_SHIFT) | registrations; 4 final Phaser parent = this.parent; 5 int phase; 6 for (;;) { 7 long s = (parent == null) ? state : reconcileState(); //获取最新state 8 int counts = (int)s; 9 int parties = counts >>> PARTIES_SHIFT; //得到高16位 10 int unarrived = counts & UNARRIVED_MASK; //得到低16位 11 //注册的参与者数量和已存在的参与者数量加起来不能超过最大参与者数量 12 if (registrations > MAX_PARTIES - parties) 13 throw new IllegalStateException(badRegister(s)); 14 phase = (int)(s >>> PHASE_SHIFT); //得到高32位 15 if (phase < 0) //当前Phaser已经终止了，退出循环 16 break; 17 if (counts != EMPTY) { // 如果不是第一次注册 18 //如果有父节点，需再次确认根节点的state没有变化 19 if (parent == null || reconcileState() == s) { 20 if (unarrived == 0) //如果本阶段所有线程都到达了，等待root完成advance任务之后进入下一阶段之后才再次尝试注册 21 root.internalAwaitAdvance(phase, null); 22 //否则尝试CAS直接将新注册的个数同时加到总参与个数和未到达数量上去 23 else if (UNSAFE.compareAndSwapLong(this, stateOffset, s, s + adjust)) 24 break; 25 } 26 } 27 else if (parent == null) { //否则是第一次注册，但没有父节点 28 long next = ((long)phase << PHASE_SHIFT) | adjust; 29 if (UNSAFE.compareAndSwapLong(this, stateOffset, s, next)) 30 break; //直接尝试CAS更新当前state 31 } 32 else { //否则是第一次注册到子节点Phaser 33 synchronized (this) { // 锁定当前Phaser实例 34 if (state == s) { // 再次确认状态无变化 35 //由于是第一次注册子节点Phaser的参与者，需要将当前子节点注册到父节点，作为父节点的一个参与者 36 phase = parent.doRegister(1); 37 if (phase < 0) //如果根Phaser已经终止了，也就没有必要继续注册了。 38 break; 39 // finish registration whenever parent registration 40 // succeeded, even when racing with termination, 41 // since these are part of the same "transaction". 42 //不停尝试更新当前state，直到成功为止，不论是否已经终止。 43 while (!UNSAFE.compareAndSwapLong 44 (this, stateOffset, s, 45 ((long)phase << PHASE_SHIFT) | adjust)) { 46 s = state; 47 phase = (int)(root.state >>> PHASE_SHIFT); 48 // assert (int)s == EMPTY; 49 } 50 break; 51 } 52 } 53 } 54 } 55 return phase; //返回当前的阶段数 56 } 57 58 //协调state，根据JavaDoc，这种情况发生在当根Phaser的阶段数phase已经递增，但是子Phaser的阶段数phase还没有，即根阶段数的滞后传播问题。 59 //协调的办法是： 60 //若根Phaser已经终止了，则不变；若当前Phaser的参与者都被注销了（即总参与者为0），则高32位不变，低32位回到初始化Empty状态； 61 //否则是其他情况的滞后，则state的阶段数更新为与根相同，总参与者个数不变，并且将所有参与者都标记为未到达状态。 62 //由于协调之后的state的高32位是来自root的state的高32位，所以子Phaser的阶段数和是否终止的标识都是和根是一致的。根终止了，所有的子Phaser也终止了。 63 private long reconcileState() { 64 final Phaser root = this.root; 65 long s = state; 66 if (root != this) { 67 int phase, p; 68 // CAS to root phase with current parties, tripping unarrived 69 //这里是while循环+CAS的方式，不断尝试更新当前Phaser的state，当CAS失败之后，重新拿当前Phaser的最新state进行操作， 70 //直到CAS成功（成功的同时局部变量s也被更新为当前Phaser的最新state值），返回最终的state值。 71 while ((phase = (int)(root.state >>> PHASE_SHIFT)) != (int)(s >>> PHASE_SHIFT) && //根的阶段数与当前Phaser不匹配 72 !UNSAFE.compareAndSwapLong 73 (this, stateOffset, s, 74 s = (((long)phase << PHASE_SHIFT) | //这是根state的高32位; 75 ((phase < 0) ? (s & COUNTS_MASK) : //根root已经终止，取当前Phaser的state低32位. 76 (((p = (int)s >>> PARTIES_SHIFT) == 0) ? EMPTY : //根未终止，但总参与者个数为0，取Empty. 77 ((s & PARTIES_MASK) | p)))))) //根未终止，总参与者个数不变，未达到个数重置为所有参与者均未达到。即抛弃了原有的unarrived值。 78 s = state; //CAS失败之后，更新局部变量s为当前Phaser的最新state值。 79 } 80 return s; 81 }
根据以上的注册参与者方法简单梳理逻辑如下：
- 首先如果是存在父节点的树形Phaser结构，需要根据root节点的Phaser协调当前Phaser的状态state，具体的协调方式在上面注释已然很清楚，值得注意的是，协调之后当前Phaser的state高32位会保证与root一致，也就是说，当前Phaser的阶段数和终止标识会与root节点一致，所以终止root节点其实也会终止它的子节点。
- 接下来会对当前Phaser的状态进行判断，主要就是参与者个数不能超过最大值65535，如果已经终止了，也就没必要进行注册了，直接返回。
- 如果不是第一次注册参与者，那么如果本阶段所有线程都已经到达，那么需要等待root完成阶段数的递增，进入下一个阶段才能继续尝试注册；否则可以直接尝试将注册的数量同时加到当前总参与者个数和未到达个数上去。
- 如果是第一次注册参与者但不是存在父节点的树形结构，那么可以直接尝试将注册的数量同时加到当前总参与者个数和未到达个数上去。
- 如果是第一次注册参与者并且是存在父节点的树形结构，那么在锁定当前Phaser实例之后，先要将当前Phaser作为一个参与者注册到它的父节点中，然后在将注册的数量同时加到当前总参与者个数和未到达个数上去。
- 返回值是state的高32位，即阶段数和是否终止的标识，所以如果已经终止了，返回值小于0. 否则返回值表示当前参与者被注册到的阶段数。
从上面的逻辑发现，当且仅当第一次向子节点Phaser注册参与者时，都会自动向其父节点注册一个参与者（如果存在父节点的话），这样就构成了一个类似二叉树的结构，即每一个子节点Phaser都作为一个参与者被注册到父节点。所以每一个节点能被注册的参与者个数=65535 - 子节点个数。
doRegister是动态注册的最底层实现，Phaser对外部提供的注册方法都是调用的该方法完成的，这些对外部提供的注册方法如下：
1 public int register() { 2 return doRegister(1); //注册一个参与者 3 } 4 public int bulkRegister(int parties) {//一次性注册多个参与者 5 if (parties < 0) 6 throw new IllegalArgumentException(); 7 if (parties == 0) 8 return getPhase(); 9 return doRegister(parties); 10 }
其实就是一次注册一个或多个的区别，只是批量注册方法里面多个对参数的校验，当为0时，不会出错而是返回阶段数。 注册和后文的撤销只会影响内部的参与者计数，他们不会在Phaser内部保留对注册对象的跟踪，所以参与者线程不能通过查询得知自身是否被注册。（但是，你可以通过继承该类在子类中实现这样的跟踪逻辑）。
AwaitAdvance阻塞等待
在上面的逻辑第3步，当发现当前阶段已经完成，那么注册需要阻塞等待直到root完成advance结束（就是阶段数增加），才能进行，下面继续分析internalAwaitAdvance方法。
1 private int internalAwaitAdvance(int phase, QNode node) { 2 // assert root == this; 3 releaseWaiters(phase-1); // 释放无效等待的节点 4 boolean queued = false; // 节点入队标识 5 int lastUnarrived = 0; // 在发生变化时增加自旋次数 6 int spins = SPINS_PER_ARRIVAL; 7 long s; 8 int p; 9 //循环操作，直到当前阶段数发生变化，与指定的阶段数不一致 10 while ((p = (int)((s = state) >>> PHASE_SHIFT)) == phase) { 11 if (node == null) { //不可中断的自旋 12 //这里的代码是指当未到达参与者数量发生变化，且变化后的未到达数量小于CPU核数时，增加自旋次数 13 //其实就是为了在CPU资源可用时尽量通过自旋等待，从而避免线程状态在用户态和内核态之间切换带来的性能消耗。 14 int unarrived = (int)s & UNARRIVED_MASK; 15 if (unarrived != lastUnarrived && 16 (lastUnarrived = unarrived) < NCPU) 17 spins += SPINS_PER_ARRIVAL; 18 //自旋等待结束，或者当前线程被中断，就创建一个不可中断的节点 19 boolean interrupted = Thread.interrupted();//获取并清除线程的中断标记 20 if (interrupted || --spins < 0) { // need node to record intr 21 node = new QNode(this, phase, false, false, 0L); 22 node.wasInterrupted = interrupted; 23 } 24 } 25 else if (node.isReleasable()) // 如果当前节点可以释放，退出 26 break; 27 else if (!queued) { // 节点不可释放，且还没入队 28 AtomicReference<QNode> head = (phase & 1) == 0 ? evenQ : oddQ; 29 QNode q = node.next = head.get(); 30 //在队列为空，或头节点阶段数与指定的阶段数一致，并且当前阶段数无变化时，入队作为新的头节点 31 if ((q == null || q.phase == phase) && 32 (int)(state >>> PHASE_SHIFT) == phase) // avoid stale enq 33 queued = head.compareAndSet(q, node); 34 } 35 else { //node节点入队之后，阻塞等待，直到节点isReleasable或block返回true 36 //这里就是为什么QNode类要实现ForkJoinPool.ManagedBlocker的原因，因为ForkJoinPool.managedBlock控制同步阻塞的内部会通过执行被QNode重写的那两个方法来判断是否需要退出阻塞 37 try { 38 ForkJoinPool.managedBlock(node); 39 } catch (InterruptedException ie) { 40 node.wasInterrupted = true; 41 } 42 } 43 } 44 45 if (node != null) { //对于进入队列的node，重置一些属性 46 if (node.thread != null) 47 node.thread = null; //释放线程 48 if (node.wasInterrupted && !node.interruptible) 49 Thread.currentThread().interrupt(); //不可中断的节点发生了中断时，要补一个中断 50 //阶段数依旧没有发生变化，表明阻塞过程超时或者发生中断 51 if (p == phase && (p = (int)(state >>> PHASE_SHIFT)) == phase) 52 return abortWait(phase); // 释放清理超时或中断而不再等待当前阶段的节点 53 } 54 releaseWaiters(phase);//释放另一个队列中无效等待的节点 55 return p; 56 } 57 //释放那些无效的等待队列节点（就是那些阶段数与当前阶段数不一致的节点），并唤醒节点对应的线程 58 private void releaseWaiters(int phase) { 59 QNode q; // first element of queue 60 Thread t; // its thread 61 //参数phase仅仅用于取奇数或偶数队列 62 AtomicReference<QNode> head = (phase & 1) == 0 ? evenQ : oddQ; 63 while ((q = head.get()) != null && 64 q.phase != (int)(root.state >>> PHASE_SHIFT)) { 65 //如果节点对应的阶段数不等于当前阶段数，释放节点并转到下一个节点 66 if (head.compareAndSet(q, q.next) && 67 (t = q.thread) != null) { 68 q.thread = null;//释放节点线程 69 LockSupport.unpark(t); //通知线程结束等待 70 } 71 } 72 } 73 74 //该方法是releaseWaiters的变体，释放那些因为超时或者中断而不再等待当前阶段的节点，目前只释放位于队列前端的以减小内存占用 75 private int abortWait(int phase) { 76 AtomicReference<QNode> head = (phase & 1) == 0 ? evenQ : oddQ; 77 for (;;) { 78 Thread t; 79 QNode q = head.get(); 80 int p = (int)(root.state >>> PHASE_SHIFT); 81 if (q == null || ((t = q.thread) != null && q.phase == p)) 82 return p; 83 if (head.compareAndSet(q, q.next) && t != null) { 84 q.thread = null; 85 LockSupport.unpark(t); 86 } 87 } 88 }
internalAwaitAdvance的逻辑有点复杂，因为整个Phaser中所有的阻塞等待系列方法都是调用的这个方法实现的，它的作用就是阻塞当前参与者直至：①阶段数增加，即进入下一个阶段，或②节点线程被释放（这种情况只是理论上的，但是应该不会发生），或③可中断节点等待超时或中断。同时它还会对所有Phaser共享的这两个奇偶队列中的节点进行清理并唤醒对应的线程，让它们被移除队列或者继续下一个阶段的执行。具体的逻辑过程就不再一一梳理，只针对doRegister中的情形进行分析。
在doRegister中，当所有参与者都到达之后，注册操作需要阻塞直到阶段数增长（当然还有一种情况就是在internalAwaitAdvance内部创建的不可中断节点线程被释放，即thread被赋值为null）。
关于Phaser中的队列（一奇一偶），上面对于节点入队的internalAwaitAdvance方法都是被root根Phaser实例调用的（不论是AwaitAdvance系列方法还是doRegister，以及后面的arriveAndAwaitAdvance方法），所以虽然所有的子Phaser都共享了根Phaser的两个队列，但其实那些入队的节点还是严格在根Phaser的队列上操作的。
internalAwaitAdvance方法是Phaser中同步操作AwaitAdvance系列方法的实现基础，该系列的其他方法都是在它的基础上实现的，该系列的其他方法是：
1 public int awaitAdvance(int phase) { 2 final Phaser root = this.root; 3 long s = (root == this) ? state : reconcileState(); 4 int p = (int)(s >>> PHASE_SHIFT); 5 if (phase < 0) //已经终止了，直接返回 6 return phase; 7 if (p == phase) //指定的阶段数与当前阶段数相等，则进行阻塞等待直至阶段数增加 8 return root.internalAwaitAdvance(phase, null); 9 return p; 10 } 11 public int awaitAdvanceInterruptibly(int phase) throws InterruptedException{ 12 .......//省略相同的代码 13 if (p == phase) { 14 QNode node = new QNode(this, phase, true, false, 0L); 15 p = root.internalAwaitAdvance(phase, node); 16 if (node.wasInterrupted) 17 throw new InterruptedException(); 18 } 19 } 20 public int awaitAdvanceInterruptibly(int phase, 21 long timeout, TimeUnit unit) 22 throws InterruptedException, TimeoutException { 23 .......//省略相同的代码 24 if (p == phase) { 25 QNode node = new QNode(this, phase, true, true, nanos); 26 p = root.internalAwaitAdvance(phase, node); 27 if (node.wasInterrupted) 28 throw new InterruptedException(); 29 else if (p == phase) 30 throw new TimeoutException(); 31 } 32 }
Arrive/Deregister到达与撤销实现
Phaser提供了表示“到达”以及“到达并撤销”的非阻塞方法（并没有直接撤销的方法），它们会立即返回一个表示当前到达的阶段数（正常情况下返回之后的内部实际阶段数已经被递增了），它们是：
1 public int arrive() { //一个参与者到达 2 return doArrive(ONE_ARRIVAL); 3 } 4 5 public int arriveAndDeregister() { //一个参与者到达，并且撤销该参与者 6 return doArrive(ONE_DEREGISTER); 7 }
这两个方法都调用的doArrive方法，不同的是通过传入的int值区分不同的含义。arrive传入的是1，arriveAndDeregister传入的是65537，在JDK8以前的源码实现是传入的布尔值，在JDK8开始传入的int值，这样就可以只通过不同int数值直接作用到Phaser的state变量上去来完成对应的操作，而不需要根据参数的不同编写不同的代码逻辑，显得简洁的多，下面看看具体实现。
1 private int doArrive(int adjust) { 2 final Phaser root = this.root; 3 for (;;) { 4 long s = (root == this) ? state : reconcileState(); 5 int phase = (int)(s >>> PHASE_SHIFT); 6 if (phase < 0) //Phaser已经终止，立即返回 7 return phase; 8 int counts = (int)s; 9 int unarrived = (counts == EMPTY) ? 0 : (counts & UNARRIVED_MASK); 10 if (unarrived <= 0) //所有的参与者都到达了，抛异常表示本次到达非法 11 throw new IllegalStateException(badArrive(s)); 12 //直接CAS更新当前state 13 if (UNSAFE.compareAndSwapLong(this, stateOffset, s, s-=adjust)) { 14 if (unarrived == 1) {//更新当前state成功，且此次到达的刚好是最后一个参与者 15 long n = s & PARTIES_MASK; // 当前Phaser总参与者个数 16 int nextUnarrived = (int)n >>> PARTIES_SHIFT;//作为下一个阶段总参与者个数 17 if (root == this) { //是根Phaser 18 //onAdvance是可以被重写的方法，该方法返回true表示需要终止Phaser 19 if (onAdvance(phase, nextUnarrived)) 20 n |= TERMINATION_BIT; 21 else if (nextUnarrived == 0) //没有参与者了，重置为EMPTY 22 n |= EMPTY; 23 else //否则直接作为下一个阶段的总参与者个数 24 n |= nextUnarrived; 25 int nextPhase = (phase + 1) & MAX_PHASE; //阶段数递增1变成下一个阶段 26 n |= (long)nextPhase << PHASE_SHIFT; //下一个阶段数再结合下一个阶段的总参与者个数，n就是下一个阶段的state值 27 UNSAFE.compareAndSwapLong(this, stateOffset, s, n); //将根的state更新为下一个阶段的state值 28 releaseWaiters(phase); //唤醒等待线程 29 } 30 else if (nextUnarrived == 0) { // 如果不是根节点，且没有参与者了，将该子Phaser整个从父节点注销 31 phase = parent.doArrive(ONE_DEREGISTER); 32 UNSAFE.compareAndSwapLong(this, stateOffset, s, s | EMPTY); 33 } 34 else //非根节点所有参与者都到达了，执行父类的doArrive(1)方法 35 //因为注册的时候，每一个子Phaser都会作为父节点的一个参与者，所以当子Phaser的所有参与者都到达之后，父节点也需要将自己的未到达个数减1。 36 phase = parent.doArrive(ONE_ARRIVAL); 37 } 38 return phase; //更新state成功之后返回 39 } 40 } 41 }
以上doArrive方法看似复杂，其实很好理解，其逻辑梳理如下:
- 如果当前Phaser已经终止，那么立即返回，如果当前Phaser所有参与者都已经到达当前阶段数将会抛出非法异常（因此不要在同一个线程的同一阶段内重复调用多次arrive）。
- 直接CAS方式尝试更新当前state，直到成功。更新成功之后，如果当前线程不是最后一个到达的参与者，就直接返回了；否则如果发现当前线程刚好是所有参与者中最后一个到达的线程则：
- 如果存在父节点，会根据计算出来的下一个阶段的参与者数量作不同的处理：如果下一个阶段已经没有参与者了，那么就向父节点发起到达并撤销操作；否则向父节点发起简单的到达操作，告知作为父节点的一个参与者的当前子Phaser已经到达。
- 如果不存在父节点（这种情况要么不是树形结构，要么是根节点），根据计算出来的下一个阶段的参与者数量要么终止Phaser，要么重置为Empty状态，要么调整state为下一个阶段的值。
通过doArrive方法可见，阶段数的递增是由根节点完成的，在树形Phaser结构中，任何一个子节点Phaser中的所有参与者到达之后都需要将到达传递到父节点，这是很好理解的，因为在注册参与者的时候，子节点Phaser也是作为一个独立的参与者注册到父节点的，这种到达机制最终就像冒泡一样，从最底层一直到根节点，最后当整棵树的参与者都到达之后，才由根节点来完成对阶段数的递增，从而使整个树形Phaser进入下一个阶段。
由注册和到达撤销操作可见，在一个分层phasers的树型结构中，向父phaser节点注册和撤销子phaser节点都是被自动管理的，即：当被注册的子phaser的参与者个数变成非零时（通过构造方法，register或bulkRegister方法），该子phaser将会向其父phaser注册。当调用arriveAndDeregister方法导致子phaser的参与者个数变为0时，子phaser会从父phaser中被撤销。
ArriveAndAwaitAdvance到达与等待的结合
上面介绍了arrive（到达）和awaitAdvance（阻塞等待）两种Phaser的机制，最后还有一个特殊的方法，它把到达与等待两种效果结合到了一起，它就是arriveAndAwaitAdvance：
1 public int arriveAndAwaitAdvance() { 2 // Specialization of doArrive+awaitAdvance eliminating some reads/paths 3 final Phaser root = this.root; 4 for (;;) { 5 long s = (root == this) ? state : reconcileState(); 6 int phase = (int)(s >>> PHASE_SHIFT); 7 if (phase < 0) 8 return phase; //如果Phaser终止了直接返回 9 int counts = (int)s; 10 int unarrived = (counts == EMPTY) ? 0 : (counts & UNARRIVED_MASK); 11 if (unarrived <= 0) //如果所有参与者都到达了，抛异常 12 throw new IllegalStateException(badArrive(s)); 13 //CAS更新当前state以减少一个未到达者 14 if (UNSAFE.compareAndSwapLong(this, stateOffset, s, s -= ONE_ARRIVAL)) { 15 if (unarrived > 1) //不是最后一个到达者，则阻塞等待阶段数增长 16 return root.internalAwaitAdvance(phase, null); 17 if (root != this) //是最后一个到达者，交给根节点来处理 18 return parent.arriveAndAwaitAdvance(); 19 //下面的逻辑将被根Phaser执行 20 long n = s & PARTIES_MASK; // base of next state 21 int nextUnarrived = (int)n >>> PARTIES_SHIFT; 22 if (onAdvance(phase, nextUnarrived)) 23 n |= TERMINATION_BIT; 24 else if (nextUnarrived == 0) 25 n |= EMPTY; 26 else 27 n |= nextUnarrived; 28 int nextPhase = (phase + 1) & MAX_PHASE; 29 n |= (long)nextPhase << PHASE_SHIFT; 30 if (!UNSAFE.compareAndSwapLong(this, stateOffset, s, n)) 31 return (int)(state >>> PHASE_SHIFT); // terminated 32 releaseWaiters(phase); 33 return nextPhase; 34 } 35 } 36 }
终结Phaser
Phaser可以进入一个终结状态，当终止Phaser之后，所有的同步方法（例如awaitAdvance系列方法）都不会再继续等待下一个阶段的到来而是直接返回，Phaser支持动态终结与强制立即终结两种方式。通过重写Phaser的onAdvance方法可以实现动态终结，因为在同步的过程中，Phaser内部会调用该方法用于对终结的控制，如果该方法返回true就会触发Phaser的终结，以下是onAdvance的默认实现：
重写onadvance可以动态终结phaser:
1 protected boolean onAdvance(int phase, int registeredParties) { 2 return registeredParties == 0; 3 }
通过上面的源码分析，onAdvance会被arrive(), arriveAndDeregister() 和arriveAndAwaitAdvance()方法调用，默认只会在当整个树形结构中（如果是树形结构的话）总的参与者个数都被撤销，即总的参与者个数为0的时候才会返回true，从而导致整个树形Phaser被终结。当我们想通过Phaser控制一个固定的执行迭代次数时，就可以很方便地重写这个方法，以使程序运行中在当前阶段数到达阀值得时候就返回true来触发终结。
另一个强制立即终结Phaser的方式就是执行forceTermination方法，它的源码如下：
1 public void forceTermination() { 2 // Only need to change root state 3 final Phaser root = this.root; 4 long s; 5 while ((s = root.state) >= 0) { 6 if (UNSAFE.compareAndSwapLong(root, stateOffset, s, s | TERMINATION_BIT)) { 7 // signal all threads 8 releaseWaiters(0); // Waiters on evenQ 9 releaseWaiters(1); // Waiters on oddQ 10 return; 11 } 12 } 13 }
很简单，就是不断尝试将根的状态置为终止状态，直到成功之后唤醒所有的线程再退出。可见，终结任意一个树形结构中的Phaser都将导致终结整颗树形结构中的所有Phaser。
状态监控
以上控制同步的方法（例如awaitAdvance系列方法）只能被参与者调用，而Phaser的当前状态可以被任何调用者监控，只要握有Phaser的实例引用即可。 监控Phaser当前状态的方法主要有以下这些：
1 //获取当前阶段数，如果已经终止了，返回值是负数，当到达最大值Integer.MAX_VALUE之后会从0开始 2 //当返回值是负数时，通过加上Integer.MAX_VALUE可以获得在终止前的阶段数。 3 public final int getPhase() { 4 return (int)(root.state >>> PHASE_SHIFT); 5 } 6 //获取总参与者个数 7 public int getRegisteredParties() { 8 return partiesOf(state); 9 } 10 //返回已到达当前阶段的参与者个数，在终止之后该方法的返回值是无意义和任意的。 11 public int getArrivedParties() { 12 return arrivedOf(reconcileState()); 13 } 14 //返回未到达当前阶段的参与者个数，在终止之后该方法的返回值是无意义和任意的。 15 public int getUnarrivedParties() { 16 return unarrivedOf(reconcileState()); 17 } 18 //如果Phaser已经被终止，返回true 19 public boolean isTerminated() { 20 return root.state < 0L; 21 } 22 //三个状态的字符串形式，是一种日志信息监控的快照格式 23 private String stateToString(long s) { 24 return super.toString() + 25 "[phase = " + phaseOf(s) + 26 " parties = " + partiesOf(s) + 27 " arrived = " + arrivedOf(s) + "]"; 28 }
由于这些状态是瞬息变化的，只能反映短暂的状态，所以一般在同步方法控制中没什么用。
应用示例
示例一： 来至Java Doc中Phaser代替CountDownLatch的示例。
1 void runTasks(List tasks) { 2 //初始化参与者个数为1，表示注册主线程自己 3 final Phaser phaser = new Phaser(1); // "1" to register self 4 5 for (final Runnable task : tasks) { 6 phaser.register();//非阻塞的动态注册每一个Task线程为一个参与者 7 new Thread() { 8 public void run() { 9 phaser.arriveAndAwaitAdvance(); // 阻塞，直到主线程调用完arriveAndDeregister方法，以及其他Task线程也执行了该方法 10 task.run(); 11 } 12 }.start(); 13 } 14 15 //主线程准备工作 16 .... 17 phaser.arriveAndDeregister(); //主线程准备完毕 18 }
上例中，初始化时new Phaser(1)；可以看成将主线程注册成为了一个参与者，在创建每一个task线程之前又调用了register();相当于将每一个task线程注册成为一个参与者，最后就是arriveAndAwaitAdvance方法，arriveAndAwaitAdvance表示当前线程到达并且阻塞等待其它所有参与者也达到之后，阶段数递增之后才返回。所以一旦主线程执行了arriveAndDeregister并且所有的Task线程都执行了arriveAndAwaitAdvance方法，才会执行每个Task的run方法。这个例子是使用主线程来控制可变数量的参与者线程的执行、并且是同时执行。 值得一提的是，由于Phaser的注册仅仅是对内部的参与者计数器的更新，他们不会在Phaser内部保留对注册线程对象的跟踪，所以上面的所有注册动作完全也可以由初始化完成：new Phaser(1+tasks.size()); 这是显得不够优雅而已。
示例二：来至Java Doc中通过重写onAdvance使一组线程重复迭代执行指定的次数：
1 void startTasks(List tasks, final int iterations) { 2 final Phaser phaser = new Phaser() { 3 //重写了onAdvance方法，只有当阶段数>=需要重复执行的次数、或参与者个数为0的时候才终止该Phaser 4 protected boolean onAdvance(int phase, int registeredParties) { 5 return phase >= iterations || registeredParties == 0; 6 } 7 }; 8 phaser.register();//注册主线程自己 9 for (final Runnable task : tasks) { 10 phaser.register();//注册每一个Task线程 11 new Thread() { 12 public void run() { 13 //循环执行task.run方法，直到Phaser终止（即循环iterations次） 14 do { 15 task.run(); 16 phaser.arriveAndAwaitAdvance(); 17 } while (!phaser.isTerminated()); 18 } 19 }.start(); 20 } 21 //非阻塞，主线程到达并撤销自身的注册。 22 phaser.arriveAndDeregister(); // deregister self, don't wait 23 }
首先，重写了onAdvance方法，该方法会在所有参与者都到达之后，阶段数递增之前被根Phaser调用，返回true就自动终结整个Phaser，所以当阶段数递增到iterations后就终结了。注册就不说了，与例一不同的是，主线程换成了执行arriveAndDeregister以非阻塞的方式标识自己到达了并且把自己从Phaser的参与者中撤销了（这样做就不会再影响到那些Task任务的执行了），而每一个Task线程执行完task.run之后执行arriveAndAwaitAdvance将会等待其他所有Task线程都到达这里，然后由最后一个到达的线程去执行onAdvance方法，如果onAdvance方法返回true那么该Phaser就会被终止（这时候所有线程在执行phaser.isTerminated()检测Phaser的终结状态都将会返回true），否则在阶段数递增1之后，所有Task线程继续在do..while语句中循环执行。这样就可以使阶段数从0递增到iterations，从而使所有Task线程迭代执行了iterations次。
在例二中，主线程通过执行非阻塞的arriveAndDeregister方法来告知Phaser自己到达并撤销自己，之后就和Phaser脱离了关系，如果想要主线程也等待Phaser的终止，那么可以在主线程调用完arriveAndDeregister之后，再次注册并通过不断的循环来等待Phaser的终结：
1 phaser.register(); 2 while (!phaser.isTerminated()) 3 phaser.arriveAndAwaitAdvance();
通过上面这个循环，使主线程也参与了迭代，每一次Phaser在执行onAdvance前也都需要等待主线程执行arriveAndAwaitAdvance。
示例三： 来至Java Doc中使一段程序循环执行指定的阶段数：
1 void awaitPhase(Phaser phaser, int phase) { 2 int p = phaser.register(); //假设调用者线程还没有注册 3 while (p < phase) { 4 if (phaser.isTerminated()) 5 // 处理意外的终止情况.... 6 else 7 p = phaser.arriveAndAwaitAdvance();//如果还没有被终止，那么调用该方法会导致阶段数递增（即返回值p会不断递增） 8 } 9 phaser.arriveAndDeregister();//取消调用者的注册 10 }
不同于示例二，该例仅仅是让一段逻辑而不是多个线程循环执行指定的阶段数，该例首先注册调用者当前线程（假设事先没有注册），因为arriveAndAwaitAdvance方法返回的是下一个阶段数，而阶段数又是从0开始递增，所以其返回值就代表循环迭代的次数。但是该例要确保指定的阶段数参数不会超过最大值Integer.MAX_VALUE。
示例四：来至Java Doc中构建树形Phaser。
1 void build(Task[] tasks, int lo, int hi, Phaser ph) { 2 if (hi - lo > TASKS_PER_PHASER) { 3 for (int i = lo; i < hi; i += TASKS_PER_PHASER) { 4 int j = Math.min(i + TASKS_PER_PHASER, hi); 5 build(tasks, i, j, new Phaser(ph)); 6 } 7 } else { 8 for (int i = lo; i < hi; ++i) 9 tasks[i] = new Task(ph); 10 // 假设new Task(ph) 中将会执行注册方法ph.register() 11 } 12 }}
上例中其实就是构建了一个两层的树形Phase结构，在其他地方调用该方法传入的参数ph就是根Phaser，然后由lo至hi 按照每批TASKS_PER_PHASER个Task创建一个子Phaser。例如这样调用 build(new Task[n], 0, n, new Phaser())；如果TASKS_PER_PHASER等于4，那么就是根下面的每个子Phaser最多拥有4个参与者Task，总的参与者个数应该是 n + (int) Math.ceil( n/TASKS_PER_PHASER )，因为每一个子Phaser也会作为一个参与者注册到父Phaser中。TASKS_PER_PHASER的取值大小决定于期望的同步率，像低至4的取值可能适用于每个阶段的任务执行体非常小，因此速率很高，或者高达成百上千个适用于大任务。
总结
经过上面对Parser进行源码分析，已经基本上能够很清楚的理解其工作原理了，每个Parser最多可以注册65535个参与者线程，但是可以使用树形分层结构来满足更多的参与者个数，整个树形结构就类似像一个二叉树一样，根节点Phaser只有一个，然后每个父节点可以有不超过65535个参与者，它的每个子节点Pahser也分别作为一个参与者被注册到父节点，当一个子节点Pahser的所有参与者都到达之后，将通知其父节点该子节点对应的参与者到达，并且将这些到达的参与者阻塞，直到阶段数递增或者整个Pahser被终结，当父节点中的所有参与者都到达之后，再通知父节点的父节点，以这种就像冒泡一样的机制向上传递，直到整颗树的参与者都到达之后，执行onAdvance方法确认是否需要终止整个Phaser，如果否，那么递增阶段数phase，唤醒所有阻塞在上一个阶段数的参与者，继续下一轮的执行。一旦终结树形结构中的任意一个Phaser都将终结整颗树形结构中的所有Phaser。
浙公网安备 33010602011771号