并发实战——“JUC集合”之ArrayBlockingQueue

本文内容：

• 阻塞队列介绍（主要看ReentrantLock和两个condition）
• 源码分析
• Demo
• 弱一致的迭代器

---

ArrayBlockingQueue介绍

ArrayBlockingQueue是数组实现的线程安全的有界的阻塞队列。
线程安全是指，ArrayBlockingQueue内部通过“互斥锁”保护竞争资源，实现了多线程对竞争资源的互斥访问。而有界，则是指ArrayBlockingQueue对应的数组是有界限的。 阻塞队列，是指多线程访问竞争资源时，当竞争资源已被某线程获取时，其它要获取该资源的线程需要阻塞等待；而且，ArrayBlockingQueue是按 FIFO（先进先出）原则对元素进行排序，元素都是从尾部插入到队列，从头部开始返回。

注意：ArrayBlockingQueue不同于ConcurrentLinkedQueue，ArrayBlockingQueue是数组实现的，并且是有界限的；而ConcurrentLinkedQueue是链表实现的，是无界限的。

---

ArrayBlockingQueue原理和数据结构

说明：
1. ArrayBlockingQueue继承于AbstractQueue，并且它实现了BlockingQueue接口。
2. ArrayBlockingQueue内部是通过Object[]数组保存数据的，也就是说ArrayBlockingQueue本质上是通过数组实现的。ArrayBlockingQueue的大小，即数组的容量是创建ArrayBlockingQueue时指定的。
3. ArrayBlockingQueue与ReentrantLock是组合关系，ArrayBlockingQueue中包含一个ReentrantLock对象(lock)。ReentrantLock是可重入的互斥锁，ArrayBlockingQueue就是根据该互斥锁实现“多线程对竞争资源的互斥访问”。而且，ReentrantLock分为公平锁和非公平锁，关于具体使用公平锁还是非公平锁，在创建ArrayBlockingQueue时可以指定；而且，ArrayBlockingQueue默认会使用非公平锁。
4. ArrayBlockingQueue与Condition是组合关系，ArrayBlockingQueue中包含两个Condition对象(notEmpty和notFull)。而且，Condition又依赖于ArrayBlockingQueue而存在，通过Condition可以实现对ArrayBlockingQueue的更精确的访问 – (01)若某线程(线程A)要取数据时，数组正好为空，则该线程会执行notEmpty.await()进行等待；当其它某个线程(线程B)向数组中插入了数据之后，会调用notEmpty.signal()唤醒“notEmpty上的等待线程”。此时，线程A会被唤醒从而得以继续运行。(02)若某线程(线程H)要插入数据时，数组已满，则该线程会它执行notFull.await()进行等待；当其它某个线程(线程I)取出数据之后，会调用notFull.signal()唤醒“notFull上的等待线程”。此时，线程H就会被唤醒从而得以继续运行。

---

ArrayBlockingQueue函数列表

// 创建一个带有给定的（固定）容量和默认访问策略的 ArrayBlockingQueue。ArrayBlockingQueue(int capacity)// 创建一个具有给定的（固定）容量和指定访问策略的 ArrayBlockingQueue。ArrayBlockingQueue(int capacity, boolean fair)// 创建一个具有给定的（固定）容量和指定访问策略的 ArrayBlockingQueue，它最初包含给定 collection 的元素，并以 collection 迭代器的遍历顺序添加元素。ArrayBlockingQueue(int capacity, boolean fair, Collection<? extends E> c)// 将指定的元素插入到此队列的尾部（如果立即可行且不会超过该队列的容量），在成功时返回 true，如果此队列已满，则抛出 IllegalStateException。boolean add(E e)// 自动移除此队列中的所有元素。void clear()// 如果此队列包含指定的元素，则返回 true。boolean contains(Object o)// 移除此队列中所有可用的元素，并将它们添加到给定 collection 中。int drainTo(Collection<? super E> c)// 最多从此队列中移除给定数量的可用元素，并将这些元素添加到给定 collection 中。int drainTo(Collection<? super E> c, int maxElements)// 返回在此队列中的元素上按适当顺序进行迭代的迭代器。Iterator<E> iterator()// 将指定的元素插入到此队列的尾部（如果立即可行且不会超过该队列的容量），在成功时返回 true，如果此队列已满，则返回 false。boolean offer(E e)// 将指定的元素插入此队列的尾部，如果该队列已满，则在到达指定的等待时间之前等待可用的空间。boolean offer(E e, long timeout, TimeUnit unit)// 获取但不移除此队列的头；如果此队列为空，则返回 null。E peek()// 获取并移除此队列的头，如果此队列为空，则返回 null。E poll()// 获取并移除此队列的头部，在指定的等待时间前等待可用的元素（如果有必要）。E poll(long timeout, TimeUnit unit)// 将指定的元素插入此队列的尾部，如果该队列已满，则等待可用的空间。void put(E e)// 返回在无阻塞的理想情况下（不存在内存或资源约束）此队列能接受的其他元素数量。int remainingCapacity()// 从此队列中移除指定元素的单个实例（如果存在）。boolean remove(Object o)// 返回此队列中元素的数量。int size()// 获取并移除此队列的头部，在元素变得可用之前一直等待（如果有必要）。E take()// 返回一个按适当顺序包含此队列中所有元素的数组。Object[] toArray()// 返回一个按适当顺序包含此队列中所有元素的数组；返回数组的运行时类型是指定数组的运行时类型。<T> T[] toArray(T[] a)// 返回此 collection 的字符串表示形式。String toString()

---

ArrayBlockingQueue源码分析

