死磕Java并发：J.U.C之并发工具类：CyclicBarrier

作者：chenssy

来源：Java技术栈公众号

CyclicBarrier，一个同步辅助类，在API中是这么介绍的：

它允许一组线程互相等待，直到到达某个公共屏障点 (common barrier point)。在涉及一组固定大小的线程的程序中，这些线程必须不时地互相等待，此时 CyclicBarrier 很有用。因为该 barrier 在释放等待线程后可以重用，所以称它为循环 的 barrier。

通俗点讲就是：让一组线程到达一个屏障时被阻塞，直到最后一个线程到达屏障时，屏障才会开门，所有被屏障拦截的线程才会继续干活。

实现分析 CyclicBarrier的结构如下：

通过上图我们可以看到CyclicBarrier的内部是使用重入锁ReentrantLock和Condition。它有两个构造函数：

• CyclicBarrier(int parties)：创建一个新的 CyclicBarrier，它将在给定数量的参与者（线程）处于等待状态时启动，但它不会在启动 barrier 时执行预定义的操作。

• CyclicBarrier(int parties, Runnable barrierAction) ：创建一个新的 CyclicBarrier，它将在给定数量的参与者（线程）处于等待状态时启动，并在启动 barrier 时执行给定的屏障操作，该操作由最后一个进入 barrier 的线程执行。

parties表示拦截线程的数量。

barrierAction 为CyclicBarrier接收的Runnable命令，用于在线程到达屏障时，优先执行barrierAction ，用于处理更加复杂的业务场景。

1. public CyclicBarrier(int parties, Runnable barrierAction) {

2.    if (parties <= 0) throw new IllegalArgumentException();

3.    this.parties = parties;

4.    this.count = parties;

5.    this.barrierCommand = barrierAction;

6. }

7. public CyclicBarrier(int parties) {

8.    this(parties, null);

9. }

在CyclicBarrier中最重要的方法莫过于await()方法，在所有参与者都已经在此 barrier 上调用 await 方法之前，将一直等待。如下：

1. public int await() throws InterruptedException, BrokenBarrierException {

2.    try {

3.        return dowait(false, 0L);//不超时等待

4.    } catch (TimeoutException toe) {

5.        throw new Error(toe); // cannot happen

6.    }

7. }

await()方法内部调用dowait(boolean timed, long nanos)方法：

1. private int dowait(boolean timed, long nanos)

2.        throws InterruptedException, BrokenBarrierException,

3.        TimeoutException {

4.    //获取锁

5.    final ReentrantLock lock = this.lock;

6.    lock.lock();

7.    try {

8.        //分代

9.        final Generation g = generation;

10.        //当前generation“已损坏”，抛出BrokenBarrierException异常

11.        //抛出该异常一般都是某个线程在等待某个处于“断开”状态的CyclicBarrie

12.        if (g.broken)

13.            //当某个线程试图等待处于断开状态的 barrier 时，或者 barrier 进入断开状态而线程处于等待状态时，抛出该异常

14.            throw new BrokenBarrierException();

15.        //如果线程中断，终止CyclicBarrier

16.        if (Thread.interrupted()) {

17.            breakBarrier();

18.            throw new InterruptedException();

19.        }

20.        //进来一个线程 count - 1

21.        int index = --count;

22.        //count == 0 表示所有线程均已到位，触发Runnable任务

23.        if (index == 0) {  // tripped

24.            boolean ranAction = false;

25.            try {

26.                final Runnable command = barrierCommand;

27.                //触发任务

28.                if (command != null)

29.                    command.run();

30.                ranAction = true;

31.                //唤醒所有等待线程，并更新generation

32.                nextGeneration();

33.                return 0;

34.            } finally {

35.                if (!ranAction)

36.                    breakBarrier();

37.            }

38.        }

39.        for (;;) {

40.            try {

41.                //如果不是超时等待，则调用Condition.await()方法等待

42.                if (!timed)

43.                    trip.await();

44.                else if (nanos > 0L)

45.                    //超时等待，调用Condition.awaitNanos()方法等待

46.                    nanos = trip.awaitNanos(nanos);

47.            } catch (InterruptedException ie) {

48.                if (g == generation && ! g.broken) {

49.                    breakBarrier();

50.                    throw ie;

51.                } else {

52.                    // We're about to finish waiting even if we had not

53.                    // been interrupted, so this interrupt is deemed to

54.                    // "belong" to subsequent execution.

55.                    Thread.currentThread().interrupt();

56.                }

57.            }

58.            if (g.broken)

59.                throw new BrokenBarrierException();

60.            //generation已经更新，返回index

61.            if (g != generation)

62.                return index;

63.            //“超时等待”，并且时间已到,终止CyclicBarrier，并抛出异常

64.            if (timed && nanos <= 0L) {

65.                breakBarrier();

66.                throw new TimeoutException();

67.            }

68.        }

69.    } finally {

70.        //释放锁

71.        lock.unlock();

72.    }

73. }

