CyclicBarrier源码分析

1. 简介

CyclicBarrier字面意思是可循环使用(cyclic)的屏障(barrier),它要做的事情是,让一组线程到达一个屏障时阻塞,直到最后一个线程到达屏障时,屏障才会打开,所有被屏障拦截的线程才会继续运行

2. 源码分析

2.1 类的属性

public class CyclicBarrier {
    
    /** The lock for guarding barrier entry */
    // 可重入锁
    private final ReentrantLock lock = new ReentrantLock();
    /** Condition to wait on until tripped */
    // 条件队列
    private final Condition trip = lock.newCondition();
    /** The number of parties */
    // 参与的线程数量
    private final int parties;
    /* The command to run when tripped */
    // 由最后一个进入 barrier 的线程执行的操作
    private final Runnable barrierCommand;
    /** The current generation */
    // 当前代
    private Generation generation = new Generation();
    // 正在等待进入屏障的线程数量
    private int count;
}

说明:该属性有一个为ReentrantLock对象,有一个为Condition对象,而Condition对象又是基于AQS的,所以,归根到底,底层还是由AQS提供支持。

2.2 内部类

private static class Generation {
    boolean broken = false;
}

Generation表示代,例如第1代同步器,在reset() 或nextGeneration() 会更新成员变量 generation

2.3 构造函数

  1. CyclicBarrier(int, Runnable)型构造函数
public CyclicBarrier(int parties, Runnable barrierAction) {
        // 参与的线程数量小于等于0,抛出异常
        if (parties <= 0) throw new IllegalArgumentException();
        // 设置parties
        this.parties = parties;
        // 设置count
        this.count = parties;
        // 设置barrierCommand
        this.barrierCommand = barrierAction;
    }

说明:该构造函数可以指定关联该CyclicBarrier的线程数量,并且可以指定在所有线程都进入屏障后的执行动作,该执行动作由最后一个进行屏障的线程执行。

  1. CyclicBarrier(int)型构造函数

    public CyclicBarrier(int parties) {
            // 调用含有两个参数的构造函数
            this(parties, null);
        }
    

2.4 核心函数分析

  1. dowait()---CyclicBarrier类的核心函数,CyclicBarrier类对外提供的await函数在底层都是调用该了doawait函数

    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) {  // 正在等待进入屏障的线程数量为0,所有线程都已经进入
                    // 运行的动作标识
                    boolean ranAction = false;
                    try {
                        // 保存运行动作
                        final Runnable command = barrierCommand;
                        if (command != null) // 动作不为空
                            // 运行
                            command.run();
                        // 设置ranAction状态
                        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) // 设置了等待时间,并且等待时间大于0
                            // 等待指定时长
                            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) { // 设置了等待时间,并且等待时间小于0
                        // 损坏屏障
                        breakBarrier();
                        // 抛出异常
                        throw new TimeoutException();
                    }
                }
            } finally {
                // 释放锁
                lock.unlock();
            }
        }
    
  2. nextGeneration()

    此函数在所有线程进入屏障后会被调用,即生成下一个版本,所有线程又可以重新进入到屏障中

    private void nextGeneration() {
            // signal completion of last generation
            // 唤醒所有线程
            trip.signalAll();
            // set up next generation
            // 恢复正在等待进入屏障的线程数量
            count = parties;
            // 新生一代
            generation = new Generation();
        }
    
  3. breakBarrier()

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

3. CountDownLatch与CyclicBarrier的比较

  1. CountDownLatch() 的计数器只能用一次,而CyclicBarrier可以使用多次使用,可以使用reset() 方法重置
  2. CyclicBarrier支持在线程全部到达后执行一次任务,CountDownLatch只有计数器的效果
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容