ArrayBlockQueue原始碼解析

CoderBear發表於2019-04-07
BloC原始碼

清明節和朋友去被抖音帶火的一個餐廳，下午兩點鐘取晚上的號，前面已經有十幾桌了，四點半餐廳開始正式營業，等輪到我們已經近八點了。餐廳分為幾個區域，只有最火的區域（在小船上）需要排號，其他區域基本上是隨到隨吃的，最冷清的區域幾乎都沒什麼人。菜的價格異常的貴，味道也並不好。最後送出兩張圖：

image.png
image.png

好了，進入今天的正題，今天要講的是ArrayBlockQueue，ArrayBlockQueue是JUC提供的執行緒安全的有界的阻塞佇列，一看到Array，第一反應：這貨肯定和陣列有關，既然是陣列，那自然是有界的了，我們先來看看ArrayBlockQueue的基本使用方法，然後再看看ArrayBlockQueue的原始碼。

ArrayBlockQueue基本使用

public static void main(String[] args) throws InterruptedException {
        ArrayBlockingQueue<Integer> arrayBlockingQueue=new ArrayBlockingQueue(5);
        arrayBlockingQueue.offer(10);
        arrayBlockingQueue.offer(50);
        arrayBlockingQueue.add(20);
        arrayBlockingQueue.add(60);
        System.out.println(arrayBlockingQueue);

        System.out.println(arrayBlockingQueue.poll());
        System.out.println(arrayBlockingQueue);

        System.out.println(arrayBlockingQueue.take());
        System.out.println(arrayBlockingQueue);

        System.out.println(arrayBlockingQueue.peek());
        System.out.println(arrayBlockingQueue);
    }
複製程式碼

執行結果：

image.png

  1. 建立了一個長度為5的ArrayBlockQueue。
  2. 用offer方法，向ArrayBlockQueue新增了兩個元素，分別是10，50。
  3. 用put方法，向ArrayBlockQueue新增了兩個元素，分別是20，60。
  4. 列印出ArrayBlockQueue，結果是10，50，20，60。
  5. 用poll方法，彈出ArrayBlockQueue第一個元素，並且列印出來：10。
  6. 列印出ArrayBlockQueue，結果是50，20，60。
  7. 用take方法，彈出ArrayBlockQueue第一個元素，並且列印出來：50。
  8. 列印出ArrayBlockQueue，結果是20，60。
  9. 用peek方法，彈出ArrayBlockQueue第一個元素，並且列印出來：20。
  10. 列印出ArrayBlockQueue，結果是20，60。

程式碼比較簡單，但是你肯定會有疑問

  • offer/add（在上面的程式碼中沒有演示）/put都是往佇列裡面新增元素，區別是什麼？
  • poll/take/peek都是彈出佇列的元素，區別是什麼？
  • 底層程式碼是如何保證執行緒安全的？
  • 資料儲存在哪裡？

要解決上面幾個疑問，最好的辦法當然是看下原始碼，通過親自閱讀原始碼所產生的印象遠遠要比看視訊，看部落格，死記硬背最後的結論要深刻的多。就算真的忘記了，只要再看看原始碼，瞬間可以回憶起來。

ArrayBlockQueue原始碼解析

構造方法

ArrayBlockQueue提供了三個構造方法，如下圖所示：

image.png

ArrayBlockingQueue(int capacity)
    public ArrayBlockingQueue(int capacity) {
        this(capacity, false);
    }
複製程式碼

這是最常用的構造方法，傳入capacity，capacity是容量的意思，也就是ArrayBlockingQueue的最大長度，方法內部直接呼叫了第二個構造方法，傳入的第二個引數為false。

ArrayBlockingQueue(int capacity, boolean fair)
    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();
    }
複製程式碼

這個構造方法接受兩個引數，分別是capacity和fair，fair是boolean型別的，代表是公平鎖，還是非公平鎖，可以看出如果我們用第一個構造方法來建立ArrayBlockingQueue的話，採用的是非公平鎖，因為公平鎖會損失一定的效能，在沒有充足的理由的情況下，是沒有必要採用公平鎖的。

方法內部做了幾件事情：

  1. 建立Object型別的陣列，容量為capacity，並且賦值給當前類物件的items。
  2. 建立排他鎖。
  3. 建立條件變數notEmpty 。
  4. 建立條件變數notFull。

至於排他鎖和兩個條件變數是做用什麼的，看到後面就明白了。

