【Java并发工具】CyclicBarrier

目录

1 前言

2 示例

3 实现原理

3.1 成员变量

3.2 构造方法

3.3 await方法

3.4 reset方法

4 CyclicBarrier和CountDownLatch的区别

---

1 前言

本人使用jdk8版本。

CyclicBarrier的字面意思是可循环使用（Cyclic）的屏障（Barrier）。它要做的事情是，让一组线程到达一个屏障（也可以叫同步点）时被阻塞，直到最后一个线程到达屏障时，屏障才会开门，所有被屏障拦截的线程才会继续运行。在功能上与CountDownLatch非常相似，但也提供了一些CountDownLatch不具备的功能。CountDownLatch可以参考：CountDownLatch。

CyclicBarrier 默认的构造方法是 CyclicBarrier(int parties)，其参数表示 屏障拦截的线程数量，每个线程调用 await 方法告诉 CyclicBarrier 我已经到达了屏障，然后当前线程被阻塞。

2 示例

CyclicBarrier 提供一个高级的构造函数CyclicBarrier(int parties，Runnable barrierAction)，用于在所有线程到达屏障时，优先执行barrierAction，方便处理更复杂的业务场景。

public static class CyclicBarrierTest2 {
    static CyclicBarrier c = new CyclicBarrier(2, new A());

    public static void main(String[] args) {
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    c.await();
                } catch (Exception e) {
                }
                System.out.println(1);
            }
        }).start();
        try {
            c.await();
        } catch (Exception e) {
        }
        System.out.println(2);
    }

    static class A implements Runnable {
        @Override
        public void run() {
            System.out.println(3);
        }
    }
}

上面的执行结果为：3,1,2或3,2,1。因为在两个线程到达屏障后，main线程和new的线程会同时被唤醒，之后的打印代码谁先执行是不确定的。

3 实现原理

CyclicBarrier内部使用ReentrantLock和Condition来进行等待/通知，Condition参考：Condition接口——等待/通知工具。

3.1 成员变量

    private final ReentrantLock lock = new ReentrantLock();
    // 用来使线程等待在lock上，同Object.wait()
    private final Condition trip = lock.newCondition();
    // 需等待的线程数量
    private final int parties;
    // 所有线程到达屏障点后率先执行的线程
    private final Runnable barrierCommand;
    // 需等待的线程数量，用来判断是否为0
    private int count;

3.2 构造方法

    public CyclicBarrier(int parties) {
        this(parties, null);
    }

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

3.3 await方法

await()中主要执行的dowait()，所以这里分析dowait()方法。首先要获取锁，然后判断要等待的线程是否被中断，是则整个屏障重置，所有已经等待的线程被唤醒。接着讲count-1，判断陷入等待的线程数量是否达到指定值，是则执行指定的结束线程，否则是通过Condition.await()使当前线程等待在lock上。下面只给出了关键代码：

private int dowait(boolean timed, long nanos)
        throws InterruptedException, BrokenBarrierException,TimeoutException {

        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            // 若要等待的线程被中断，则整个屏障重置，所有已经等待的线程被唤醒
            if (Thread.interrupted()) {
                breakBarrier();
                throw new InterruptedException();
            }

            int index = --count;        // 剩下需要等待的线程数
            if (index == 0) {           // 所有线程都等待了，开启屏障
                final Runnable command = barrierCommand;
                if (command != null)
                   command.run();        // command执行完成后的指定线程
            }

            // 在循环中通过Condition.await()使当前线程等待在lock上
            for (;;) {                    
                if (!timed)
                        trip.await();
                    else if (nanos > 0L)
                        nanos = trip.awaitNanos(nanos);
            }
        } finally {
            lock.unlock();
        }
}

3.4 reset方法

唤醒所有等待在lock上的线程，并将成员变量恢复初始值。

    public void reset() {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            // 重置屏障
            breakBarrier();   
            nextGeneration(); 
        } finally {
            lock.unlock();
        }
    }

    private void breakBarrier() {
        generation.broken = true;
        count = parties;
        trip.signalAll();
    }

4 CyclicBarrier和CountDownLatch的区别

1. CountDownLatch的计数器只能使用一次，而CyclicBarrier的计数器可以使用reset()方法重置。
2. CyclicBarrier提供了其它有用的方法，如：getNumberWaiting方法可以获得CyclicBarrier阻塞的线程数量，isBroken()方法用来了解阻塞的线程是否被中断。
3. CyclicBarrier的高级构造方法能指定所有线程到达屏障后先执行的动作，能够适应更复杂的使用场景。