java多线程并发之旅-10-阻塞队列 BlockingQueue

冷不防 2022-02-26 08:30 341阅读 0赞

# Q #

*  为什么要有阻塞队列？
 *  什么是阻塞队列
 *  优缺点
 *  适用场景
 *  实现思想+源码
 *  个人启发

# 阻塞队列 #

什么是阻塞队列？

阻塞队列（BlockingQueue）是一个支持两个附加操作的队列。这两个附加的操作是：在队列为空时，获取元素的线程会等待队列变为非空。当队列满时，存储元素的线程会等待队列可用。阻塞队列常用于生产者和消费者的场景，生产者是往队列里添加元素的线程，消费者是从队列里拿元素的线程。阻塞队列就是生产者存放元素的容器，而消费者也只从容器里拿元素。

阻塞队列提供了四种处理方法:

<table> 
 <thead> 
  <tr> 
   <th align="left">方法处理方式</th> 
   <th align="left">抛出异常</th> 
   <th align="left">返回特殊值</th> 
   <th align="left">一直阻塞</th> 
   <th align="left">超时退出</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">插入方法</td> 
   <td align="left">add(e)</td> 
   <td align="left">offer(e)</td> 
   <td align="left">put(e)</td> 
   <td align="left">offer(e,time,unit)</td> 
  </tr> 
  <tr> 
   <td align="left">移除方法</td> 
   <td align="left">remove()</td> 
   <td align="left">poll()</td> 
   <td align="left">take()</td> 
   <td align="left">poll(time,unit)</td> 
  </tr> 
  <tr> 
   <td align="left">检查方法</td> 
   <td align="left">element()</td> 
   <td align="left">peek()</td> 
   <td align="left"></td> 
   <td align="left">不可用 不可用</td> 
  </tr> 
 </tbody> 
</table>

抛出异常：是指当阻塞队列满时候，再往队列里插入元素，会抛出IllegalStateException(“Queue full”)异常。当队列为空时，从队列里获取元素时会抛出NoSuchElementException异常 。

返回特殊值：插入方法会返回是否成功，成功则返回true。移除方法，则是从队列里拿出一个元素，如果没有则返回null

一直阻塞：当阻塞队列满时，如果生产者线程往队列里put元素，队列会一直阻塞生产者线程，直到拿到数据，或者响应中断退出。当队列空时，消费者线程试图从队列里take元素，队列也会阻塞消费者线程，直到队列可用。

超时退出：当阻塞队列满时，队列会阻塞生产者线程一段时间，如果超过一定的时间，生产者线程就会退出。

# 入门例子 #

演示如何简单实用 BlockingQueue。

## 测试类 ##

import java.util.concurrent.BlockingQueue;
    import java.util.concurrent.ExecutorService;
    import java.util.concurrent.Executors;
    import java.util.concurrent.LinkedBlockingQueue; 
    
    public class BlockingQueueTest { 
     
        public static void main(String[] args) throws InterruptedException { 
            // 声明一个容量为10的缓存队列
            BlockingQueue<String> queue = new LinkedBlockingQueue<String>(10);
     
            //new了三个生产者和一个消费者
            Producer producer1 = new Producer(queue);
            Producer producer2 = new Producer(queue);
            Producer producer3 = new Producer(queue);
            Consumer consumer = new Consumer(queue);
     
            // 借助Executors
            ExecutorService service = Executors.newCachedThreadPool();
            // 启动线程
            service.execute(producer1);
            service.execute(producer2);
            service.execute(producer3);
            service.execute(consumer);
     
            // 执行10s
            Thread.sleep(10 * 1000);
            producer1.stop();
            producer2.stop();
            producer3.stop();
     
            Thread.sleep(2000);
            // 退出Executor
            service.shutdown();
        }
    }

## 生产者线程 ##

