Java concurrency集合之LinkedBlockingDeque_动力节点Java学院整理

// 创建一个容量为 Integer.MAX_VALUE 的 LinkedBlockingDeque。
LinkedBlockingDeque()
// 创建一个容量为 Integer.MAX_VALUE 的 LinkedBlockingDeque，最初包含给定 collection 的元素，以该 collection 迭代器的遍历顺序添加。
LinkedBlockingDeque(Collection<? extends E> c)
// 创建一个具有给定（固定）容量的 LinkedBlockingDeque。
LinkedBlockingDeque(int capacity)

// 在不违反容量限制的情况下，将指定的元素插入此双端队列的末尾。
boolean add(E e)
// 如果立即可行且不违反容量限制，则将指定的元素插入此双端队列的开头；如果当前没有空间可用，则抛出 IllegalStateException。
void addFirst(E e)
// 如果立即可行且不违反容量限制，则将指定的元素插入此双端队列的末尾；如果当前没有空间可用，则抛出 IllegalStateException。
void addLast(E e)
// 以原子方式 (atomically) 从此双端队列移除所有元素。
void clear()
// 如果此双端队列包含指定的元素，则返回 true。
boolean contains(Object o)
// 返回在此双端队列的元素上以逆向连续顺序进行迭代的迭代器。
Iterator<E> descendingIterator()
// 移除此队列中所有可用的元素，并将它们添加到给定 collection 中。
int drainTo(Collection<? super E> c)
// 最多从此队列中移除给定数量的可用元素，并将这些元素添加到给定 collection 中。
int drainTo(Collection<? super E> c, int maxElements)
// 获取但不移除此双端队列表示的队列的头部。
E element()
// 获取，但不移除此双端队列的第一个元素。
E getFirst()
// 获取，但不移除此双端队列的最后一个元素。
E getLast()
// 返回在此双端队列元素上以恰当顺序进行迭代的迭代器。
Iterator<E> iterator()
// 如果立即可行且不违反容量限制，则将指定的元素插入此双端队列表示的队列中（即此双端队列的尾部），并在成功时返回 true；如果当前没有空间可用，则返回 false。
boolean offer(E e)
// 将指定的元素插入此双端队列表示的队列中（即此双端队列的尾部），必要时将在指定的等待时间内一直等待可用空间。
boolean offer(E e, long timeout, TimeUnit unit)
// 如果立即可行且不违反容量限制，则将指定的元素插入此双端队列的开头，并在成功时返回 true；如果当前没有空间可用，则返回 false。
boolean offerFirst(E e)
// 将指定的元素插入此双端队列的开头，必要时将在指定的等待时间内等待可用空间。
boolean offerFirst(E e, long timeout, TimeUnit unit)
// 如果立即可行且不违反容量限制，则将指定的元素插入此双端队列的末尾，并在成功时返回 true；如果当前没有空间可用，则返回 false。
boolean offerLast(E e)
// 将指定的元素插入此双端队列的末尾，必要时将在指定的等待时间内等待可用空间。
boolean offerLast(E e, long timeout, TimeUnit unit)
// 获取但不移除此双端队列表示的队列的头部（即此双端队列的第一个元素）；如果此双端队列为空，则返回 null。
E peek()
// 获取，但不移除此双端队列的第一个元素；如果此双端队列为空，则返回 null。
E peekFirst()
// 获取，但不移除此双端队列的最后一个元素；如果此双端队列为空，则返回 null。
E peekLast()
// 获取并移除此双端队列表示的队列的头部（即此双端队列的第一个元素）；如果此双端队列为空，则返回 null。
E poll()
// 获取并移除此双端队列表示的队列的头部（即此双端队列的第一个元素），如有必要将在指定的等待时间内等待可用元素。
E poll(long timeout, TimeUnit unit)
// 获取并移除此双端队列的第一个元素；如果此双端队列为空，则返回 null。
E pollFirst()
// 获取并移除此双端队列的第一个元素，必要时将在指定的等待时间等待可用元素。
E pollFirst(long timeout, TimeUnit unit)
// 获取并移除此双端队列的最后一个元素；如果此双端队列为空，则返回 null。
E pollLast()
// 获取并移除此双端队列的最后一个元素，必要时将在指定的等待时间内等待可用元素。
E pollLast(long timeout, TimeUnit unit)
// 从此双端队列所表示的堆栈中弹出一个元素。
E pop()
// 将元素推入此双端队列表示的栈。
void push(E e)
// 将指定的元素插入此双端队列表示的队列中（即此双端队列的尾部），必要时将一直等待可用空间。
void put(E e)
// 将指定的元素插入此双端队列的开头，必要时将一直等待可用空间。
void putFirst(E e)
// 将指定的元素插入此双端队列的末尾，必要时将一直等待可用空间。
void putLast(E e)
// 返回理想情况下（没有内存和资源约束）此双端队列可不受阻塞地接受的额外元素数。
int remainingCapacity()
// 获取并移除此双端队列表示的队列的头部。
E remove()
// 从此双端队列移除第一次出现的指定元素。
boolean remove(Object o)
// 获取并移除此双端队列第一个元素。
E removeFirst()
// 从此双端队列移除第一次出现的指定元素。
boolean removeFirstOccurrence(Object o)
// 获取并移除此双端队列的最后一个元素。
E removeLast()
// 从此双端队列移除最后一次出现的指定元素。
boolean removeLastOccurrence(Object o)
// 返回此双端队列中的元素数。
int size()
// 获取并移除此双端队列表示的队列的头部（即此双端队列的第一个元素），必要时将一直等待可用元素。
E take()
// 获取并移除此双端队列的第一个元素，必要时将一直等待可用元素。
E takeFirst()
// 获取并移除此双端队列的最后一个元素，必要时将一直等待可用元素。
E takeLast()
// 返回以恰当顺序（从第一个元素到最后一个元素）包含此双端队列所有元素的数组。
Object[] toArray()
// 返回以恰当顺序包含此双端队列所有元素的数组；返回数组的运行时类型是指定数组的运行时类型。
<T> T[] toArray(T[] a)
// 返回此 collection 的字符串表示形式。
String toString()

