图解java.util.concurrent源码 (七)ArrayBlockingQueue

引言


在并发编程中经常需要进行生产者消费者之间的同步,此时我们最经常使用的同步工具就是有界阻塞队列(BlockingQueue)了,这篇文章和下一篇文章将分别分析最经常使用的两个有界队列,ArrayBlockingQueue和LinkedBlockingQueue的原理,然后对比他们的性能以及使用场景。

BlockingQueue接口


BlockingQueue接口定义了juc中阻塞队列的标准,juc中的阻塞队列一般提供下列四种入队方法:

方法签名 特点
boolean add(E e) 如果队列中还有剩余空间,则入队后返回true,否则立即抛出IllegalStateException异常,可以看出这个方法的返回值只有可能是true。如果是有界的阻塞队列,官方文档强烈建议使用offer方法代替add方法
boolean offer(E e) 如果队列还有剩余空间,则入队后返回true,否则返回false
boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException 同上,只不过会等待指定的时间,如果在指定的时间内队列中仍然没有剩余的空间可以入队,则返回false,否则返回true
void put(E e) throws InterruptedException 调用该方法的线程将一直阻塞直至入队成功

下列三种出队方法:

方法签名 特点
E poll(); 如果队列非空则立即将队头元素出队返回,否则返回null
E poll(long timeout, TimeUnit unit) throws InterruptedException; 同上,只不过会等待指定的时间,如果指定的时间内队列仍然为空,则返回null,否则将队头元素出队返回
E take() throws InterruptedException 调用该方法的线程将一直阻塞直到队列非空,然后将队头出队返回

总结个比较好记:BlockingQueue提供了put和take一对阻塞方法,以及offer和poll一对非阻塞方法。

注:因为add方法文档不推荐,所以就忽略了。还有offer和poll并不是真正的非阻塞,下面从源码中我们将会看到,其实它们是基于ReentrantLock进行同步的,在竞争激烈时依旧有可能因为争抢不到锁而阻塞住。

数据结构基础:循环队列


循环队列其实就是用数组实现一个队列的结构,为了用数组模拟出队列的行为,还需要额外维护下面三个变量:

  • takeIndex: 队头在数组中的下标
  • putIndex: 队尾元素的下一个位置,即下一个元素入队的位置
  • count: 计数器,统计队列中元素数目

之所以叫循环队列其实就是因为它逻辑上把数组首尾相接成为一个环形:

循环队列
  • 入队:先确认队列未满,然后将元素放入数组的putIndex下标处,将putIndex加1,再将count加1
  • 出队:先确认队列非空,然后将数组在takeIndex处的元素返回,然后将takeIndex加1,再将count减1

需要注意的是putIndex和takeIndex不能加得超过了数组的边界,我们这里不采用取模的方法,而是在其一到达数组边界处就将其置为0,方法如下:

    /**
     * Circularly increment i.
     * 每当队列满时将其置0
     */
    final int inc(int i) {
        return (++i == items.length) ? 0 : i;
    }

有了上面这些知识后,我们就可以尝试自己实现一个循环队列了:

public class SimpleRoundQueue<T> {

    private Object[] items;

    private int putIndex;
    private int takeIndex;
    private int count;

    public SimpleRoundQueue(int size){
        items = new Object[size];
    }

    private int inc(int i){
        return (++i == items.length)? 0: i;
    }

    public boolean enQueue(T item){
        if ( count == items.length ){
            return false;
        }

        items[putIndex] = item;
        putIndex = inc(putIndex);
        count++;

        return true;
    }

    public T deQueue(){
        if ( count == 0 ){
            return null;
        }

        count--;

        T item = (T) items[takeIndex];

        takeIndex = inc(takeIndex);
        return item;
    }

    public int length(){
        return count;
    }

    //测试队列实现的正确性
    public static void main(String[] args) {
        SimpleRoundQueue<Integer> roundQueue = new SimpleRoundQueue<Integer>(3);

        roundQueue.enQueue(4);
        roundQueue.enQueue(19);
        System.out.println("length:" + roundQueue.length()); //2
        System.out.println(roundQueue.deQueue()); //4

        roundQueue.enQueue(199);
        System.out.println(roundQueue.deQueue());//19

        System.out.println("length:" + roundQueue.length()); //1

        roundQueue.enQueue(19990);
        roundQueue.enQueue(1888);

        System.out.println("length:" + roundQueue.length()); //3

        System.out.println(roundQueue.enQueue(10));  //false

        System.out.println(roundQueue.deQueue());//199
        System.out.println(roundQueue.deQueue());//19990
        System.out.println(roundQueue.deQueue());//1888
        System.out.println(roundQueue.deQueue());//null
    }

}

看起来很简单的数据结构,但是有的时候面试官让你手写,一紧张就写不出来了,还是记住为好。