ArrayBlockingQueue(int capacity, boolean fair,Collection<? extends E> c)
    public ArrayBlockingQueue(int capacity, boolean fair,
                              Collection<? extends E> c) {
        //呼叫第二個構造方法，方法內部就是初始化陣列，排他鎖，兩個條件變數
        this(capacity, fair);

        final ReentrantLock lock = this.lock;
        lock.lock(); // 開啟排他鎖
        try {
            int i = 0;
            try {
                // 迴圈傳入的集合，把集合中的元素賦值給items陣列，其中i會自增
                for (E e : c) {
                    checkNotNull(e);
                    items[i++] = e;
                }
            } catch (ArrayIndexOutOfBoundsException ex) {
                throw new IllegalArgumentException();
            }
            count = i;//把i賦值給count 
            //如果i==capacity，也就是到了最大容量，把0賦值給putIndex，否則把i賦值給putIndex
            putIndex = (i == capacity) ? 0 : i;
        } finally {
            lock.unlock();//釋放排他鎖
        }
    }
複製程式碼
  1. 呼叫第二個構造方法，方法內部就是初始化陣列items，排他鎖lock，以及兩個條件變數。
  2. 開啟排他鎖。
  3. 迴圈傳入的集合，將集合中的元素賦值給items陣列，其中i會自增。
  4. 把i賦值給count。
  5. 如果i==capacity，說明到了最大的容量，就把0賦值給putIndex，否則把i賦值給putIndex。
  6. 在finally中釋放排他鎖。

看到這裡，我們應該明白這個構造方法的作用是什麼了，就是把傳入的集合作為ArrayBlockingQueuede初始化資料，但是我們又會有一個新的疑問：count，putIndex 是做什麼用的。

offer(E e)

    public boolean offer(E e) {
        checkNotNull(e);
        final ReentrantLock lock = this.lock;
        lock.lock();//開啟排他鎖
        try {
            if (count == items.length)//如果count==items.length，返回false
                return false;
            else {
                enqueue(e);//入隊
                return true;//返回true
            }
        } finally {
            lock.unlock();//釋放鎖
        }
    }
複製程式碼
  1. 開啟排他鎖。
  2. 如果count==items.length，也就是到了最大的容量，返回false。
  3. 如果count<items.length，執行入隊方法，並且返回true。
  4. 釋放排他鎖。

看到這裡，我們應該可以明白了，ArrayBlockQueue是如何保證執行緒安全的，還是利用了ReentrantLock排他鎖，count就是用來儲存陣列的當前大小的。我們再來看看enqueue方法。

    private void enqueue(E x) {
        final Object[] items = this.items;
        items[putIndex] = x;
        if (++putIndex == items.length)
            putIndex = 0;
        count++;
        notEmpty.signal();
    }
複製程式碼

這方法比較簡單，在程式碼裡面就不寫註釋了，做了如下的操作：

  1. 把x賦值給items[putIndex] 。
  2. 將putIndex進行自增，如果自增後的值 == items.length，把0賦值給putIndex 。
  3. 執行count++操作。
  4. 呼叫條件變數notEmpty的signal方法，說明在某個地方，必定呼叫了notEmpty的await方法，這裡就是喚醒因為呼叫notEmpty的await方法而被阻塞的執行緒。

這裡就解答了一個疑問：putIndex是做什麼的，就是入隊元素的下標。

add(E e)

   public boolean add(E e) {
        return super.add(e);
    }
複製程式碼
    public boolean add(E e) {
        if (offer(e))
            return true;
        else
            throw new IllegalStateException("Queue full");
    }
複製程式碼

這個方法內部最終還是呼叫的offer方法。

put(E e)

    public void put(E e) throws InterruptedException {
        checkNotNull(e);
        final ReentrantLock lock = this.lock;
        lock.lockInterruptibly();//開啟響應中斷的排他鎖
        try {
            while (count == items.length)//如果佇列滿了，呼叫notFull的await
                notFull.await();
            enqueue(e);//入隊
        } finally {
            lock.unlock();//釋放排他鎖
        }
    }
複製程式碼
  1. 開啟響應中斷的排他鎖，如果在獲取鎖的過程中，當前的執行緒被中斷，會丟擲異常。
  2. 如果佇列滿了，呼叫notFull的await方法，說明在某個地方，必定呼叫了notFull的signal方法來喚醒當前執行緒，這裡用while迴圈是為了防止虛假喚醒。
  3. 執行入隊操作。
  4. 釋放排他鎖。