public LinkedBlockingDeque(int capacity) {
 if (capacity <= 0) throw new IllegalArgumentException();
 this.capacity = capacity;
}

// “双向队列”的表头
transient Node<E> first;
// “双向队列”的表尾
transient Node<E> last;
// 节点数量
private transient int count;
// 容量
private final int capacity;
// 互斥锁 , 互斥锁对应的“非空条件notEmpty”, 互斥锁对应的“未满条件notFull”
final ReentrantLock lock = new ReentrantLock();
private final Condition notEmpty = lock.newCondition();
private final Condition notFull = lock.newCondition();

static final class Node<E> {
 E item;  // 数据
 Node<E> prev; // 前一节点
 Node<E> next; // 后一节点

 Node(E x) { item = x; }
}

public boolean offer(E e) {
 return offerLast(e);
}

public boolean offerLast(E e) {
 if (e == null) throw new NullPointerException();
 // 新建节点
 Node<E> node = new Node<E>(e);
 final ReentrantLock lock = this.lock;
 // 获取锁
 lock.lock();
 try {
  // 将“新节点”添加到双向链表的末尾
  return linkLast(node);
 } finally {
  // 释放锁
  lock.unlock();
 }
}

private boolean linkLast(Node<E> node) {
 // 如果“双向链表的节点数量” > “容量”，则返回false，表示插入失败。
 if (count >= capacity)
  return false;
 // 将“node添加到链表末尾”，并设置node为新的尾节点
 Node<E> l = last;
 node.prev = l;
 last = node;
 if (first == null)
  first = node;
 else
  l.next = node;
 // 将“节点数量”+1
 ++count;
 // 插入节点之后，唤醒notEmpty上的等待线程。
 notEmpty.signal();
 return true;
}

public E take() throws InterruptedException {
 return takeFirst();
}

public E takeFirst() throws InterruptedException {
 final ReentrantLock lock = this.lock;
 // 获取锁
 lock.lock();
 try {
  E x;
  // 若“队列为空”，则一直等待。否则，通过unlinkFirst()删除第一个节点。
  while ( (x = unlinkFirst()) == null)
   notEmpty.await();
  return x;
 } finally {
  // 释放锁
  lock.unlock();
 }
}

private E unlinkFirst() {
 // assert lock.isHeldByCurrentThread();
 Node<E> f = first;
 if (f == null)
  return null;
 // 删除并更新“第一个节点”
 Node<E> n = f.next;
 E item = f.item;
 f.item = null;
 f.next = f; // help GC
 first = n;
 if (n == null)
  last = null;
 else
  n.prev = null;
 // 将“节点数量”-1
 --count;
 // 删除节点之后，唤醒notFull上的等待线程。
 notFull.signal();
 return item;
}

