CyclicBarrier源码分析

简单介绍

Cyclibarrier内部持有Lock和Condition对象,定义一个资源的值,然后开启与资源值相同数量的线程,在线程运行期间,调用await()方法暂停执行,当所有线程都调用完await()方法,资源数量将达到0,最后一次调用await()的线程,在Cyclibarrier内部,会执行signalAll()唤醒所有等待线程。说的意思就是让一组线程等待直到一个屏障条件到达才接着执行后续代码。也叫循环栅栏,和CountDownLatch差不多,但是有区别。
共享锁：同时有多个线程可以抢占到锁。

源码解析

package com;
import java.util.concurrent.CyclicBarrier;

public class CyclicBarrierTest {
    static class MyThread extends Thread {
        private CyclicBarrier cyclicBarrier;

        public MyThread(CyclicBarrier cyclicBarrier) {
            this.cyclicBarrier = cyclicBarrier;
        }

        @Override
        public void run() {
            System.out.println("线程" + Thread.currentThread().getName() + "正在准备...");
            try {
                Thread.sleep(5000)
                System.out.println("线程" + Thread.currentThread().getName() + "准备完毕");
                cyclicBarrier.await();
            } catch (Exception e) {
                e.printStackTrace();
            }
            System.out.println(Thread.currentThread().getName() + "所有线程准备完毕，各自继续处理其他任务...");
        }
    }

    public static void main(String[] args) {
        int cnt = 4;
        CyclicBarrier cyclicBarrier = new CyclicBarrier(cnt);
        for (int i = 0; i < cnt; i++) {
            new MyThread(cyclicBarrier).start();
        }
    }
}

执行结果:

从上面可以看出,每一个线程都必须等到所有线程准备完毕之后才能各自执行其后续操作,这个条件就是屏障状态barrier,当调用cyclicBarrier.await()方法之后,线程处于等待barrier状态而无法执行后续的程序代码。

CyclicBarrier属性

/** 保护CyclicBarrier对象入口的重入锁 */
    private final ReentrantLock lock = new ReentrantLock();
    /** 用于线程间的等待与唤醒操作 */
    private final Condition trip = lock.newCondition();
    /** 拦截的线程数 */
    private final int parties;
    /* 所有线程到达barrier时执行的任务 */
    private final Runnable barrierCommand;
    /** 当前的Generation，每当栅栏失效或者开闸之后都会自动替换掉。从而实现重置的功能 */
    private Generation generation = new Generation();
    /**
     * 还能阻塞的线程数（即parties-当前阻塞的线程数）
     */
    private int count;

CyclicBarrier构造方法

 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;
}    

dowait

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();
            }

            int index = --count;
            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)
                        //设置当前代的broken状态为true，唤醒所有线程
                        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();
        }
    }

breakBarrier

默认barrier是没有损坏的。当barrier损坏了或者有一个线程中断了,则通过breakBarrier()来终止所有的线程。在breakBarrier()中除了将broken设置为true,还会调用signalAll将在CyclicBarrier处于等待状态的线程全部唤醒。

private void breakBarrier() {
	//设置状态
	generation.broken = true;
	//恢复正在等待进入屏障的线程数量
	count = parties;
	//唤醒所有线程
	trip.signalAll();
}

nextGeneration

当所有线程都已经到达barrier处(index == 0),则会通过nextGeneration()进行更新换代操作,在这个步骤中唤醒了所有线程,重置了count和generation。

//当barrier发生trip时，用于更新状态并唤醒每一个线程
//这一方法只有在持有lock时被调用
private void nextGeneration() {
	//唤醒所有线程
	trip.signalAll();
	//恢复正在等待进入屏障的线程数
	count = parties;
	//新生一代
	generation = new Generation();
    }