import java.util.Random;
    import java.util.concurrent.BlockingQueue;
    import java.util.concurrent.TimeUnit;
    import java.util.concurrent.atomic.AtomicInteger;
     
    /** * 生产者线程 * * @author jackyuj */
    public class Producer implements Runnable { 
        
        private volatile boolean  isRunning = true;//是否在运行标志
        private BlockingQueue queue;//阻塞队列
        private static AtomicInteger count = new AtomicInteger();//自动更新的值
        private static final int DEFAULT_RANGE_FOR_SLEEP = 1000;
     
        //构造函数
        public Producer(BlockingQueue queue) { 
            this.queue = queue;
        }
     
        public void run() { 
            String data = null;
            Random r = new Random();
     
            System.out.println("启动生产者线程！");
            try { 
                while (isRunning) { 
                    System.out.println("正在生产数据...");
                    Thread.sleep(r.nextInt(DEFAULT_RANGE_FOR_SLEEP));//取0~DEFAULT_RANGE_FOR_SLEEP值的一个随机数
     
                    data = "data:" + count.incrementAndGet();//以原子方式将count当前值加1
                    System.out.println("将数据：" + data + "放入队列...");
                    if (!queue.offer(data, 2, TimeUnit.SECONDS)) { //设定的等待时间为2s，如果超过2s还没加进去返回true
                        System.out.println("放入数据失败：" + data);
                    }
                }
            } catch (InterruptedException e) { 
                e.printStackTrace();
                Thread.currentThread().interrupt();
            } finally { 
                System.out.println("退出生产者线程！");
            }
        }
     
        public void stop() { 
            isRunning = false;
        }
    }

## 消费者代码 ##

import java.util.Random;
    import java.util.concurrent.BlockingQueue;
    import java.util.concurrent.TimeUnit;
     
    /** * 消费者线程 * * @author jackyuj */
    public class Consumer implements Runnable { 
        
        private BlockingQueue<String> queue;
        private static final int DEFAULT_RANGE_FOR_SLEEP = 1000;
     
        //构造函数
        public Consumer(BlockingQueue<String> queue) { 
            this.queue = queue;
        }
     
        public void run() { 
            System.out.println("启动消费者线程！");
            Random r = new Random();
            boolean isRunning = true;
            try { 
                while (isRunning) { 
                    System.out.println("正从队列获取数据...");
                    String data = queue.poll(2, TimeUnit.SECONDS);//有数据时直接从队列的队首取走，无数据时阻塞，在2s内有数据，取走，超过2s还没数据，返回失败
                    if (null != data) { 
                        System.out.println("拿到数据：" + data);
                        System.out.println("正在消费数据：" + data);
                        Thread.sleep(r.nextInt(DEFAULT_RANGE_FOR_SLEEP));
                    } else { 
                        // 超过2s还没数据，认为所有生产线程都已经退出，自动退出消费线程。
                        isRunning = false;
                    }
                }
            } catch (InterruptedException e) { 
                e.printStackTrace();
                Thread.currentThread().interrupt();
            } finally { 
                System.out.println("退出消费者线程！");
            }
        }
    }

# Java里的阻塞队列 #

JDK7提供了7个阻塞队列。

ArrayBlockingQueue ：一个由数组结构组成的有界阻塞队列。

LinkedBlockingQueue ：一个由链表结构组成的有界阻塞队列。

PriorityBlockingQueue ：一个支持优先级排序的无界阻塞队列。

DelayQueue：一个使用优先级队列实现的无界阻塞队列。

SynchronousQueue：一个不存储元素的阻塞队列。

LinkedTransferQueue：一个由链表结构组成的无界阻塞队列。

LinkedBlockingDeque：一个由链表结构组成的双向阻塞队列。

## ArrayBlockingQueue ##

ArrayBlockingQueue是一个用数组实现的有界阻塞队列。此队列按照先进先出（FIFO）的原则对元素进行排序。默认情况下不保证访问者公平的访问队列，所谓公平访问队列是指阻塞的所有生产者线程或消费者线程，当队列可用时，可以按照阻塞的先后顺序访问队列，即先阻塞的生产者线程，可以先往队列里插入元素，先阻塞的消费者线程，可以先从队列里获取元素。

通常情况下为了保证公平性会降低吞吐量。我们可以使用以下代码创建一个公平的阻塞队列：

ArrayBlockingQueue fairQueue = new  ArrayBlockingQueue(1000,true);

访问者的公平性是使用可重入锁实现的，代码如下

public ArrayBlockingQueue(int capacity, boolean fair) { 
            if (capacity <= 0)
                throw new IllegalArgumentException();
            this.items = new Object[capacity];
            lock = new ReentrantLock(fair);
            notEmpty = lock.newCondition();
            notFull =  lock.newCondition();
    }

## LinkedBlockingQueue ##

LinkedBlockingQueue是一个用链表实现的有界阻塞队列。此队列的默认和最大长度为Integer.MAX\_VALUE。此队列按照先进先出的原则对元素进行排序。

## PriorityBlockingQueue ##

PriorityBlockingQueue是一个支持优先级的无界队列。默认情况下元素采取自然顺序排列，也可以通过比较器comparator来指定元素的排序规则。元素按照升序排列。

## DelayQueue ##