下面从ArrayBlockingQueue的创建，添加，取出，遍历这几个方面对ArrayBlockingQueue进行分析。

1.创建

下面以ArrayBlockingQueue(int capacity, boolean fair)来进行说明。

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

说明：
(01) items是保存“阻塞队列”数据的数组。它的定义如下：

final Object[] items;

(02) fair是“可重入的独占锁(ReentrantLock)”的类型。fair为true，表示是公平锁；fair为false，表示是非公平锁。
notEmpty和notFull是锁的两个Condition条件。它们的定义如下：

final ReentrantLock lock;private final Condition notEmpty;private final Condition notFull;

---

2. 添加

下面以offer(E e)为例，对ArrayBlockingQueue的添加方法进行说明。

（ABQ中有三种添加方法，分别是put，offer，add；只有put会阻塞，等待队列有空闲位置；add和offer都是直接返回了，一个返回false，一个返回异常。）

    public boolean offer(E e) {       // 创建插入的元素是否为null，是的话抛出NullPointerException异常        checkNotNull(e);        // 获取“该阻塞队列的独占锁”        final ReentrantLock lock = this.lock;        lock.lock();        try {            // 如果队列已满，则返回false。            if (count == items.length)                return false;            else {            // 如果队列未满，则插入e，并返回true。                enqueue(e);                return true;            }        } finally {            // 释放锁            lock.unlock();        }    }

说明：offer(E e)的作用是将e插入阻塞队列的尾部。如果队列已满，则返回false，表示插入失败；否则，插入元素，并返回true。
count表示”队列中的元素个数“。除此之外，队列中还有另外两个遍历takeIndex和putIndex。takeIndex表示下一个被取出元素的索引，putIndex表示下一个被添加元素的索引。

enqueue(e)源码如下：

    private void enqueue(E x) {        final Object[] items = this.items;        items[putIndex] = x;        // 如果putIndex已经到队列末尾了，则将其置为0（能进入到此方法就说明count值小于队列大小，所以可以这么操作）        if (++putIndex == items.length)            putIndex = 0;        count++;        // 唤醒notEmpty上的等待线程        notEmpty.signal();    }

---

取出

下面以take()为例，对ArrayBlockingQueue的取出方法进行说明。

    public E take() throws InterruptedException {        // 获取“队列的独占锁”        final ReentrantLock lock = this.lock;        // 获取“锁”，若当前线程是中断状态，则抛出InterruptedException异常        lock.lockInterruptibly();        try {            // 若“队列为空”，则一直等待，并释放锁。            while (count == 0)                notEmpty.await();            // 取出元素                return dequeue();        } finally {            lock.unlock();        }    }

    private E dequeue() {        final Object[] items = this.items;        @SuppressWarnings("unchecked")        // 强制将元素转换为“泛型E”        E x = (E) items[takeIndex];        items[takeIndex] = null;        if (++takeIndex == items.length)            takeIndex = 0;        count--;        // 如果此时有定义迭代器，则对迭代器进行处理        if (itrs != null)            itrs.elementDequeued();        // 通知因为队列满了而被阻塞的线程可以继续运行了            notFull.signal();        return x;    }

---

遍历

---

ArrayBlockingQueue示例

import java.util.*;import java.util.concurrent.*;/* *   ArrayBlockingQueue是“线程安全”的队列，而LinkedList是非线程安全的。 * *   下面是“多个线程同时操作并且遍历queue”的示例 *   (01) 当queue是ArrayBlockingQueue对象时，程序能正常运行。 *   (02) 当queue是LinkedList对象时，程序会产生ConcurrentModificationException异常。 * * @author skywang */public class ArrayBlockingQueueDemo1{    // TODO: queue是LinkedList对象时，程序会出错。    //private static Queue<String> queue = new LinkedList<String>();    private static Queue<String> queue = new ArrayBlockingQueue<String>(20);    public static void main(String[] args) {        // 同时启动两个线程对queue进行操作！        new MyThread("ta").start();        new MyThread("tb").start();    }    private static void printAll() {        String value;        Iterator iter = queue.iterator();        while(iter.hasNext()) {            value = (String)iter.next();            System.out.print(value+", ");        }        System.out.println();    }    private static class MyThread extends Thread {        MyThread(String name) {            super(name);        }        @Override        public void run() {                int i = 0;            while (i++ < 6) {                // “线程名” + "-" + "序号"                String val = Thread.currentThread().getName()+i;                queue.add(val);                // 通过“Iterator”遍历queue。                printAll();            }        }    }}

LinkedList抛异常的原因：
Itr中的两个重要的方法: hasNext与next

    public E next() {            checkForComodification();        try {        E next = get(cursor);        lastRet = cursor++;        return next;        } catch (IndexOutOfBoundsException e) {        checkForComodification();        throw new NoSuchElementException();        }    }

看next中调用的checkForComodification(), 在remove方法中也调用了checkForComodification()！接着checkForComodification()方法里面在做些什么事情！

final void checkForComodification() {        if (modCount != expectedModCount)        throw new ConcurrentModificationException();    }

所以在迭代的过程中，hasNext()是不会抛出ConcurrentModificationException的， next和remove可能方法会抛！ 抛异常的标准就是modCount != expectedModCount！

也就是中途对list进行了修改，导致出错。

而在ArrayBlockingQueue中，public Iterator< E > iterator()返回在此队列中的元素上以正确顺序进行迭代的迭代器。返回的 Iterator 是一个“弱一致”的迭代器，从不抛出 ConcurrentModificationException，并且确保可遍历迭代器构造时存在的元素，此外还可能（但并不保证）反映构造后的所有修改。