Java 数据结构—阻塞队列学习笔记

特点

阻塞队列 BlockingQueue 是线程安全，所有的操作都加了锁。

阻塞你是怎么理解的呢？

队列主要的操作不外乎就是出队和入队两种方式，但是 BlockingQueue对于出队和入队操作做了阻塞操作

简单理解如下

• 当你要取一个数据时，发现队列为空，那么你就在此等待，等其它人(其它线程)往队列存储存入数据，那它会通知队列有数据了，你就可以取数据了。
• 当你要存一个数据时，发现队列已满，那么你就在此等待，等其它人(其它线程)从队列中取出数据，那它会通知你队列没有满哦，你就可以存数据了。

如何实现阻塞的呢？

内部主要是通过通过 ReentrantLock 保证每一个操作都是线程安全的，并且通过等待唤醒机制来实现阻塞功能。

下面通过两个基本的存(put)取(take)方法来简单描述一下 BlockingQueue 是如何实现线程安全和阻塞机制的。

• 入队

public void put(E e) throws InterruptedException {
    Objects.requireNonNull(e);
    final ReentrantLock lock = this.lock;
    //加锁
    lock.lockInterruptibly();
    try {        
        while (count == items.length)
            //队列满了，就等待其它人取走
            notFull.await();
       //队列还没满，可以入队
       enqueue(e);
    } finally {
        //释放锁
        lock.unlock();
    }
}

• 出队

public E take() throws InterruptedException {
    final ReentrantLock lock = this.lock;
    //还是加锁
    lock.lockInterruptibly();
    try {
        while (count == 0)
            //哇哇，队列为空，等等吧...
            notEmpty.await();
            
        return dequeue();//队列不为空，取一个数据给我
    } finally {
        //还是释放锁
        lock.unlock();
    }
}

阻塞队列主要有三种实现类

SynchrousBlockingQueue

没有容量的队列

ArrayBlokingQueue

底层使用数组实现的阻塞队里，必须要指定队列容量

LinkedBlockingQueue

底层使用链表实现的阻塞队列，可以指定队列容量，默认是 Integer.MAX_VALUE

BlockingQueue 基础 API

• boolean offer(E e);

往队列中添加一个数据，如果队列还没满，那么返回 true，否则则返回false，表示添加失败，这时需要取出数据之后才能存储数据。该方法在 ThreadPoolExecutor#execute(runnable)中有应用，后面会简单描述。

• boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException;

往队列中添加一个数据，如果队列还没满，那么返回 true，如果队列满了，就开始在当前线程阻塞等待，如果等待时间到了，还没有能获取到数据，那么就返回 false

• void put(E e) throws InterruptedException;

阻塞式添加数据到队列，直到队列可以存放数据。

• E take() throws InterruptedException;

阻塞式获取数据

• boolean remove(Object o);

从队列中移除数据

关于上面的 api ，其实我们写个 demo 练习一下就知道它是怎么工作的啦。

不过呢，我对 SynchrousBlockingQueue 是比较有疑问的，它没有容量，也就是不能存储数据，那还能实现阻塞吗？带着疑问，我们来验证一下咯

SynchrousBlockingQueue

• offer 函数的理解(一)

final SynchronousQueue synchronousQueue = new SynchronousQueue<>();
boolean result = synchronousQueue.offer("1");
System.out.println(result ? "成功添加了第1个数据" : "第1个数据添加失败");
result = synchronousQueue.offer("2");
System.out.println(result ? "成功添加了第2个数据" : "第2个数据添加失败");

因为没有容量啦，所以 offer 结果就直接返回 false了...

第1个数据添加失败
第2个数据添加失败

但是，就开始疑问了，这个有啥用啊？会有返回 true 的情况吗？

• offer 函数的理解(二)

来看第二个栗子

final SynchronousQueue synchronousQueue = new SynchronousQueue<>();
new Thread() {
    @Override
    public void run() {
        super.run();
        while (true) {
            String s = null;
            try {
                //take() 会一直阻塞
                s = synchronousQueue.take();
                //等待时间超时获取元素
                // s = synchronousQueue.poll(100, TimeUnit.MICROSECONDS);
            } catch (Exception e) {
                e.printStackTrace();
            }
            if (s != null) {
                System.out.println("取出数据：" + s);
            }
        }
    }
}.start();
/*
offer向队列中提交一个元素,如果此时有其他线程正在被take阻塞
(即其他线程已准备接收)或者"碰巧"有poll/take操作,那么将返回true,否则返回false.
 */
Thread.sleep(100);//确保上面的线程跑起来呀
boolean result = synchronousQueue.offer("1");
System.out.println(result ? "成功添加了第1个数据" : "第1个数据添加失败");
Thread.sleep(100);
result = synchronousQueue.offer("2");
System.out.println(result ? "成功添加了第2个数据" : "第2个数据添加失败");

看到了吗？offer(...)操作时，如果此时其它线程正在阻塞等待别人入队，那就刚好这时，我入队了，所以我 offer 返回 true 了啦~

成功添加了第1个数据
取出数据：1
成功添加了第2个数据
取出数据：2

ArrayBlokingQueue

对于 ArrayBlokingQueue 也使用两个函数来看看出入队列的操作吧

• put 函数的理解

//定义一个只有一个容量的队列，没有实际用处，只是测试而已哈
final ArrayBlockingQueue arrayBlockingQueue = new ArrayBlockingQueue(1);