DelayQueue是一个支持延时获取元素的无界阻塞队列。队列使用PriorityQueue来实现。队列中的元素必须实现Delayed接口，在创建元素时可以指定多久才能从队列中获取当前元素。只有在延迟期满时才能从队列中提取元素。我们可以将DelayQueue运用在以下应用场景：

缓存系统的设计：可以用DelayQueue保存缓存元素的有效期，使用一个线程循环查询DelayQueue，一旦能从DelayQueue中获取元素时，表示缓存有效期到了。  
定时任务调度。使用DelayQueue保存当天将会执行的任务和执行时间，一旦从DelayQueue中获取到任务就开始执行，从比如TimerQueue就是使用DelayQueue实现的。  
队列中的Delayed必须实现compareTo来指定元素的顺序。比如让延时时间最长的放在队列的末尾。实现代码如下：

public int compareTo(Delayed other) { 
        if (other == this) // compare zero ONLY if same object
            return 0;
        if (other instanceof ScheduledFutureTask) { 
            ScheduledFutureTask x = (ScheduledFutureTask)other;
            long diff = time - x.time;
            if (diff < 0)
                return -1;
            else if (diff > 0)
                return 1;
        else if (sequenceNumber < x.sequenceNumber)
                return -1;
            else
                return 1;
        }
        long d = (getDelay(TimeUnit.NANOSECONDS) -
                    other.getDelay(TimeUnit.NANOSECONDS));
        return (d == 0) ? 0 : ((d < 0) ? -1 : 1);
    }

### 如何实现Delayed接口 ###

我们可以参考 `ScheduledThreadPoolExecutor` 里 ScheduledFutureTask 类。

这个类实现了Delayed接口。

首先：在对象创建的时候，使用time记录前对象什么时候可以使用，代码如下：

ScheduledFutureTask(Runnable r, V result, long ns, long period) { 
        super(r, result);
        this.time = ns;
        this.period = period;
        this.sequenceNumber = sequencer.getAndIncrement();
    }

然后使用getDelay可以查询当前元素还需要延时多久，代码如下：

public long getDelay(TimeUnit unit) { 
        return unit.convert(time - now(), TimeUnit.NANOSECONDS);
    }

通过构造函数可以看出延迟时间参数ns的单位是纳秒，自己设计的时候最好使用纳秒，因为getDelay时可以指定任意单位，一旦以纳秒作为单位，而延时的时间又精确不到纳秒就麻烦了。

使用时请注意当time小于当前时间时，getDelay会返回负数。

### 如何实现延时队列 ###

延时队列的实现很简单，当消费者从队列里获取元素时，如果元素没有达到延时时间，就阻塞当前线程。

long delay = first.getDelay(TimeUnit.NANOSECONDS);
        if (delay <= 0)
            return q.poll();
        else if (leader != null)
            available.await();

## SynchronousQueue ##

SynchronousQueue 是一个不存储元素的阻塞队列。

每一个put操作必须等待一个take操作，否则不能继续添加元素。SynchronousQueue可以看成是一个传球手，负责把生产者线程处理的数据直接传递给消费者线程。队列本身并不存储任何元素，非常适合于传递性场景,比如在一个线程中使用的数据，传递给另外一个线程使。

SynchronousQueue 的吞吐量高于 LinkedBlockingQueue 和 ArrayBlockingQueue。

## LinkedTransferQueue ##

LinkedTransferQueue是一个由链表结构组成的无界阻塞TransferQueue队列。相对于其他阻塞队列LinkedTransferQueue多了tryTransfer和transfer方法。

### transfer方法。 ###

如果当前有消费者正在等待接收元素（消费者使用take()方法或带时间限制的poll()方法时），transfer方法可以把生产者传入的元素立刻transfer（传输）给消费者。如果没有消费者在等待接收元素，transfer方法会将元素存放在队列的tail节点，并等到该元素被消费者消费了才返回。

transfer方法的关键代码如下：

Node pred = tryAppend(s, haveData);
    return awaitMatch(s, pred, e, (how == TIMED), nanos);

第一行代码是试图把存放当前元素的s节点作为tail节点。

第二行代码是让CPU自旋等待消费者消费元素。因为自旋会消耗CPU，所以自旋一定的次数后使用Thread.yield()方法来暂停当前正在执行的线程，并执行其他线程。

### tryTransfer方法。 ###

则是用来试探下生产者传入的元素是否能直接传给消费者。如果没有消费者等待接收元素，则返回false。和transfer方法的区别是tryTransfer方法无论消费者是否接收，方法立即返回。而transfer方法是必须等到消费者消费了才返回。

