Java concurrency集合之LinkedBlockingDeque_動(dòng)力節(jié)點(diǎn)Java學(xué)院整理

// 創(chuàng)建一個(gè)容量為 Integer.MAX_VALUE 的 LinkedBlockingDeque。
LinkedBlockingDeque()
// 創(chuàng)建一個(gè)容量為 Integer.MAX_VALUE 的 LinkedBlockingDeque，最初包含給定 collection 的元素，以該 collection 迭代器的遍歷順序添加。
LinkedBlockingDeque(Collection<? extends E> c)
// 創(chuàng)建一個(gè)具有給定（固定）容量的 LinkedBlockingDeque。
LinkedBlockingDeque(int capacity)

// 在不違反容量限制的情況下，將指定的元素插入此雙端隊(duì)列的末尾。
boolean add(E e)
// 如果立即可行且不違反容量限制，則將指定的元素插入此雙端隊(duì)列的開頭；如果當(dāng)前沒有空間可用，則拋出 IllegalStateException。
void addFirst(E e)
// 如果立即可行且不違反容量限制，則將指定的元素插入此雙端隊(duì)列的末尾；如果當(dāng)前沒有空間可用，則拋出 IllegalStateException。
void addLast(E e)
// 以原子方式 (atomically) 從此雙端隊(duì)列移除所有元素。
void clear()
// 如果此雙端隊(duì)列包含指定的元素，則返回 true。
boolean contains(Object o)
// 返回在此雙端隊(duì)列的元素上以逆向連續(xù)順序進(jìn)行迭代的迭代器。
Iterator<E> descendingIterator()
// 移除此隊(duì)列中所有可用的元素，并將它們添加到給定 collection 中。
int drainTo(Collection<? super E> c)
// 最多從此隊(duì)列中移除給定數(shù)量的可用元素，并將這些元素添加到給定 collection 中。
int drainTo(Collection<? super E> c, int maxElements)
// 獲取但不移除此雙端隊(duì)列表示的隊(duì)列的頭部。
E element()
// 獲取，但不移除此雙端隊(duì)列的第一個(gè)元素。
E getFirst()
// 獲取，但不移除此雙端隊(duì)列的最后一個(gè)元素。
E getLast()
// 返回在此雙端隊(duì)列元素上以恰當(dāng)順序進(jìn)行迭代的迭代器。
Iterator<E> iterator()
// 如果立即可行且不違反容量限制，則將指定的元素插入此雙端隊(duì)列表示的隊(duì)列中（即此雙端隊(duì)列的尾部），并在成功時(shí)返回 true；如果當(dāng)前沒有空間可用，則返回 false。
boolean offer(E e)
// 將指定的元素插入此雙端隊(duì)列表示的隊(duì)列中（即此雙端隊(duì)列的尾部），必要時(shí)將在指定的等待時(shí)間內(nèi)一直等待可用空間。
boolean offer(E e, long timeout, TimeUnit unit)
// 如果立即可行且不違反容量限制，則將指定的元素插入此雙端隊(duì)列的開頭，并在成功時(shí)返回 true；如果當(dāng)前沒有空間可用，則返回 false。
boolean offerFirst(E e)
// 將指定的元素插入此雙端隊(duì)列的開頭，必要時(shí)將在指定的等待時(shí)間內(nèi)等待可用空間。
boolean offerFirst(E e, long timeout, TimeUnit unit)
// 如果立即可行且不違反容量限制，則將指定的元素插入此雙端隊(duì)列的末尾，并在成功時(shí)返回 true；如果當(dāng)前沒有空間可用，則返回 false。
boolean offerLast(E e)
// 將指定的元素插入此雙端隊(duì)列的末尾，必要時(shí)將在指定的等待時(shí)間內(nèi)等待可用空間。
boolean offerLast(E e, long timeout, TimeUnit unit)
// 獲取但不移除此雙端隊(duì)列表示的隊(duì)列的頭部（即此雙端隊(duì)列的第一個(gè)元素）；如果此雙端隊(duì)列為空，則返回 null。
E peek()
// 獲取，但不移除此雙端隊(duì)列的第一個(gè)元素；如果此雙端隊(duì)列為空，則返回 null。
E peekFirst()
// 獲取，但不移除此雙端隊(duì)列的最后一個(gè)元素；如果此雙端隊(duì)列為空，則返回 null。
E peekLast()
// 獲取并移除此雙端隊(duì)列表示的隊(duì)列的頭部（即此雙端隊(duì)列的第一個(gè)元素）；如果此雙端隊(duì)列為空，則返回 null。
E poll()
// 獲取并移除此雙端隊(duì)列表示的隊(duì)列的頭部（即此雙端隊(duì)列的第一個(gè)元素），如有必要將在指定的等待時(shí)間內(nèi)等待可用元素。
E poll(long timeout, TimeUnit unit)
// 獲取并移除此雙端隊(duì)列的第一個(gè)元素；如果此雙端隊(duì)列為空，則返回 null。
E pollFirst()
// 獲取并移除此雙端隊(duì)列的第一個(gè)元素，必要時(shí)將在指定的等待時(shí)間等待可用元素。
E pollFirst(long timeout, TimeUnit unit)
// 獲取并移除此雙端隊(duì)列的最后一個(gè)元素；如果此雙端隊(duì)列為空，則返回 null。
E pollLast()
// 獲取并移除此雙端隊(duì)列的最后一個(gè)元素，必要時(shí)將在指定的等待時(shí)間內(nèi)等待可用元素。
E pollLast(long timeout, TimeUnit unit)
// 從此雙端隊(duì)列所表示的堆棧中彈出一個(gè)元素。
E pop()
// 將元素推入此雙端隊(duì)列表示的棧。
void push(E e)
// 將指定的元素插入此雙端隊(duì)列表示的隊(duì)列中（即此雙端隊(duì)列的尾部），必要時(shí)將一直等待可用空間。
void put(E e)
// 將指定的元素插入此雙端隊(duì)列的開頭，必要時(shí)將一直等待可用空間。
void putFirst(E e)
// 將指定的元素插入此雙端隊(duì)列的末尾，必要時(shí)將一直等待可用空間。
void putLast(E e)
// 返回理想情況下（沒有內(nèi)存和資源約束）此雙端隊(duì)列可不受阻塞地接受的額外元素?cái)?shù)。
int remainingCapacity()
// 獲取并移除此雙端隊(duì)列表示的隊(duì)列的頭部。
E remove()
// 從此雙端隊(duì)列移除第一次出現(xiàn)的指定元素。
boolean remove(Object o)
// 獲取并移除此雙端隊(duì)列第一個(gè)元素。
E removeFirst()
// 從此雙端隊(duì)列移除第一次出現(xiàn)的指定元素。
boolean removeFirstOccurrence(Object o)
// 獲取并移除此雙端隊(duì)列的最后一個(gè)元素。
E removeLast()
// 從此雙端隊(duì)列移除最后一次出現(xiàn)的指定元素。
boolean removeLastOccurrence(Object o)
// 返回此雙端隊(duì)列中的元素?cái)?shù)。
int size()
// 獲取并移除此雙端隊(duì)列表示的隊(duì)列的頭部（即此雙端隊(duì)列的第一個(gè)元素），必要時(shí)將一直等待可用元素。
E take()
// 獲取并移除此雙端隊(duì)列的第一個(gè)元素，必要時(shí)將一直等待可用元素。
E takeFirst()
// 獲取并移除此雙端隊(duì)列的最后一個(gè)元素，必要時(shí)將一直等待可用元素。
E takeLast()
// 返回以恰當(dāng)順序（從第一個(gè)元素到最后一個(gè)元素）包含此雙端隊(duì)列所有元素的數(shù)組。
Object[] toArray()
// 返回以恰當(dāng)順序包含此雙端隊(duì)列所有元素的數(shù)組；返回?cái)?shù)組的運(yùn)行時(shí)類型是指定數(shù)組的運(yùn)行時(shí)類型。
<T> T[] toArray(T[] a)
// 返回此 collection 的字符串表示形式。
String toString()

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

