Java容器類源碼之Deque與ArrayDeque的示例分析

小編給大家分享一下Java容器類源碼之Deque與ArrayDeque的示例分析，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

Queue 也是 Java 集合框架中定義的一種接口，直接繼承自 Collection 接口。除了基本的 Collection 接口規(guī)定測(cè)操作外，Queue 接口還定義一組針對(duì)隊(duì)列的特殊操作。通常來(lái)說(shuō)，Queue 是按照先進(jìn)先出(FIFO)的方式來(lái)管理其中的元素的，但是優(yōu)先隊(duì)列是一個(gè)例外。

Deque 接口繼承自 Queue接口，但 Deque 支持同時(shí)從兩端添加或移除元素，因此又被成為雙端隊(duì)列。鑒于此，Deque 接口的實(shí)現(xiàn)可以被當(dāng)作 FIFO隊(duì)列使用，也可以當(dāng)作LIFO隊(duì)列（棧）來(lái)使用。官方也是推薦使用 Deque 的實(shí)現(xiàn)來(lái)替代 Stack。

ArrayDeque 是 Deque 接口的一種具體實(shí)現(xiàn)，是依賴于可變數(shù)組來(lái)實(shí)現(xiàn)的。ArrayDeque 沒(méi)有容量限制，可根據(jù)需求自動(dòng)進(jìn)行擴(kuò)容。ArrayDeque不支持值為 null 的元素。

下面基于JDK 8中的實(shí)現(xiàn)對(duì) ArrayDeque 加以分析。

方法概覽

public interface Queue<E> extends Collection<E> {
//向隊(duì)列中插入一個(gè)元素，并返回true
//如果隊(duì)列已滿，拋出IllegalStateException異常
boolean add(E e);
//向隊(duì)列中插入一個(gè)元素，并返回true
//如果隊(duì)列已滿，返回false
boolean offer(E e);
//取出隊(duì)列頭部的元素，并從隊(duì)列中移除
//隊(duì)列為空，拋出NoSuchElementException異常
E remove();
//取出隊(duì)列頭部的元素，并從隊(duì)列中移除
//隊(duì)列為空，返回null
E poll();
//取出隊(duì)列頭部的元素，但并不移除
//如果隊(duì)列為空，拋出NoSuchElementException異常
E element();
//取出隊(duì)列頭部的元素，但并不移除
//隊(duì)列為空，返回null
E peek();
}

Deque 提供了雙端的插入與移除操作，如下表：

Deque 和 Queue 方法的的對(duì)應(yīng)關(guān)系如下：

Deque 和 Stack 方法的對(duì)應(yīng)關(guān)系如下：

ArrayList 實(shí)現(xiàn)了 Deque 接口中的所有方法。因?yàn)?ArrayList 會(huì)根據(jù)需求自動(dòng)擴(kuò)充容量，因而在插入元素的時(shí)候不會(huì)拋出IllegalStateException異常。

底層結(jié)構(gòu)

//用數(shù)組存儲(chǔ)元素
transient Object[] elements; // non-private to simplify nested class access
//頭部元素的索引
transient int head;
//尾部下一個(gè)將要被加入的元素的索引
transient int tail;
//最小容量，必須為2的冪次方
private static final int MIN_INITIAL_CAPACITY = 8;

在 ArrayDeque 底部是使用數(shù)組存儲(chǔ)元素，同時(shí)還使用了兩個(gè)索引來(lái)表征當(dāng)前數(shù)組的狀態(tài)，分別是 head 和 tail。head 是頭部元素的索引，但注意 tail 不是尾部元素的索引，而是尾部元素的下一位，即下一個(gè)將要被加入的元素的索引。

初始化

ArrayDeque 提供了三個(gè)構(gòu)造方法，分別是默認(rèn)容量，指定容量及依據(jù)給定的集合中的元素進(jìn)行創(chuàng)建。默認(rèn)容量為16。

public ArrayDeque() {
elements = new Object[16];
}
public ArrayDeque(int numElements) {
allocateElements(numElements);
}
public ArrayDeque(Collection<? extends E> c) {
allocateElements(c.size());
addAll(c);
}

