ArrayDeque类的使⽤详解
ArrayDeque是Deque接⼝的⼀个实现，使⽤了可变数组，所以没有容量上的限制。
同时，ArrayDeque是线程不安全的，在没有外部同步的情况下，不能再多线程环境下使⽤。
ArrayDeque是Deque的实现类，可以作为栈来使⽤，效率⾼于Stack；
也可以作为队列来使⽤，效率⾼于LinkedList。
需要注意的是，ArrayDeque不⽀持null值。
⼀、常⽤⽅法
1.添加元素
addFirst(E e)在数组前⾯添加元素
addLast(E e)在数组后⾯添加元素
offerFirst(E e) 在数组前⾯添加元素，并返回是否添加成功
offerLast(E e) 在数组后天添加元素，并返回是否添加成功
2.删除元素
removeFirst()删除第⼀个元素，并返回删除元素的值，如果元素为null，将抛出异常
pollFirst()删除第⼀个元素，并返回删除元素的值，如果元素为null，将返回null
removeLast()删除最后⼀个元素，并返回删除元素的值，如果为null，将抛出异常
pollLast()删除最后⼀个元素，并返回删除元素的值，如果为null，将返回null
removeFirstOccurrence(Object o) 删除第⼀次出现的指定元素
removeLastOccurrence(Object o) 删除最后⼀次出现的指定元素
3.获取元素
getFirst() 获取第⼀个元素，如果没有将抛出异常
getLast() 获取最后⼀个元素，如果没有将抛出异常
4.队列操作
add(E e) 在队列尾部添加⼀个元素
offer(E e) 在队列尾部添加⼀个元素，并返回是否成功
remove() 删除队列中第⼀个元素，并返回该元素的值，如果元素为null，将抛出异常(其实底层调⽤的是removeFirst())
poll()  删除队列中第⼀个元素，并返回该元素的值，如果元素为null，将返回null(其实调⽤的是pollFirst())
element() 获取第⼀个元素，如果没有将抛出异常
peek() 获取第⼀个元素，如果返回null
5.栈操作
push(E e) 栈顶添加⼀个元素
pop(E e) 移除栈顶元素，如果栈顶没有元素将抛出异常
6.其他
size() 获取队列中元素个数
isEmpty() 判断队列是否为空
iterator() 迭代器，从前向后迭代
descendingIterator() 迭代器，从后向前迭代
contain(Object o) 判断队列中是否存在该元素
toArray() 转成数组
clear() 清空队列
clone() 克隆(复制)⼀个新的队列
⼆、源码分析
结构
在ArrayDeque底层使⽤了数组来存储数据，同时⽤两个int值head和tail来表⽰头部和尾部。
不过需要注意的是tail并不是尾部元素的索引，⽽是尾部元素的下⼀位，即下⼀个将要被加⼊的元素的索引。
//⽤数组存储元素
transient Object[] elements; // non-private to simplify nested class access
//头部元素的索引
transient int head;
//尾部下⼀个将要被加⼊的元素的索引
transient int tail;
//最⼩容量，必须为2的幂次⽅
private static final int MIN_INITIAL_CAPACITY = 8;
2. 构造⽅法
ArrayDeque有三个构造函数来初始化，除了⽆参的构造函数使⽤了默认容量，其它两个构造函数会通过allocateElements来计算初始容量。public ArrayDeque() {
elements = (E[]) new Object[16]; // 默认的数组长度⼤⼩
}
public ArrayDeque(int numElements) {
allocateElements(numElements); // 需要的数组长度⼤⼩
}
public ArrayDeque(Collection<? extends E> c) {
allocateElements(c.size()); // 根据集合来分配数组⼤⼩
addAll(c); // 把集合中元素放到数组中
}
3. 分配合适⼤⼩的数组
ArrayDeque对数组的⼤⼩(即队列的容量)有特殊的要求，必须是 2^n。我们来看⼀下allocateElements⽅法。
private void allocateElements(int numElements) {
int initialCapacity = MIN_INITIAL_CAPACITY;
// 到⼤于需要长度的最⼩的2的幂整数。
// 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 = (E[]) new Object[initialCapacity];
}
这⾥的实现很有意思，对于⼀个⼩于2^30的值，经过五次右移和位或操作后，可以得到⼀个2^k - 1的值。最后再将这个值+1，得到2^k。通过这个⽅法，可以将⼀个任意的初始值转化为2^n的值，不过有⼀点不⾜在于，如果本⾝传进来的值就是2^n的值，那么经过转化会变成2^(n+1)，所以我们在不⽤刻意去传⼊2^n的值。还有⼀点在于，如果传⼊的值⼤于等于2^30，那么经过转化会变成负值，即< 0，此时会把初始值设置为2^30，即最⼤的容量只有2^30。
4. 扩容
// 扩容为原来的2倍。
private void doubleCapacity() {
assert head == tail;
int p = head;
int n = elements.length;
int r = n - p; // number of elements to the right of p
int newCapacity = n << 1;
if (newCapacity < 0)
throw new IllegalStateException("Sorry, deque too big");
Object[] a = new Object[newCapacity];
// 既然是head和tail已经重合了，说明tail是在head的左边。
System.arraycopy(elements, p, a, 0, r); // 拷贝原数组从head位置到结束的数据
System.arraycopy(elements, 0, a, r, p); // 拷贝原数组从开始到head的数据
elements = (E[])a;
head = 0; // 重置head和tail为数据的开始和结束索引
tail = n;
}
// 拷贝该数组的所有元素到⽬标数组
private <T> T[] copyElements(T[] a) {
if (head < tail) { // 开始索引⼤于结束索引，⼀次拷贝
System.arraycopy(elements, head, a, 0, size());
} else if (head > tail) { // 开始索引在结束索引的右边，分两段拷贝
int headPortionLen = elements.length - head;
System.arraycopy(elements, head, a, 0, headPortionLen);
System.arraycopy(elements, 0, a, headPortionLen, tail);
}
return a;
}
5. 添加元素
public void addFirst(E e) {
if (e == null)
throw new NullPointerException();
// 本来可以简单地写成head-1，但如果head为0，减1就变为-1了，和elements.length - 1进⾏与操作就是为了处理这种情况，这时结果为elements.length - 1。
elements[head = (head - 1) & (elements.length - 1)] = e;
if (head == tail) // head和tail不可以重叠
doubleCapacity();
}
public void addLast(E e) {
if (e == null)
throw new NullPointerException();
// tail位置是空的，把元素放到这。
elements[tail] = e;
// 和head的操作类似，为了处理临界情况 (tail为length - 1时)，和length - 1进⾏与操作，结果为0。
if ( (tail = (tail + 1) & (elements.length - 1)) == head)
doubleCapacity();
}
public boolean offerFirst(E e) {
addFirst(e);
return true;
}
public boolean offerLast(E e) {
addLast(e);
return true;
}
6. 删除元素删除⾸尾元素：
public E removeFirst() {
E x = pollFirst();
if (x == null)
throw new NoSuchElementException();
return x;
}
public E removeLast() {
E x = pollLast();
if (x == null)
throw new NoSuchElementException();
return x;
}
public E pollFirst() {
int h = head;
E result = elements[h]; // Element is null if deque empty
if (result == null)
return null;
// 表明head位置已为空
elements[h] = null;    // Must null out slot
head = (h + 1) & (elements.length - 1); // 处理临界情况（当h为elements.length - 1时），与后的结果为0。
return result;
}
array工艺详解
public E pollLast() {
int t = (tail - 1) & (elements.length - 1); // 处理临界情况（当tail为0时），与后的结果为elements.length - 1。
E result = elements[t];
if (result == null)
return null;
elements[t] = null;
tail = t; // tail指向的是下个要添加元素的索引。
return result;
}
删除指定元素
public boolean removeFirstOccurrence(Object o) {
if (o == null)
return false;
int mask = elements.length - 1;
int i = head;
E x;
while ( (x = elements[i]) != null) {
if (o.equals(x)) {
delete(i);
return true;
}
i = (i + 1) & mask; // 从头到尾遍历
}
return false;
}
public boolean removeLastOccurrence(Object o) {
if (o == null)
return false;
int mask = elements.length - 1;
int i = (tail - 1) & mask; // 末尾元素的索引
E x;
while ( (x = elements[i]) != null) {
if (o.equals(x)) {
delete(i);
return true;
}
i = (i - 1) & mask; // 从尾到头遍历
}
return false;
}
private void checkInvariants() { // 有效性检查
assert elements[tail] == null; // tail位置没有元素
assert head == tail ? elements[head] == null :
(elements[head] != null &&
elements[(tail - 1) & (elements.length - 1)] != null); // 如果head和tail重叠，队列为空；否则head位置有元素，tail-1位置有元素。assert elements[(head - 1) & (elements.length - 1)] == null; // head-1的位置没有元素。
}
private boolean delete(int i) {
checkInvariants();
final E[] elements = this.elements;
final int mask = elements.length - 1;
final int h = head;
final int t = tail;
final int front = (i - h) & mask; // i前⾯的元素个数
final int back  = (t - i) & mask; // i后⾯的元素个数
// Invariant: head <= i < tail mod circularity
if (front >= ((t - h) & mask)) // i不在head和tail之间
throw new ConcurrentModificationException();
// Optimize for least element motion
if (front < back) { // i的位置靠近head，移动开始的元素，返回false。
if (h <= i) {
System.arraycopy(elements, h, elements, h + 1, front);
} else { // Wrap around
System.arraycopy(elements, 0, elements, 1, i);
elements[0] = elements[mask]; // 处理边缘元素
System.arraycopy(elements, h, elements, h + 1, mask - h);
}
elements[h] = null;
head = (h + 1) & mask; // head位置后移
return false;
} else { // i的位置靠近tail，移动末尾的元素，返回true。
if (i < t) { // Copy the null tail as well
System.arraycopy(elements, i + 1, elements, i, back);
tail = t - 1;
} else { // Wrap around
System.arraycopy(elements, i + 1, elements, i, mask - i);
elements[mask] = elements[0];
System.arraycopy(elements, 1, elements, 0, t);
tail = (t - 1) & mask;
}
return true;
}
}
7. 获取元素
public E getFirst() {
E x = elements[head];
if (x == null)
throw new NoSuchElementException();
return x;
}
public E getLast() {
E x = elements[(tail - 1) & (elements.length - 1)]; // 处理临界情况（当tail为0时），与后的结果为elements.length - 1。
if (x == null)
throw new NoSuchElementException();
return x;
}
public E peekFirst() {
return elements[head]; // elements[head] is null if deque empty
}
public E peekLast() {
return elements[(tail - 1) & (elements.length - 1)];
}
8. 队列操作
public boolean add(E e) {
addLast(e);
return true;
}
public boolean offer(E e) {
return offerLast(e);
}
public E remove() {
return removeFirst();
}
public E poll() {
return pollFirst();
}
public E element() {
return getFirst();
}
public E peek() {
return peekFirst();
}
9. 栈操作
public void push(E e) {
addFirst(e);
}
public E pop() {
return removeFirst();
}
10. 集合⽅法
public int size() {
return (tail - head) & (elements.length - 1); // 和elements.length - 1进⾏与操作是为了处理当tail < head时的情况。}
public boolean isEmpty() {
return head == tail; // tail位置的元素⼀定为空，head和tail相等，也为空。
}
// 向前迭代器
public Iterator<E> iterator() {
return new DeqIterator();
}
// 向后迭代器
public Iterator<E> descendingIterator() {
return new DescendingIterator();
}
private class DeqIterator implements Iterator<E> {
private int cursor = head;
private int fence = tail; // 迭代终⽌索引，同时也为了检测并发修改。
private int lastRet = -1; // 最近的next()调⽤返回的索引。据此可以定位到需要删除元素的位置。
public boolean hasNext() {
return cursor != fence;
}
public E next() {
if (cursor == fence)
throw new NoSuchElementException();
E result = elements[cursor];
/
/ This check doesn't catch all possible comodifications,
// but does catch the ones that corrupt traversal
if (tail != fence || result == null)
throw new ConcurrentModificationException();
lastRet = cursor;
cursor = (cursor + 1) & (elements.length - 1); // 游标位置加1
return result;
}
public void remove() {
if (lastRet < 0)
throw new IllegalStateException();

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。