其实await()的处理逻辑还是比较简单的：如果该线程不是到达的最后一个线程，则他会一直处于等待状态，除非发生以下情况：

1. 最后一个线程到达，即index == 0

2. 超出了指定时间（超时等待）

3. 其他的某个线程中断当前线程

4. 其他的某个线程中断另一个等待的线程

5. 其他的某个线程在等待barrier超时

6. 其他的某个线程在此barrier调用reset()方法。reset()方法用于将屏障重置为初始状态。

在上面的源代码中，我们可能需要注意Generation 对象，在上述代码中我们总是可以看到抛出BrokenBarrierException异常，那么什么时候抛出异常呢？如果一个线程处于等待状态时，如果其他线程调用reset()，或者调用的barrier原本就是被损坏的，则抛出BrokenBarrierException异常。同时，任何线程在等待时被中断了，则其他所有线程都将抛出BrokenBarrierException异常，并将barrier置于损坏状态。

同时，Generation描述着CyclicBarrier的更显换代。在CyclicBarrier中，同一批线程属于同一代。当有parties个线程到达barrier，generation就会被更新换代。其中broken标识该当前CyclicBarrier是否已经处于中断状态。

1. private static class Generation {

2.    boolean broken = false;

3. }

默认barrier是没有损坏的。

当barrier损坏了或者有一个线程中断了，则通过breakBarrier()来终止所有的线程：

1. private void breakBarrier() {

2.    generation.broken = true;

3.    count = parties;

4.    trip.signalAll();

5. }

在breakBarrier()中除了将broken设置为true，还会调用signalAll将在CyclicBarrier处于等待状态的线程全部唤醒。

当所有线程都已经到达barrier处（index == 0），则会通过nextGeneration()进行更新换地操作，在这个步骤中，做了三件事：唤醒所有线程，重置count，generation。

1. private void nextGeneration() {

2.    trip.signalAll();

3.    count = parties;

4.    generation = new Generation();

5. }

CyclicBarrier同时也提供了await(long timeout, TimeUnit unit) 方法来做超时控制，内部还是通过调用doawait()实现的。

应用场景 CyclicBarrier试用与多线程结果合并的操作，用于多线程计算数据，最后合并计算结果的应用场景。比如我们需要统计多个Excel中的数据，然后等到一个总结果。我们可以通过多线程处理每一个Excel，执行完成后得到相应的结果，最后通过barrierAction来计算这些线程的计算结果，得到所有Excel的总和。

应用示例 比如我们开会只有等所有的人到齐了才会开会，如下：

1. public class CyclicBarrierTest {private static CyclicBarrier cyclicBarrier;

2. static class CyclicBarrierThread extends Thread{

3.    public void run() {

4.        System.out.println(Thread.currentThread().getName() + "到了");

5.        //等待

6.        try {

7.            cyclicBarrier.await();

8.        } catch (Exception e) {

9.            e.printStackTrace();

10.        }

11.    }

12. }

13. public static void main(String[] args){

14.    cyclicBarrier = new CyclicBarrier(5, new Runnable() {

15.        @Override

16.        public void run() {

17.            System.out.println("人到齐了，开会吧....");

18.        }

19.    });

20.    for(int i = 0 ; i < 5 ; i++){

21.        new CyclicBarrierThread().start();

22.    }

23. }}

运行结果：

- END -

 往期推荐：

• 死磕Java系列：

……

• Spring系列：

……

可关注我的公众号

深入交流、更多福利

扫码加入我的知识星球

点击“阅读原文”，看本号其他精彩内容