ArrayDeque 對(duì)數(shù)組的大小(即隊(duì)列的容量)有特殊的要求，必須是 2^n。通過(guò) allocateElements方法計(jì)算初始容量：

private void allocateElements(int numElements) {
int initialCapacity = MIN_INITIAL_CAPACITY;
// Find the best power of two to hold elements.
// Tests "<=" because arrays aren't kept full.
if (numElements >= initialCapacity) {
initialCapacity = numElements;
initialCapacity |= (initialCapacity >>> 1);
initialCapacity |= (initialCapacity >>> 2);
initialCapacity |= (initialCapacity >>> 4);
initialCapacity |= (initialCapacity >>> 8);
initialCapacity |= (initialCapacity >>> 16);
initialCapacity++;
if (initialCapacity < 0) // Too many elements, must back off
initialCapacity >>>= 1;// Good luck allocating 2 ^ 30 elements
}
elements = new Object[initialCapacity];
}

>>>是無(wú)符號(hào)右移操作，|是位或操作，經(jīng)過(guò)五次右移和位或操作可以保證得到大小為2^k-1的數(shù)?？匆幌逻@個(gè)例子：

0 0 0 0 1 ? ? ? ? ? //n
0 0 0 0 1 1 ? ? ? ? //n |= n >>> 1;
0 0 0 0 1 1 1 1 ? ? //n |= n >>> 2;
0 0 0 0 1 1 1 1 1 1 //n |= n >>> 4;

在進(jìn)行5次位移操作和位或操作后就可以得到2^k-1，最后加1即可。這個(gè)實(shí)現(xiàn)還是很巧妙的。

添加元素

向末尾添加元素：

public void addLast(E e) {
if (e == null)
throw new NullPointerException();
//tail 中保存的是即將加入末尾的元素的索引
elements[tail] = e;
//tail 向后移動(dòng)一位
//把數(shù)組當(dāng)作環(huán)形的，越界后到0索引
if ( (tail = (tail + 1) & (elements.length - 1)) == head)
//tail 和 head相遇，空間用盡，需要擴(kuò)容
doubleCapacity();
}

這段代碼中，(tail = (tail + 1) & (elements.length - 1)) == head這句有點(diǎn)難以理解。其實(shí)，在 ArrayDeque 中數(shù)組是當(dāng)作環(huán)形來(lái)使用的，索引0看作是緊挨著索引(length-1)之后的。參考下面的圖片：

那么為什么(tail + 1) & (elements.length - 1)就能保證按照環(huán)形取得正確的下一個(gè)索引值呢？這就和前面說(shuō)到的 ArrayDeque 對(duì)容量的特殊要求有關(guān)了。下面對(duì)其正確性加以驗(yàn)證：

• length = 2^n，二進(jìn)制表示為: 第 n 位為1，低位 (n-1位) 全為0

• length - 1 = 2^n-1，二進(jìn)制表示為：低位(n-1位)全為1

• 如果 tail + 1 <= length - 1，則位與后低 (n-1) 位保持不變，高位全為0

• 如果 tail + 1 = length，則位與后低 n 全為0，高位也全為0，結(jié)果為 0

可見，在容量保證為 2^n 的情況下，僅僅通過(guò)位與操作就可以完成環(huán)形索引的計(jì)算，而不需要進(jìn)行邊界的判斷，在實(shí)現(xiàn)上更為高效。

向頭部添加元素的代碼如下：

public void addFirst(E e) {
if (e == null) //不支持值為null的元素
throw new NullPointerException();
elements[head = (head - 1) & (elements.length - 1)] = e;
if (head == tail)
doubleCapacity();
}

其它的諸如add，offer，offerFirst，offerLast等方法都是基于上面這兩個(gè)方法實(shí)現(xiàn)的，不再贅述。

擴(kuò)容

在每次添加元素后，如果頭索引和尾部索引相遇，則說(shuō)明數(shù)組空間已滿，需要進(jìn)行擴(kuò)容操作。 ArrayDeque 每次擴(kuò)容都會(huì)在原有的容量上翻倍，這也是對(duì)容量必須是2的冪次方的保證。