可以看到put方法和 offer/add方法的區別了：

  • offer/add：如果佇列滿了，直接返回false。
  • put：如果佇列滿了，當前執行緒被阻塞，等待喚醒。

poll()

    public E poll() {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            return (count == 0) ? null : dequeue();
        } finally {
            lock.unlock();
        }
    }
複製程式碼
  1. 開啟排他鎖。
  2. 如果count==0，直接返回false，否則執行dequeue出隊操作。
  3. 釋放排他鎖。

我們來看dequeue方法：

    private E dequeue() {
        final Object[] items = this.items;
        @SuppressWarnings("unchecked")
        E x = (E) items[takeIndex];//獲得元素的值
        items[takeIndex] = null;//把null賦值給items[takeIndex] 
        if (++takeIndex == items.length)//如果takeIndex自增後的值== items.length，就把0賦值給takeIndex
            takeIndex = 0;
        count--;
        if (itrs != null)
            itrs.elementDequeued();
        notFull.signal();//喚醒因為呼叫notFull的await方法而被阻塞的執行緒
        return x;
    }
複製程式碼
  1. 獲取元素的值，takeIndex儲存的是出隊的下標。
  2. 把null賦值給items[takeIndex]，也就是清空被彈出的元素。
  3. 如果takeIndex自增後的值== items.length，就把0賦值給takeIndex。
  4. count--。
  5. 喚醒因為呼叫notFull的await方法而被阻塞的執行緒。

這裡呼叫了notFull的signal方法來喚醒因為呼叫notFull的await方法而被阻塞的執行緒，那到底在哪裡呼叫了notFull的await方法呢，還記不記得在put方法中呼叫了notFull的await方法，我們再看看：

            while (count == items.length)
                notFull.await();
複製程式碼

當佇列滿了，就呼叫 notFull.await()來等待，在出隊操作中，又呼叫了notFull.signal()來喚醒。

take()

    public E take() throws InterruptedException {
        final ReentrantLock lock = this.lock;
        lock.lockInterruptibly();
        try {
            while (count == 0)
                notEmpty.await();
            return dequeue();
        } finally {
            lock.unlock();
        }
    }
複製程式碼
  1. 開啟排他鎖。
  2. 如果count==0，代表佇列是空的，則呼叫notEmpty的await方法，用while迴圈是為了防止虛假喚醒。
  3. 執行出隊操作。
  4. 釋放排他鎖。

這裡呼叫了notEmpty的await方法，那麼哪裡呼叫了notEmpty的signal方法呢？在enqueue入隊方法裡。

我們可以看到take和poll的區別：

  • take：如果佇列為空，會阻塞，直到被喚醒了。
  • poll： 如果佇列為空，直接返回null。

peek()

    public E peek() {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            return itemAt(takeIndex); 
        } finally {
            lock.unlock();
        }
    }
複製程式碼
    final E itemAt(int i) {
        return (E) items[i];
    }
複製程式碼
  1. 開啟排他鎖。
  2. 獲得元素。
  3. 釋放排他鎖。

我們可以看到peek和poll/take的區別：

  • peek，只是獲取元素，不會清空元素。
  • poll/take，獲取並清空元素。

size()

    public int size() {
        final ReentrantLock lock = this.lock;
        lock.lock();
        try {
            return count;
        } finally {
            lock.unlock();
        }
    }
複製程式碼
  1. 開啟排他鎖。
  2. 返回count。
  3. 釋放排他鎖。

總結

至此，ArrayBlockQueue的核心原始碼就分析完畢了，我們來做一個總結：

  • ArrayBlockQueue有幾個比較重要的欄位，分別是items，儲存的是佇列的資料，putIndex儲存的是入隊的下標，takeIndex儲存的是出隊的下標，count用來統計佇列元素的個數，lock用來保證執行緒的安全性，notEmpty和notFull兩個條件變數實現喚醒和阻塞。
  • offer和add是一樣的，其中add方法內部呼叫的就是offer方法，如果佇列滿了，直接返回false。
  • put，如果佇列滿了，會被阻塞。
  • peek，只是彈出元素，不會清空元素。
  • poll，彈出並清空元素，如果佇列為空，直接返回null。
  • take，彈出並清空元素，如果佇列為空，會被阻塞。

相關文章