对于带有时间限制的 `tryTransfer(E e, long timeout, TimeUnit unit)` 方法，则是试图把生产者传入的元素直接传给消费者，但是如果没有消费者消费该元素则等待指定的时间再返回，如果超时还没消费元素，则返回false，如果在超时时间内消费了元素，则返回true。

## LinkedBlockingDeque ##

LinkedBlockingDeque是一个由链表结构组成的双向阻塞队列。所谓双向队列指的你可以从队列的两端插入和移出元素。双端队列因为多了一个操作队列的入口，在多线程同时入队时，也就减少了一半的竞争。

相比其他的阻塞队列，LinkedBlockingDeque多了addFirst，addLast，offerFirst，offerLast，peekFirst，peekLast等方法，以First单词结尾的方法，表示插入，获取（peek）或移除双端队列的第一个元素。以Last单词结尾的方法，表示插入，获取或移除双端队列的最后一个元素。

另外插入方法add等同于addLast，移除方法remove等效于removeFirst。

但是take方法却等同于takeFirst，不知道是不是Jdk的bug，使用时还是用带有First和Last后缀的方法更清楚。

在初始化LinkedBlockingDeque时可以初始化队列的容量，用来防止其再扩容时过渡膨胀。

另外双向阻塞队列可以运用在“工作窃取”模式中。

# 阻塞队列的实现原理 #

如果队列是空的，消费者会一直等待，当生产者添加元素时候，消费者是如何知道当前队列有元素的呢？

如果让你来设计阻塞队列你会如何设计，让生产者和消费者能够高效率的进行通讯呢？让我们先来看看JDK是如何实现的。

使用通知模式实现。

所谓通知模式，就是当生产者往满的队列里添加元素时会阻塞住生产者，当消费者消费了一个队列中的元素后，会通知生产者当前队列可用。

## ArrayBlockingQueue ##

> 备注：基于 JDK 1.8.0\_191

通过查看JDK源码发现 ArrayBlockingQueue 使用了Condition来实现，代码如下：

/* * Concurrency control uses the classic two-condition algorithm * found in any textbook. */
    
        /** Main lock guarding all access */
        final ReentrantLock lock;
    
        /** Condition for waiting takes */
        private final Condition notEmpty;
    
        /** Condition for waiting puts */
        private final Condition notFull;

*  集合的初始化

/** * Creates an {@code ArrayBlockingQueue} with the given (fixed) * capacity and the specified access policy. * * @param capacity the capacity of this queue * @param fair if {@code true} then queue accesses for threads blocked * on insertion or removal, are processed in FIFO order; * if {@code false} the access order is unspecified. * @throws IllegalArgumentException if {@code capacity < 1} */
        public ArrayBlockingQueue(int capacity, boolean fair) { 
            if (capacity <= 0)
                throw new IllegalArgumentException();
            this.items = new Object[capacity];
            lock = new ReentrantLock(fair);
            notEmpty = lock.newCondition();
            notFull =  lock.newCondition();
        }

## put() & take() ##

/** * Inserts the specified element at the tail of this queue, waiting * for space to become available if the queue is full. * * @throws InterruptedException {@inheritDoc} * @throws NullPointerException {@inheritDoc} */
        public void put(E e) throws InterruptedException { 
            checkNotNull(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();
        }
    }

其实比较简单，就是放入的时候是否已经满；取出的时候判断是否已经空。

## await() ##

AbstractQueuedSynchronizer 类中实现如下

/** * Implements interruptible condition wait. * <ol> * <li> If current thread is interrupted, throw InterruptedException. * <li> Save lock state returned by {@link #getState}. * <li> Invoke {@link #release} with saved state as argument, * throwing IllegalMonitorStateException if it fails. * <li> Block until signalled or interrupted. * <li> Reacquire by invoking specialized version of * {@link #acquire} with saved state as argument. * <li> If interrupted while blocked in step 4, throw InterruptedException. * </ol> */
    public final void await() throws InterruptedException { 
        if (Thread.interrupted())
            throw new InterruptedException();
        Node node = addConditionWaiter();
        int savedState = fullyRelease(node);
        int interruptMode = 0;
        while (!isOnSyncQueue(node)) { 
            LockSupport.park(this);
            if ((interruptMode = checkInterruptWhileWaiting(node)) != 0)
                break;
        }
        if (acquireQueued(node, savedState) && interruptMode != THROW_IE)
            interruptMode = REINTERRUPT;
        if (node.nextWaiter != null) // clean up if cancelled
            unlinkCancelledWaiters();
        if (interruptMode != 0)
            reportInterruptAfterWait(interruptMode);
    }