public Iterator<E> iterator() {
 return new Itr();
}

private class Itr extends AbstractItr {
 // “双向队列”的表头
 Node<E> firstNode() { return first; }
 // 获取“节点n的下一个节点”
 Node<E> nextNode(Node<E> n) { return n.next; }
}

private abstract class AbstractItr implements Iterator<E> {
 // next是下一次调用next()会返回的节点。
 Node<E> next;
 // nextItem是next()返回节点对应的数据。
 E nextItem;
 // 上一次next()返回的节点。
 private Node<E> lastRet;
 // 返回第一个节点
 abstract Node<E> firstNode();
 // 返回下一个节点
 abstract Node<E> nextNode(Node<E> n);

 AbstractItr() {
  final ReentrantLock lock = LinkedBlockingDeque.this.lock;
  // 获取“LinkedBlockingDeque的互斥锁”
  lock.lock();
  try {
   // 获取“双向队列”的表头
   next = firstNode();
   // 获取表头对应的数据
   nextItem = (next == null) ? null : next.item;
  } finally {
   // 释放“LinkedBlockingDeque的互斥锁”
   lock.unlock();
  }
 }

 // 获取n的后继节点
 private Node<E> succ(Node<E> n) {
  // Chains of deleted nodes ending in null or self-links
  // are possible if multiple interior nodes are removed.
  for (;;) {
   Node<E> s = nextNode(n);
   if (s == null)
    return null;
   else if (s.item != null)
    return s;
   else if (s == n)
    return firstNode();
   else
    n = s;
  }
 }

 // 更新next和nextItem。
 void advance() {
  final ReentrantLock lock = LinkedBlockingDeque.this.lock;
  lock.lock();
  try {
   // assert next != null;
   next = succ(next);
   nextItem = (next == null) ? null : next.item;
  } finally {
   lock.unlock();
  }
 }

 // 返回“下一个节点是否为null”
 public boolean hasNext() {
  return next != null;
 }

 // 返回下一个节点
 public E next() {
  if (next == null)
   throw new NoSuchElementException();
  lastRet = next;
  E x = nextItem;
  advance();
  return x;
 }

 // 删除下一个节点
 public void remove() {
  Node<E> n = lastRet;
  if (n == null)
   throw new IllegalStateException();
  lastRet = null;
  final ReentrantLock lock = LinkedBlockingDeque.this.lock;
  lock.lock();
  try {
   if (n.item != null)
    unlink(n);
  } finally {
   lock.unlock();
  }
 }
}

 import java.util.*;
 import java.util.concurrent.*;
 
 /*
 * LinkedBlockingDeque是“线程安全”的队列，而LinkedList是非线程安全的。
 *
 * 下面是“多个线程同时操作并且遍历queue”的示例
 * (01) 当queue是LinkedBlockingDeque对象时，程序能正常运行。
 * (02) 当queue是LinkedList对象时，程序会产生ConcurrentModificationException异常。
 *
 * 
 */
 public class LinkedBlockingDequeDemo1 {
 
  // TODO: queue是LinkedList对象时，程序会出错。
  //private static Queue<String> queue = new LinkedList<String>();
  private static Queue<String> queue = new LinkedBlockingDeque<String>();
  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();
    }
   }
  }
 }

ta1, ta1, tb1, tb1,

ta1, ta1, tb1, tb1, tb2, tb2, ta2, 
ta2, 
ta1, ta1, tb1, tb1, tb2, tb2, ta2, ta2, tb3, tb3, ta3, 
ta3, ta1, 
tb1, ta1, tb2, tb1, ta2, tb2, tb3, ta2, ta3, tb3, tb4, ta3, ta4, 
tb4, ta1, ta4, tb1, tb5, 
tb2, ta1, ta2, tb1, tb3, tb2, ta3, ta2, tb4, tb3, ta4, ta3, tb5, tb4, ta5, 
ta4, ta1, tb5, tb1, ta5, tb2, tb6, 
ta2, ta1, tb3, tb1, ta3, tb2, tb4, ta2, ta4, tb3, tb5, ta3, ta5, tb4, tb6, ta4, ta6, 
tb5, ta5, tb6, ta6,