// “雙向隊(duì)列”的表頭
transient Node<E> first;
// “雙向隊(duì)列”的表尾
transient Node<E> last;
// 節(jié)點(diǎn)數(shù)量
private transient int count;
// 容量
private final int capacity;
// 互斥鎖 , 互斥鎖對應(yīng)的“非空條件notEmpty”, 互斥鎖對應(yīng)的“未滿條件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;  // 數(shù)據(jù)
 Node<E> prev; // 前一節(jié)點(diǎn)
 Node<E> next; // 后一節(jié)點(diǎn)

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

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

public boolean offerLast(E e) {
 if (e == null) throw new NullPointerException();
 // 新建節(jié)點(diǎn)
 Node<E> node = new Node<E>(e);
 final ReentrantLock lock = this.lock;
 // 獲取鎖
 lock.lock();
 try {
  // 將“新節(jié)點(diǎn)”添加到雙向鏈表的末尾
  return linkLast(node);
 } finally {
  // 釋放鎖
  lock.unlock();
 }
}

private boolean linkLast(Node<E> node) {
 // 如果“雙向鏈表的節(jié)點(diǎn)數(shù)量” > “容量”，則返回false，表示插入失敗。
 if (count >= capacity)
  return false;
 // 將“node添加到鏈表末尾”，并設(shè)置node為新的尾節(jié)點(diǎn)
 Node<E> l = last;
 node.prev = l;
 last = node;
 if (first == null)
  first = node;
 else
  l.next = node;
 // 將“節(jié)點(diǎn)數(shù)量”+1
 ++count;
 // 插入節(jié)點(diǎn)之后，喚醒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;
  // 若“隊(duì)列為空”，則一直等待。否則，通過unlinkFirst()刪除第一個(gè)節(jié)點(diǎn)。
  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;
 // 刪除并更新“第一個(gè)節(jié)點(diǎn)”
 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;
 // 將“節(jié)點(diǎn)數(shù)量”-1
 --count;
 // 刪除節(jié)點(diǎn)之后，喚醒notFull上的等待線程。
 notFull.signal();
 return item;
}

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

