JUC-并发编程14-CyclicBarrier栅栏

1、简介

CyclicBarrier，回环栅栏，它会阻塞一组线程直到这些线程同时达到某个条件才继续执行。它与CountDownLatch很类似，但又不同，CountDownLatch需要调用countDown()方法触发事件，而CyclicBarrier不需要，它就像一个栅栏一样，当一组线程都到达了栅栏处才继续往下走。

 public static void main(String[] args) throws BrokenBarrierException, InterruptedException     
    {
        CyclicBarrier cyclicBarrier = new CyclicBarrier(3);
        for (int i = 0; i <3 ; i++) {
            new Thread(() -> {
                try {
                    System.out.println("线程"+Thread.currentThread().getName()+"准备就绪");
                    cyclicBarrier.await();
                } catch (Exception e) {
                    e.printStackTrace();
                }
                System.out.println("线程"+Thread.currentThread().getName()+"执行结束");
            }).start();
        }
        Thread.sleep(1000);
        System.out.println("Main thread is done");
    }

2、源码分析

2.1 主要内部类

private static class Generation {
        boolean broken = false;
    }

Generation，中文翻译为代，一代人的代，用于控制CyclicBarrier的循环使用。

比如，上面示例中的三个线程完成后进入下一代，继续等待三个线程达到栅栏处再一起执行，而CountDownLatch则做不到这一点，CountDownLatch是一次性的，无法重置其次数。

2.2 主要属性

    /**防护栅栏入口的锁-重入锁 */
    private final ReentrantLock lock = new ReentrantLock();
    /** 等待直到跳闸的条件出现*/
    private final Condition trip = lock.newCondition();
    /** 需要等待的线程数量 */
    private final int parties;
    /* 当唤醒的时候执行的命令*/
    private final Runnable barrierCommand;
    /**代 */
    private Generation generation = new Generation();
    /** 当前这一代还需要等待的线程数*/
    private int count;

通过属性可以看到，CyclicBarrier内部是通过重入锁的条件锁来实现的。假如初始时 count=parties=3，当第一个线程到达栅栏处，count减1，然后把它加入到Condition的队列中，第二个线程到达栅栏处也是如此，第三个线程到达栅栏处，count减为0，调用Condition的signalAll()通知另外两个线程，然后把它们加入到AQS的队列中，等待当前线程运行完毕，调用lock.unlock()的时候依次从AQS的队列中唤醒一个线程继续运行，也就是说实际上三个线程先依次（排队）到达栅栏处，再依次往下运行。

2.3 构造方法

public CyclicBarrier(int parties, Runnable barrierAction) {
        if (parties <= 0) throw new IllegalArgumentException();
        this.parties = parties;
        this.count = parties;
        this.barrierCommand = barrierAction;
    }

2.4 await()方法

public int await() throws InterruptedException, BrokenBarrierException {
        try {
            return dowait(false, 0L);
        } catch (TimeoutException toe) {
            throw new Error(toe); // cannot happen
        }
    }

 private int dowait(boolean timed, long nanos)
        throws InterruptedException, BrokenBarrierException,
               TimeoutException {
        final ReentrantLock lock = this.lock;
        //加锁
        lock.lock();
        try {
            //当前代
            final Generation g = generation;
            //检查
            if (g.broken)
                throw new BrokenBarrierException();
            //中断检查
            if (Thread.interrupted()) {
                breakBarrier();
                throw new InterruptedException();
            }
            //count的值减1
            int index = --count;
            //如果数量见到0了，走这段逻辑(最后一个线程走这里)
            if (index == 0) {  // tripped
                boolean ranAction = false;
                try { 
                    //如果初始化的时候传了命令，这里执行
                    final Runnable command = barrierCommand;
                    if (command != null)
                        command.run();
                    ranAction = true;
                    //调用下一方法
                    nextGeneration();
                    return 0;
                } finally {
                    if (!ranAction)
                        breakBarrier();
                }
            }

            // loop until tripped, broken, interrupted, or timed out
            for (;;) {
                try {
                    if (!timed)
                        trip.await();
                    else if (nanos > 0L)
                        nanos = trip.awaitNanos(nanos);
                } catch (InterruptedException ie) {
                    if (g == generation && ! g.broken) {
                        breakBarrier();
                        throw ie;
                    } else {
                        // We're about to finish waiting even if we had not
                        // been interrupted, so this interrupt is deemed to
                        // "belong" to subsequent execution.
                        Thread.currentThread().interrupt();
                    }
                }

                if (g.broken)
                    throw new BrokenBarrierException();

                if (g != generation)
                    return index;

                if (timed && nanos <= 0L) {
                    breakBarrier();
                    throw new TimeoutException();
                }
            }
        } finally {
            lock.unlock();
        }
    }

 private void nextGeneration() {
        // signal completion of last generation
        // 调用condition的signalAll()将其队列中的等待者全部转移到AQS的队列中
        trip.signalAll();
        // set up next generation
        count = parties;
        generation = new Generation();
    }

dowait()方法里的整个逻辑分成两部分：

1. 最后一个线程走上面的逻辑，当count减为0的时候，打破栅栏，它调用nextGeneration()方法通知条件队列中的等待线程转移到AQS的队列中等待被唤醒，并进入下一代。
2. 非最后一个线程走下面的for循环逻辑，这些线程会阻塞在condition的await()方法处，它们会加入到条件队列中，等待被通知，当它们唤醒的时候已经更新换“代”了，这时候返回。

2.5 图解

 3、总结

1. CyclicBarrier会使一组线程阻塞在await()处，当最后一个线程到达时唤醒（只是从条件队列转移到AQS队列中）前面的线程大家再继续往下走；
2. CyclicBarrier不是直接使用AQS实现的一个同步器；
3. CyclicBarrier基于ReentrantLock及其Condition实现整个同步逻辑；

4、对比

CyclicBarrier与CountDownLatch的异同？

1. 前者是最后一个线程到达时自动唤醒；
2. 后者是通过显式地调用countDown()实现的；
3. 两者都能实现阻塞一组线程等待被唤醒；
4. 前者是通过重入锁及其条件锁实现的，后者是直接基于AQS实现的；
5. 前者具有“代”的概念，可以重复使用，后者只能使用一次；
6. 前者只能实现多个线程到达栅栏处一起运行；
7. 后者不仅可以实现多个线程等待一个线程条件成立，还能实现一个线程等待多个线程条件成立（详见CountDownLatch那章使用案例）；