Java併發容器之ArrayBlockingQueue原始碼分析

阿新 • • 發佈：2022-05-15

一、簡介

ArrayBlockingQueue是java併發包下一個以陣列實現的阻塞佇列，它是執行緒安全的，至於是否需要擴容，請看下面的分析。

二、原始碼分析

2.1 屬性

// 使用陣列儲存元素
final Object[] items;

// 取元素的指標
int takeIndex;

// 放元素的指標
int putIndex;

// 元素數量
int count;

// 保證併發訪問的鎖
final ReentrantLock lock;

// 非空條件
private final Condition notEmpty;

// 非滿條件
private final Condition notFull;

通過屬性我們可以得出以下幾個重要資訊：

利用陣列儲存元素；
通過放指標和取指標來標記下一次操作的位置；
利用重入鎖來保證併發安全；

2.2 構造方法

public ArrayBlockingQueue(int capacity) {
    this(capacity, false);
}

public ArrayBlockingQueue(int capacity, boolean fair) {
    if (capacity <= 0)
        throw new IllegalArgumentException();
    // 初始化陣列
    this.items = new Object[capacity];
    // 建立重入鎖及兩個條件
    lock = new ReentrantLock(fair);
    notEmpty = lock.newCondition();
    notFull =  lock.newCondition();
}

通過構造方法我們可以得出以下兩個結論：

ArrayBlockingQueue初始化時必須傳入容量，也就是陣列的大小；
可以通過構造方法控制重入鎖的型別是公平鎖還是非公平鎖；

2.3 入隊

入隊有四個方法，它們分別是add(E e)、offer(E e)、put(E e)、offer(E e, long timeout, TimeUnit unit)，它們有什麼區別呢？

public boolean add(E e) {
    // 呼叫父類的add(e)方法
    return super.add(e);
}

// super.add(e)
public boolean add(E e) {
    // 呼叫offer(e)如果成功返回true，如果失敗丟擲異常
    if (offer(e))
        return true;
    else
        throw new IllegalStateException("Queue full");
}

public boolean offer(E e) {
    // 元素不可為空
    checkNotNull(e);
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lock();
    try {
        if (count == items.length)
            // 如果陣列滿了就返回false
            return false;
        else {
            // 如果陣列沒滿就呼叫入隊方法並返回true
            enqueue(e);
            return true;
        }
    } finally {
        // 解鎖
        lock.unlock();
    }
}

public void put(E e) throws InterruptedException {
    checkNotNull(e);
    final ReentrantLock lock = this.lock;
    // 加鎖，如果執行緒中斷了丟擲異常
    lock.lockInterruptibly();
    try {
        // 如果陣列滿了，使用notFull等待
        // notFull等待的意思是說現在佇列滿了
        // 只有取走一個元素後，佇列才不滿
        // 然後喚醒notFull，然後繼續現在的邏輯
        // 這裡之所以使用while而不是if
        // 是因為有可能多個執行緒阻塞在lock上
        // 即使喚醒了可能其它執行緒先一步修改了佇列又變成滿的了
        // 這時候需要再次等待
        while (count == items.length)
            notFull.await();
        // 入隊
        enqueue(e);
    } finally {
        // 解鎖
        lock.unlock();
    }
}

public boolean offer(E e, long timeout, TimeUnit unit)
    throws InterruptedException {
    checkNotNull(e);
    long nanos = unit.toNanos(timeout);
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lockInterruptibly();
    try {
        // 如果陣列滿了，就阻塞nanos納秒
        // 如果喚醒這個執行緒時依然沒有空間且時間到了就返回false
        while (count == items.length) {
            if (nanos <= 0)
                return false;
            nanos = notFull.awaitNanos(nanos);
        }
        // 入隊
        enqueue(e);
        return true;
    } finally {
        // 解鎖
        lock.unlock();
    }
}

private void enqueue(E x) {
    final Object[] items = this.items;
    // 把元素直接放在放指標的位置上
    items[putIndex] = x;
    // 如果放指標到陣列盡頭了，就返回頭部
    if (++putIndex == items.length)
        putIndex = 0;
    // 數量加1
    count++;
    // 喚醒notEmpty，因為入隊了一個元素，所以肯定不為空了
    notEmpty.signal();
}

add(e)時如果佇列滿了則丟擲異常；
offer(e)時如果佇列滿了則返回false；
put(e)時如果佇列滿了則使用notFull等待；
offer(e, timeout, unit)時如果佇列滿了則等待一段時間後如果佇列依然滿就返回false；
利用放指標迴圈使用陣列來儲存元素；

2.4 出隊

出隊有四個方法，它們分別是remove()、poll()、take()、poll(long timeout, TimeUnit unit)，它們有什麼區別呢？

public E remove() {
    // 呼叫poll()方法出隊
    E x = poll();
    if (x != null)
        // 如果有元素出隊就返回這個元素
        return x;
    else
        // 如果沒有元素出隊就丟擲異常
        throw new NoSuchElementException();
}

public E poll() {
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lock();
    try {
        // 如果佇列沒有元素則返回null，否則出隊
        return (count == 0) ? null : dequeue();
    } finally {
        lock.unlock();
    }
}

public E take() throws InterruptedException {
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lockInterruptibly();
    try {
        // 如果佇列無元素，則阻塞等待在條件notEmpty上
        while (count == 0)
            notEmpty.await();
        // 有元素了再出隊
        return dequeue();
    } finally {
        // 解鎖
        lock.unlock();
    }
}

public E poll(long timeout, TimeUnit unit) throws InterruptedException {
    long nanos = unit.toNanos(timeout);
    final ReentrantLock lock = this.lock;
    // 加鎖
    lock.lockInterruptibly();
    try {
        // 如果佇列無元素，則阻塞等待nanos納秒
        // 如果下一次這個執行緒獲得了鎖但佇列依然無元素且已超時就返回null
        while (count == 0) {
            if (nanos <= 0)
                return null;
            nanos = notEmpty.awaitNanos(nanos);
        }
        return dequeue();
    } finally {
        lock.unlock();
    }
}

private E dequeue() {
    final Object[] items = this.items;
    @SuppressWarnings("unchecked")
    // 取取指標位置的元素
    E x = (E) items[takeIndex];
    // 把取指標位置設為null
    items[takeIndex] = null;
    // 取指標前移，如果陣列到頭了就返回陣列前端迴圈利用
    if (++takeIndex == items.length)
        takeIndex = 0;
    // 元素數量減1
    count--;
    if (itrs != null)
        itrs.elementDequeued();
    // 喚醒notFull條件
    notFull.signal();
    return x;
}