//添加三个数据
arrayBlockingQueue.put(new Runnable() {
    @Override
    public void run() {
    }
});
System.out.println(System.currentTimeMillis() + " 添加第1个数据");
arrayBlockingQueue.put(new Runnable() {
    @Override
    public void run() {
    }
});
System.out.println(System.currentTimeMillis() + " 添加第2个数据");
//等待中ing...........................我阻塞住了啊，等着别人取走队列的数据，我才能入队呀~
arrayBlockingQueue.put(new Runnable() {
    @Override
    public void run() {
    }
});
System.out.println(System.currentTimeMillis() + " 添加第3个数据");

输出结果:从输出结果我们可以看出，因为 ArrayBlockingQueue 只有一个容量，因此它只能存储一个数据，当第二个数据来时，那它就在那里等待ing了~~

1566057339377 添加第1个数据

那我如果要存储2和3两个数据怎么办？之前说过，阻塞是针对队列是否满来判断的，现在队列已经有一个数据1了，那么当前线程已经阻塞住啦，它的阻塞内部就是调用了 notFull.await() 表示队列满啦，你等着吧

那我找个线程出队列取，然后通过 notFull.signal(); 去通知不就行啦。

来，看看 ArrayBlockingQueueu 在出队之后是怎么通知的？

notFull.signal() 通知等待线程，我有一个数据已经出队了，你可以来存啦。

private E dequeue() {
    // assert lock.getHoldCount() == 1;
    // assert items[takeIndex] != null;
    final Object[] items = this.items;
    @SuppressWarnings("unchecked")
    E x = (E) items[takeIndex];
    items[takeIndex] = null;
    if (++takeIndex == items.length) takeIndex = 0;
    count--;
    if (itrs != null)
        itrs.elementDequeued();
    //这里就是通知当前线程不满，可以存啦~
    notFull.signal();
    return x;
}

• take 函数的理解

我们来新起一个线程去队列中取数据

final ArrayBlockingQueue arrayBlockingQueue = new ArrayBlockingQueue(1);

//这里我们增加一个线程去取数据哈，模拟代码没有实际意义啊~
new Thread() {
    @Override
    public void run() {
        super.run();
        try {
            Thread.sleep(1000);
            System.out.println(System.currentTimeMillis() + " 在其它线程中从队列中取数据");
            //取出数据
            arrayBlockingQueue.take();
            Thread.sleep(1000);
            System.out.println(System.currentTimeMillis() + " 在其它线程中从队列中取数据");
           //取出数据
           arrayBlockingQueue.take();
           Thread.sleep(1000);
            System.out.println(System.currentTimeMillis() + " 在其它线程中从队列中取数据");
            //取出数据
            arrayBlockingQueue.take();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}.start();

//下面的code跟上面的栗子是一样
arrayBlockingQueue.put(new Runnable() {
    @Override
    public void run() {
    }
});
System.out.println(System.currentTimeMillis() + " 添加第1个数据");
arrayBlockingQueue.put(new Runnable() {
    @Override
    public void run() {
    }
});
System.out.println(System.currentTimeMillis() + " 添加第2个数据");
arrayBlockingQueue.put(new Runnable() {
    @Override
    public void run() {
    }
});
System.out.println(System.currentTimeMillis() + " 添加第3个数据");

来，关注一下输出结果，可以看到，三个数据都正常的入队和出队啦

1566058033006 添加第1个数据
1566058034009 在其它线程中从队列中取数据
1566058034010 添加第2个数据
1566058035014 在其它线程中从队列中取数据
1566058035014 添加第3个数据
1566058036019 在其它线程中从队列中取数据

阻塞队列在线程池的应用

在 ThreadPoolExecutor 中有一个构造参数 workQueue 就是用到了 BlokingQueue ，那么你有没有好奇 ThreadPoolExecutor 是如何应用这个阻塞机制的呢？

public ThreadPoolExecutor(int corePoolSize,
                          int maximumPoolSize,
                          long keepAliveTime,
                          TimeUnit unit,
                          BlockingQueue workQueue,
                          ThreadFactory threadFactory) {
    this(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue,
         threadFactory, defaultHandler);
}

execute 函数的工作原理

ThreadPoolExecutor 在阻塞队列的应用不外乎就是对需要执行的任务进行缓存，那么就涉及到出队入队两个操作啦，ThreadPoolExecutor 使用主要是用到了以下两个 api

入队

如果当前线程池运行的线程数量小于核心线程数，那么就会将任务添加到队列中，注意哦，这里的入队是用 offer 函数而不是 put 函数，这个是有原因的，首先 offer 函数不会阻塞呀，总不能添加一个任务就把调用者（调用 execute(runnable)的人）给阻塞死吧~这里使用 offer 在队列满时，会直接返回 false 。

workQueue.offer(command)

出队

• poll(keepAliveTime, TimeUnit.NANOSECONDS)这个方法是针对那些需要在 keepAliveTime 超时后销毁的任务线程（ps:一般是非核心线程啦），这里会一直阻塞等待，直到 keepAliveTime 时间到，如果还没有拿到要执行的任务（ps:说明什么？说明队列没有数据啦~没有人去调用 execute 来提交任务啦~），那么就返回 null，结束使命 game over。

• workQueue.take()这个方法是针对核心线程的，这个方法会阻塞住哦，直到队列有任务给它（ps:有人通过 execute(runnable)提交任务时，会唤醒它），想到没，这里没有超时机制，所以理所当然，我们的核心线程就不会 game over 啦，它可以一直存活呀，不受 keepAliveTime 影响呀~

Runnable r = timed ?
    workQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) :
    workQueue.take();

项目地址

https://github.com/liaowjcoder/study4Java/blob/master/03_concurrent/src/main/java/com/example/pool/BlockingQueueDemo.java

本文是笔者学习之后的总结，方便日后查看学习，有任何不对的地方请指正。

记录于 2019年8月18号