`LockSupport.park(this);` 这句话用来阻塞，继续深入源码，如下：

public static void park(Object blocker) { 
        Thread t = Thread.currentThread();
        setBlocker(t, blocker);
        UNSAFE.park(false, 0L);
        setBlocker(t, null);
    }

### park 方法 ###

`UNSAFE.park(false, 0L);` 是个native方法，接口如下：

public native void park(boolean isAbsolute, long time);

park这个方法会阻塞当前线程，只有以下四种情况中的一种发生时，该方法才会返回。

与park对应的unpark执行或已经执行时。注意：已经执行是指unpark先执行，然后再执行的park。  
线程被中断时。

如果参数中的time不是零，等待了指定的毫秒数时。

发生异常现象时。这些异常事先无法确定。

我们继续看一下JVM是如何实现park方法的，park在不同的操作系统使用不同的方式实现，在linux下是使用的是系统方法pthread\_cond\_wait实现。

实现代码在JVM源码路径 `src/os/linux/vm/os_linux.cp`p里的 `os::PlatformEvent::park` 方法，代码如下：

void os::PlatformEvent::park() { 
    	     int v ;
        for (;;) { 
    	v = _Event ;
        if (Atomic::cmpxchg (v-1, &_Event, v) == v) break ;
        }
        guarantee (v >= 0, "invariant") ;
        if (v == 0) { 
        // Do this the hard way by blocking ...
        int status = pthread_mutex_lock(_mutex);
        assert_status(status == 0, status, "mutex_lock");
        guarantee (_nParked == 0, "invariant") ;
        ++ _nParked ;
        while (_Event < 0) { 
        status = pthread_cond_wait(_cond, _mutex);
        // for some reason, under 2.7 lwp_cond_wait() may return ETIME ...
        // Treat this the same as if the wait was interrupted
        if (status == ETIME) {  status = EINTR; }
        assert_status(status == 0 || status == EINTR, status, "cond_wait");
        }
        -- _nParked ;
        // In theory we could move the ST of 0 into _Event past the unlock(),
        // but then we'd need a MEMBAR after the ST.
        _Event = 0 ;
        status = pthread_mutex_unlock(_mutex);
        assert_status(status == 0, status, "mutex_unlock");
        }
        guarantee (_Event >= 0, "invariant") ;
        }
    }

pthread\_cond\_wait是一个多线程的条件变量函数，cond是condition的缩写，字面意思可以理解为线程在等待一个条件发生，这个条件是一个全局变量。这个方法接收两个参数，一个共享变量\_cond，一个互斥量\_mutex。而unpark方法在linux下是使用pthread\_cond\_signal实现的。

park 在windows下则是使用WaitForSingleObject实现的。

## 队列满 ##

当队列满时，生产者往阻塞队列里插入一个元素，生产者线程会进入WAITING (parking)状态。我们可以使用jstack dump阻塞的生产者线程看到这点：

"main" prio=5 tid=0x00007fc83c000000 nid=0x10164e000 waiting on condition [0x000000010164d000]
       java.lang.Thread.State: WAITING (parking)
            at sun.misc.Unsafe.park(Native Method)
            - parking to wait for  <0x0000000140559fe8> (a java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject)
            at java.util.concurrent.locks.LockSupport.park(LockSupport.java:186)
            at java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:2043)
            at java.util.concurrent.ArrayBlockingQueue.put(ArrayBlockingQueue.java:324)
            at blockingqueue.ArrayBlockingQueueTest.main(ArrayBlockingQueueTest.java:11)

# 个人感受 #

*  基础知识，底层全是 C。再往下看也没啥意思了。
 *  网上的博客都是一样的，这很悲催。包括本篇。希望以后自己可以拓展下本系列的内容，不断完善。

# 参考资料 #

《java 并发编程的艺术》

[http://ifeve.com/java-blocking-queue/][http_ifeve.com_java-blocking-queue]

[https://www.cnblogs.com/tjudzj/p/4454490.html][https_www.cnblogs.com_tjudzj_p_4454490.html]

# 目录 #

[java多线程并发之旅-01-并发概览][java_-01-]

[http_ifeve.com_java-blocking-queue]: http://ifeve.com/java-blocking-queue/
[https_www.cnblogs.com_tjudzj_p_4454490.html]: https://www.cnblogs.com/tjudzj/p/4454490.html
[java_-01-]: https://blog.csdn.net/ryo1060732496/article/details/88880351