ArrayBlockingQueue实现分析


其实你看完上面我实现的那个循环队列,ArrayBlockingQueue的源码就已经看完了一大半了, 其实它就是在循环队列的出队和入队操作上都加了一把大锁而已,下图是一个简单粗暴的伪代码:

ArrayBlockingQueue源码大体结构

构造方法

先看看构造方法干了什么:

    public ArrayBlockingQueue(int capacity, boolean fair) {
        if (capacity <= 0)
            throw new IllegalArgumentException();
        this.items = new Object[capacity];
        lock = new ReentrantLock(fair);
        /**
         * 新建了两个Condition对象,分别是空条件和满条件
         */
        notEmpty = lock.newCondition();
        notFull =  lock.newCondition();
    }

先新建了作为容器的对象数组,然后新建了之前图中所示的那把大锁,在从锁中建立了生产者消费者问题中很常见的两个条件:非空条件(notEmpty)和未满条件(notFull)。

入队实现

然后看offer操作:

    public boolean offer(E e) {
        checkNotNull(e);
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            if (count == items.length) //队列已满
                return false;
            else { //队列尚未满
                insert(e);//循环队列入队
                return true;
            }
        } finally {
            lock.unlock();
        }
    }

其中insert方法的代码其实就是循环队列的入队操作:

    private void insert(E x) {
        items[putIndex] = x;
        putIndex = inc(putIndex);
        ++count;
        //唤醒一个等待非空条件的线程
        notEmpty.signal();
    }

可以看出相比我们之前的实现的循环队列的入队方法就多了一句notEmpty.signal(),会唤醒一个等待在“非空”条件上的线程。

put方法的实现和offer几乎是一样的,只是发现队列满了之后会await在未满这个条件上:

    public void put(E e) throws InterruptedException {
        checkNotNull(e);
        final ReentrantLock lock = this.lock;
        lock.lockInterruptibly();
        try {
            while (count == items.length)  //等待直到队列中有剩余空间
                notFull.await();
            insert(e);
        } finally {
            lock.unlock();
        }
    }

add方法就不说了,因为它其实调用的就是offer方法,offer方法返回false就抛异常。

再提一下带有时间限制的offer方法的实现:

    public boolean offer(E e, long timeout, TimeUnit unit)
        throws InterruptedException {

        checkNotNull(e);
        long nanos = unit.toNanos(timeout);
        final ReentrantLock lock = this.lock;
        lock.lockInterruptibly();
        try {
            //ReentrantLock文档中推荐的awaitNanos的标准使用方法
            while (count == items.length) {
                if (nanos <= 0)
                    return false;
                nanos = notFull.awaitNanos(nanos);
            }
            insert(e);
            return true;
        } finally {
            lock.unlock();
        }
    }

其实和不带时间限制的offer方法大同小异,只不过这里阻塞用的方法是awaitNanos,这里之所以要使用一个while循环直到nanos减至0,是因为awaitNanos存在“伪唤醒”的问题,可能会在规定的等待时间还没到的时候(for no reason)就返回,返回值是剩余的等待时间,如果你一定想要线程等待这么久的时间的话,ReentrantLock文档中推荐的写法是:

            while (count == items.length) {
                if (nanos <= 0)
                    return false;
                nanos = condition.awaitNanos(nanos);
            }

在我之前一篇分享CyclicBarrier源码的文章中也提到了这个"伪唤醒"问题。

出队实现

poll方法:

    public E poll() {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            //count == 0判断队列是否为空
            return (count == 0) ? null : extract();
        } finally {
            lock.unlock();
        }
    }

extract方法其实就是循环队列的出队操作:

    private E extract() {
        final Object[] items = this.items;
        E x = this.<E>cast(items[takeIndex]);
        items[takeIndex] = null;
        takeIndex = inc(takeIndex);
        --count;
        /**
         * 唤醒一个等待剩余空间的线程
         */
        notFull.signal();
        return x;
    }

相比循环队列的出队操作,只多了一行notFull.signal();

take方法的实现大同小异:

    public E take() throws InterruptedException {
        final ReentrantLock lock = this.lock;
        lock.lockInterruptibly();
        try {
            while (count == 0)
                //如果队列为空,则阻塞在"非空"条件上
                notEmpty.await();
            return extract();
        } finally {
            lock.unlock();
        }
    }

End


ArrayBlockingQueue的实现非常简单,但是却涉及到“循环队列”以及“生产者消费者”问题两个基础知识点,有的时候面试官会让你手写,所以个类的代码最好能够记住,之前我只顾着研究juc中比较复杂的类了,结果面试官让写这个简单的类,反而没写出来,很尴尬。

另外,ArrayBlockingQueue也是学习ReentrantLock使用方法的好材料。

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

推荐阅读更多精彩内容