private void doubleCapacity() {
assert head == tail; //擴(kuò)容時(shí)頭部索引和尾部索引肯定相等
int p = head;
int n = elements.length;
//頭部索引到數(shù)組末端(length-1處)共有多少元素
int r = n - p; // number of elements to the right of p
//容量翻倍
int newCapacity = n << 1;
//容量過(guò)大，溢出了
if (newCapacity < 0)
throw new IllegalStateException("Sorry, deque too big");
//分配新空間
Object[] a = new Object[newCapacity];
//復(fù)制頭部索引到數(shù)組末端的元素到新數(shù)組的頭部
System.arraycopy(elements, p, a, 0, r);
//復(fù)制其余元素
System.arraycopy(elements, 0, a, r, p);
elements = a;
//重置頭尾索引
head = 0;
tail = n;
}

移除元素

ArrayDeque支持從頭尾兩端移除元素，remove方法是通過(guò)poll來(lái)實(shí)現(xiàn)的。因?yàn)槭腔跀?shù)組的，在了解了環(huán)的原理后這段代碼就比較容易理解了。

public E pollFirst() {
int h = head;
@SuppressWarnings("unchecked")
E result = (E) elements[h];
// Element is null if deque empty
if (result == null)
return null;
elements[h] = null; // Must null out slot
head = (h + 1) & (elements.length - 1);
return result;
}
public E pollLast() {
int t = (tail - 1) & (elements.length - 1);
@SuppressWarnings("unchecked")
E result = (E) elements[t];
if (result == null)
return null;
elements[t] = null;
tail = t;
return result;
}

獲取隊(duì)頭和隊(duì)尾的元素

@SuppressWarnings("unchecked")
public E peekFirst() {
// elements[head] is null if deque empty
return (E) elements[head];
}
@SuppressWarnings("unchecked")
public E peekLast() {
return (E) elements[(tail - 1) & (elements.length - 1)];
}

迭代器

ArrayDeque 在迭代是檢查并發(fā)修改并沒(méi)有使用類似于 ArrayList 等容器中使用的 modCount，而是通過(guò)尾部索引的來(lái)確定的。具體參考 next 方法中的注釋。但是這樣不一定能保證檢測(cè)到所有的并發(fā)修改情況，加入先移除了尾部元素，又添加了一個(gè)尾部元素，這種情況下迭代器是沒(méi)法檢測(cè)出來(lái)的。

private class DeqIterator implements Iterator<E> {
/**
* Index of element to be returned by subsequent call to next.
*/
private int cursor = head;
/**
* Tail recorded at construction (also in remove), to stop
* iterator and also to check for comodification.
*/
private int fence = tail;
/**
* Index of element returned by most recent call to next.
* Reset to -1 if element is deleted by a call to remove.
*/
private int lastRet = -1;
public boolean hasNext() {
return cursor != fence;
}
public E next() {
if (cursor == fence)
throw new NoSuchElementException();
@SuppressWarnings("unchecked")
E result = (E) elements[cursor];
// This check doesn't catch all possible comodifications,
// but does catch the ones that corrupt traversal
// 如果移除了尾部元素，會(huì)導(dǎo)致tail != fence
// 如果移除了頭部元素，會(huì)導(dǎo)致 result == null
if (tail != fence || result == null)
throw new ConcurrentModificationException();
lastRet = cursor;
cursor = (cursor + 1) & (elements.length - 1);
return result;
}
public void remove() {
if (lastRet < 0)
throw new IllegalStateException();
if (delete(lastRet)) { // if left-shifted, undo increment in next()
cursor = (cursor - 1) & (elements.length - 1);
fence = tail;
}
lastRet = -1;
}
public void forEachRemaining(Consumer<? super E> action) {
Objects.requireNonNull(action);
Object[] a = elements;
int m = a.length - 1, f = fence, i = cursor;
cursor = f;
while (i != f) {
@SuppressWarnings("unchecked") E e = (E)a[i];
i = (i + 1) & m;
if (e == null)
throw new ConcurrentModificationException();
action.accept(e);
}
}
}

除了 DeqIterator，還有一個(gè)反向的迭代器 DescendingIterator，順序和 DeqIterator 相反。

以上是“Java容器類源碼之Deque與ArrayDeque的示例分析”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！