private class Itr extends AbstractItr {
 // “雙向隊(duì)列”的表頭
 Node<E> firstNode() { return first; }
 // 獲取“節(jié)點(diǎn)n的下一個(gè)節(jié)點(diǎn)”
 Node<E> nextNode(Node<E> n) { return n.next; }
}

private abstract class AbstractItr implements Iterator<E> {
 // next是下一次調(diào)用next()會(huì)返回的節(jié)點(diǎn)。
 Node<E> next;
 // nextItem是next()返回節(jié)點(diǎn)對應(yīng)的數(shù)據(jù)。
 E nextItem;
 // 上一次next()返回的節(jié)點(diǎn)。
 private Node<E> lastRet;
 // 返回第一個(gè)節(jié)點(diǎn)
 abstract Node<E> firstNode();
 // 返回下一個(gè)節(jié)點(diǎn)
 abstract Node<E> nextNode(Node<E> n);

 AbstractItr() {
  final ReentrantLock lock = LinkedBlockingDeque.this.lock;
  // 獲取“LinkedBlockingDeque的互斥鎖”
  lock.lock();
  try {
   // 獲取“雙向隊(duì)列”的表頭
   next = firstNode();
   // 獲取表頭對應(yīng)的數(shù)據(jù)
   nextItem = (next == null) ? null : next.item;
  } finally {
   // 釋放“LinkedBlockingDeque的互斥鎖”
   lock.unlock();
  }
 }

 // 獲取n的后繼節(jié)點(diǎ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();
  }
 }

 // 返回“下一個(gè)節(jié)點(diǎn)是否為null”
 public boolean hasNext() {
  return next != null;
 }

 // 返回下一個(gè)節(jié)點(diǎn)
 public E next() {
  if (next == null)
   throw new NoSuchElementException();
  lastRet = next;
  E x = nextItem;
  advance();
  return x;
 }

 // 刪除下一個(gè)節(jié)點(diǎn)
 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是“線程安全”的隊(duì)列，而LinkedList是非線程安全的。
 *
 * 下面是“多個(gè)線程同時(shí)操作并且遍歷queue”的示例
 * (01) 當(dāng)queue是LinkedBlockingDeque對象時(shí)，程序能正常運(yùn)行。
 * (02) 當(dāng)queue是LinkedList對象時(shí)，程序會(huì)產(chǎn)生ConcurrentModificationException異常。
 *
 * 
 */
 public class LinkedBlockingDequeDemo1 {
 
  // TODO: queue是LinkedList對象時(shí)，程序會(huì)出錯(cuò)。
  //private static Queue<String> queue = new LinkedList<String>();
  private static Queue<String> queue = new LinkedBlockingDeque<String>();
  public static void main(String[] args) {
  
   // 同時(shí)啟動(dòng)兩個(gè)線程對queue進(jìn)行操作！
   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,