[學習筆記-Java集合-15] Queue - ArrayBlockingQueue源碼分析

介紹

ArrayBlockingQueue是java併發包下一個以數組實現的阻塞隊列，它是線程安全的，至因而否須要擴容，請看下面的分析。

隊列

隊列，是一種線性表，它的特色是先進先出，又叫FIFO，就像咱們日常排隊同樣，先到先得，即先進入隊列的人先出隊。

源碼分析

主要屬性

// 使用數組存儲元素
final Object[] items;

// 取元素的指針
int takeIndex;

// 放元素的指針
int putIndex;

// 元素數量
int count;

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

// 非空條件
private final Condition notEmpty;

// 非滿條件
private final Condition notFull;

經過屬性咱們能夠得出如下幾個重要信息：

1. 利用數組存儲元素；
2. 經過放指針和取指針來標記下一次操做的位置；
3. 利用重入鎖來保證併發安全；

主要構造方法

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();
}

經過構造方法咱們能夠得出如下兩個結論：

1. ArrayBlockingQueue初始化時必須傳入容量，也就是數組的大小；
2. 能夠經過構造方法控制重入鎖的類型是公平鎖仍是非公平鎖；

入隊

入隊有四個方法，它們分別是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();
}

1. add(e)時若是隊列滿了則拋出異常；
2. offer(e)時若是隊列滿了則返回false；
3. put(e)時若是隊列滿了則使用notFull等待；
4. offer(e, timeout, unit)時若是隊列滿了則等待一段時間後若是隊列依然滿就返回false；
5. 利用放指針循環使用數組來存儲元素；

出隊

出隊有四個方法，它們分別是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;
}

1. remove()時若是隊列爲空則拋出異常；
2. poll()時若是隊列爲空則返回null；
3. take()時若是隊列爲空則阻塞等待在條件notEmpty上；
4. poll(timeout, unit)時若是隊列爲空則阻塞等待一段時間後若是還爲空就返回null；
5. 利用取指針循環從數組中取元素；

總結

1. ArrayBlockingQueue不須要擴容，由於是初始化時指定容量，並循環利用數組；
2. ArrayBlockingQueue利用takeIndex和putIndex循環利用數組；
3. 入隊和出隊各定義了四組方法爲知足不一樣的用途；
4. 利用重入鎖和兩個條件保證併發安全；
5. 隊列長度固定且必須在初始化時指定，因此使用以前必定要慎重考慮好容量；
6. 若是消費速度跟不上入隊速度，則會致使提供者線程一直阻塞，且越阻塞越多，很是危險；