乐趣区

死磕-java集合之ArrayDeque源码分析

问题

(1)什么是双端队列?

(2)ArrayDeque 是怎么实现双端队列的?

(3)ArrayDeque 是线程安全的吗?

(4)ArrayDeque 是有界的吗?

简介

双端队列是一种特殊的队列,它的两端都可以进出元素,故而得名双端队列。

ArrayDeque 是一种以数组方式实现的双端队列,它是非线程安全的。

继承体系

通过继承体系可以看,ArrayDeque 实现了 Deque 接口,Deque 接口继承自 Queue 接口,它是对 Queue 的一种增强。


public interface Deque<E> extends Queue<E> {
    // 添加元素到队列头
    void addFirst(E e);
    // 添加元素到队列尾
    void addLast(E e);
    // 添加元素到队列头
    boolean offerFirst(E e);
    // 添加元素到队列尾
    boolean offerLast(E e);
    // 从队列头移除元素
    E removeFirst();
    // 从队列尾移除元素
    E removeLast();
    // 从队列头移除元素
    E pollFirst();
    // 从队列尾移除元素
    E pollLast();
    // 查看队列头元素
    E getFirst();
    // 查看队列尾元素
    E getLast();
    // 查看队列头元素
    E peekFirst();
    // 查看队列尾元素
    E peekLast();
    // 从队列头向后遍历移除指定元素
    boolean removeFirstOccurrence(Object o);
    // 从队列尾向前遍历移除指定元素
    boolean removeLastOccurrence(Object o);

    // *** 队列中的方法 ***
    
    // 添加元素,等于 addLast(e)
    boolean add(E e);
     // 添加元素,等于 offerLast(e)
    boolean offer(E e);
    // 移除元素,等于 removeFirst()
    E remove();
    // 移除元素,等于 pollFirst()
    E poll();
    // 查看元素,等于 getFirst()
    E element();
    // 查看元素,等于 peekFirst()
    E peek();

    // *** 栈方法 ***【本篇文章由公众号“彤哥读源码”原创】// 入栈,等于 addFirst(e)
    void push(E e);
    // 出栈,等于 removeFirst()
    E pop();

    // *** Collection 中的方法 ***
    
    // 删除指定元素,等于 removeFirstOccurrence(o)
    boolean remove(Object o);
    // 检查是否包含某个元素
    boolean contains(Object o);
    // 元素个数
    public int size();
    // 迭代器
    Iterator<E> iterator();
    // 反向迭代器
    Iterator<E> descendingIterator();}

Deque 中新增了以下几类方法:

(1)*First,表示从队列头操作元素;

(2)*Last,表示从队列尾操作元素;

(3)push(e),pop(),以栈的方式操作元素的方法;

源码分析

主要属性

// 存储元素的数组
transient Object[] elements; // non-private to simplify nested class access
// 队列头位置
transient int head;
// 队列尾位置
transient int tail;
// 最小初始容量
private static final int MIN_INITIAL_CAPACITY = 8;

从属性我们可以看到,ArrayDeque 使用数组存储元素,并使用头尾指针标识队列的头和尾,其最小容量是 8。

主要构造方法

// 默认构造方法,初始容量为 16
public ArrayDeque() {elements = new Object[16];
}
// 指定元素个数初始化
public ArrayDeque(int numElements) {allocateElements(numElements);
}
// 将集合 c 中的元素初始化到数组中
public ArrayDeque(Collection<? extends E> c) {allocateElements(c.size());
    addAll(c);
}
// 初始化数组
private void allocateElements(int numElements) {elements = new Object[calculateSize(numElements)];
}
// 计算容量,这段代码的逻辑是算出大于 numElements 的最接近的 2 的 n 次方且不小于 8
// 比如,3 算出来是 8,9 算出来是 16,33 算出来是 64
private static int calculateSize(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
    }
    return initialCapacity;
}

通过构造方法,我们知道默认初始容量是 16,最小容量是 8。

入队

入队有很多方法,我们这里主要分析两个,addFirst(e) 和 addLast(e)。

// 从队列头入队
public void addFirst(E e) {
    // 不允许 null 元素
    if (e == null)
        throw new NullPointerException();
    // 将 head 指针减 1 并与数组长度减 1 取模
    // 这是为了防止数组到头了边界溢出
    // 如果到头了就从尾再向前
    // 相当于循环利用数组【本篇文章由公众号“彤哥读源码”原创】elements[head = (head - 1) & (elements.length - 1)] = e;
    // 如果头尾挨在一起了,就扩容
    // 扩容规则也很简单,直接两倍
    if (head == tail)
        doubleCapacity();}
// 从队列尾入队
public void addLast(E e) {
    // 不允许 null 元素
    if (e == null)
        throw new NullPointerException();
    // 在尾指针的位置放入元素
    // 可以看到 tail 指针指向的是队列最后一个元素的下一个位置
    elements[tail] = e;
    // tail 指针加 1,如果到数组尾了就从头开始
    if ((tail = (tail + 1) & (elements.length - 1)) == head)
        doubleCapacity();}

(1)入队有两种方式,从队列头或者从队列尾;

(2)如果容量不够了,直接扩大为两倍;

(3)通过取模的方式让头尾指针在数组范围内循环;

(4)x & (len – 1) = x % len,使用 & 的方式更快;

扩容

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 之后的元素拷贝到新数组中
    System.arraycopy(elements, p, a, 0, r);
    // 将旧数组下标 0 到 head 之间的元素拷贝到新数组中
    System.arraycopy(elements, 0, a, r, p);
    // 赋值为新数组
    elements = a;
    // head 指向 0,tail 指向旧数组长度表示的位置
    head = 0;
    tail = n;
}

扩容这里迁移元素可能有点绕,请看下面这张图来理解。

出队

出队同样有很多方法,我们主要看两个,pollFirst() 和 pollLast()。

// 从队列头出队
public E pollFirst() {
    int h = head;
    @SuppressWarnings("unchecked")
    // 取队列头元素
    E result = (E) elements[h];
    // 如果队列为空,就返回 null
    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];
    // 如果队列为空返回 null
    if (result == null)
        return null;
    // 将当前尾指针处置为空
    elements[t] = null;
    // tail 指向新的尾指针处
    tail = t;
    // 返回取得的元素
    return result;
}

(1)出队有两种方式,从队列头或者从队列尾;

(2)通过取模的方式让头尾指针在数组范围内循环;

(3)出队之后没有缩容哈哈 ^^

前面我们介绍 Deque 的时候说过,Deque 可以直接作为栈来使用,那么 ArrayDeque 是怎么实现的呢?

public void push(E e) {addFirst(e);
}

public E pop() {return removeFirst();
}

是不是很简单,入栈出栈只要都操作队列头就可以了。

总结

(1)ArrayDeque 是采用数组方式实现的双端队列;

(2)ArrayDeque 的出队入队是通过头尾指针循环利用数组实现的;

(3)ArrayDeque 容量不足时是会扩容的,每次扩容容量增加一倍;

(4)ArrayDeque 可以直接作为栈使用;

彩蛋

双端队列与双重队列?

双端队列(Deque)是指队列的两端都可以进出元素的队列,里面存储的是实实在在的元素。

双重队列(Dual Queue)是指一种队列有两种用途,里面的节点分为数据节点和非数据节点,它是 LinkedTransferQueue 使用的数据结构。

还记得 LinkedTransferQueue 吗?点击链接直达【死磕 java 集合之 LinkedTransferQueue 源码分析】。


欢迎关注我的公众号“彤哥读源码”,查看更多源码系列文章, 与彤哥一起畅游源码的海洋。

退出移动版