ArrayBlockQueue源碼解析

来源:https://www.cnblogs.com/CodeBear/archive/2019/04/08/10668582.html
-Advertisement-
Play Games

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


清明節和朋友去被抖音帶火的一個餐廳，下午兩點鐘取晚上的號，前面已經有十幾桌了，四點半餐廳開始正式營業，等輪到我們已經近八點了。餐廳分為幾個區域，只有最火的區域（在小船上）需要排號，其他區域基本上是隨到隨吃的，最冷清的區域幾乎都沒什麼人。菜的價格異常的貴，味道也並不好。最後送出兩張圖：
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，直接返回null，否則執行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，彈出並清空元素，如果隊列為空，會被阻塞。

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • typeof 和 instanceof 區別
    typeof操作符返回一個字元串，表示未經計算的操作數的類型。 可能返回值有："undefined"、"object"、"boolean"、"number"、"string"、"symbol"、"function"、"object" 例： instanceof運算符用於測試構造函數的prototyp ...
  • JavaScript 作用域、命名空間及閉包
    變數作用域： 1、一個變數的作用域是程式源代碼中定義這個變數的區域 2、在函數內聲明的變數是局部變數，它只在該函數及其嵌套作用域里可見（js 函數可嵌套定義）；不在任何函數內聲明或在函數內不使用 var 或 let 關鍵字聲明的變數是全局變數，它在整個 JavaScript 程式里都可見 3、Jav ...
  • JavaScript Event Loop和微任務、巨集任務
    為什麼JavaScript是單線程? JavaScript的一大特點就是單線程, 同一時間只能做一件事情,主要和它的用途有關, JavaScript主要是控制和用戶的交互以及操作DOM。註定它是單線程。 假如是多個線程, 一個移除DOM節點,一個新增DOM節點,瀏覽器以誰的為準呢? 什麼是執執行棧呢 ...
  • Vue和element-ui結合的簡單使用
    前提 vue在前端技術中使用越來越多，也成為了主流框架，花點時間稍微瞭解下vue-cli、vue-router結合element-ui的使用。本人使用的是windows系統，後續介紹以windows7系統為例。 1.安裝vue-cli 首先保證自己電腦上已經安裝過nodejs，是否安裝打開cmd，輸 ...
  • Istio入門實戰與架構原理——使用Docker Compose搭建
    本文將介紹如何使用Docker Compose搭建Istio。Istio號稱支持多種平臺（不僅僅Kubernetes）。然而，官網上非基於Kubernetes的教程仿佛不是親兒子，寫得非常隨便，不僅缺了一些內容，而且還有坑。本文希望能補實這些內容。我認為在學習Istio的過程中，相比於Kuberne ...
  • 工廠方法模式(Factory Method Pattern)
    工廠方法模式概述 工廠方法模式是為了彌補簡單工廠模式的不足並且繼承它的優點而延生出的一種設計模式，屬於GoF中的一種。它能更好的符合開閉原則的要求。 舉個例子：大眾汽車公司想必大家都不陌生，它旗下也有不少汽車品牌。大眾汽車公司就好比一個汽車工廠，負責生產和銷售汽車。它可以為客戶提供一個客戶需要的汽車 ...
  • javaweb中上傳視頻，並且播放，用上傳視頻信息為例
    1.上傳視頻信息的jsp頁面uploadVideo.jsp <body background="image/bk_hero.jpg"><div id="upld" style="height:300px;width:300px;margin-left: 300px;margin-top: 100px ...
  • 從後臺servlet中，獲取jsp頁面輸入的值，來刪除用戶一行信息
    後臺servlet設置 protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { String method=reque ...
一周排行
    -Advertisement-
    Play Games
  • C# + WPF 音頻播放器 界面優雅，體驗良好
    前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器，其界面簡潔大方，操作體驗流暢。該播放器支持多種音頻格式（如 MP4、WMA、OGG、FLAC 等），並具備標記、實時歌詞顯示等功能。 另外，還支持換膚及多語言（中英文）切換。核心音頻處理採用 FFmpeg 組件，獲得了廣泛認可，目前 Git ...
  • OAuth2.0授權-gitee授權碼模式
    OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統，完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面，查看已創建應用的Client ID和Clien ...
  • FastReport.OpenSource .Net下開源免費報表列印組件
    解決了這個問題：《winForm下，fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自：https://www.fcnsoft.com/Home/Sho ...
  • 如何在 ASP.NET Core Web API 方法執行前後 “偷偷“ 作一些 “壞“ 事？初識 ActionFilterAttribute
    國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面，接收裸 Win 32 的 WM_Pointer 消息，從消息裡面獲取觸摸點信息，使用觸摸點 ...
  • 在 ASP.NET Core Web API 中使用異常篩選器捕獲和統一處理異常
    前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能，還集成了高性能的輕量級 POS 解決方案，確保頁面載入速度極快，提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • AbpHelper CLI積累與實戰分享
    ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI： ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的，因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 記一次HttpClient使用問題分析
    問題 問題是這樣的：第三方的webapi，需要先調用登陸介面獲取Cookie，訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面，返回的Headers中沒有找到Cookie信息。 分析 首先，使用Postman測試該登陸介面，正常返回Cookie信息，說明是HttpCli ...
  • .NET周刊【9月第3期 2024-09-15】
    國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低，主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上，.NET曾因微軟的閉源策略發展受限，儘管後來推出了跨平臺的.NET ...
  • 我的網站集成ElasticSearch初體驗
    在WPF開發應用中，動畫不僅可以引起用戶的註意與興趣，而且還使軟體更加便於使用。前面幾篇文章講解了畫筆（Brush），形狀（Shape），幾何圖形（Geometry），變換（Transform）等相關內容，今天繼續講解動畫相關內容和知識點，僅供學習分享使用，如有不足之處，還請指正。 ...
  • 第23篇 委托的概述
    什麼是委托？ 委托可以說是把一個方法代入另一個方法執行，相當於指向函數的指針；事件就相當於保存委托的數組； 1.實例化委托的方式： 方式1：通過new創建實例： public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...
所有分類