源碼解析Synchronous Queue 這種特立獨行的隊列
摘要：Synchronous Queue 是一種特立獨行的隊列，其本身是沒有容量的，比如調用者放一個數據到隊列中，調用者是不能夠立馬返回的，調用者必須等待別人把我放進去的數據消費掉了，才能夠返回。
本文分享自華為雲社區《Synchronous Queue 源碼解析》，作者： JavaEdge。
1 簡介
Synchronous Queue 是一種特立獨行的隊列，其本身是沒有容量的，比如調用者放一個數據到隊列中，調用者是不能夠立馬返回的，調用者必須等待別人把我放進去的數據消費掉了，才能夠返回。Synchronous Queue 在 MQ 中被大量使用，本文就讓我們從源碼來看下 Synchronous Queue 到底是如何實現這種功能的呢。
2 整體架構
不像ArrayBlockingQueue、LinkedBlockingDeque之類的阻塞隊列使用AQS實現並發，SynchronousQueue直接使用CAS操作實現數據的安全訪問，因此源碼中充斥着大量的CAS代碼。
SynchronousQueue 的整體設計比較抽象，在內部抽象出了兩種算法實現，一種是先入先出的隊列，一種是後入先出的堆棧，兩種算法被兩個內部類實現，而直接對外的 put，take 方法的實現就非常簡單，都是直接調用兩個內部類的 transfer 方法進行實現，整體的調用關係如下圖所示：
2.1 類注釋
隊列不存儲數據，所以沒有大小，也無法迭代；插入操作的返回必須等待另一個線程完成對應數據的刪除操作，反之亦然；
隊列由兩種數據結構組成，分別是後入先出的堆棧和先入先出的隊列，堆棧是非公平的，隊列是公平的。
第二點是如何做到的？堆棧又是如何實現的呢？接下來我們一點一點揭曉。
2.2 類圖
SynchronousQueue 整體類圖和 LinkedBlockingQueue 相似，都實現了 BlockingQueue 接口，但因為其不儲存數據結構，有一些方法是沒有實現的，比如說 isEmpty、size、contains、remove 和迭代等方法，這些方法都是默認實現，如下截圖：
2.3 結構細節
SynchronousQueue 底層結構和其它隊列完全不同，有着獨特的兩種數據結構：隊列和堆棧，我們一起來看下數據結構：
// 堆棧和隊列共同的接口 // 負責執行 put or take abstract static class Transferer<E> { // e 為空的，會直接返回特殊值，不為空會傳遞給消費者 // timed 為 true，說明會有超時時間 abstract E transfer(E e, boolean timed, long nanos); } // 堆棧 後入先出 非公平 // Scherer-Scott 算法 static final class TransferStack<E> extends Transferer<E> { } // 隊列 先入先出 公平 static final class TransferQueue<E> extends Transferer<E> { } private transient volatile Transferer<E> transferer; // 無參構造器默認為非公平的 public SynchronousQueue(boolean fair) { transferer = fair ? new TransferQueue<E>() : new TransferStack<E>(); }
從源碼中我們可以得到幾點：
堆棧和隊列都有一個共同的接口，叫做 Transferer，該接口有個方法：transfer，該方法很神奇，會承擔 take 和 put 的雙重功能；
在我們初始化的時候，是可以選擇是使用堆棧還是隊列的，如果你不選擇，默認的就是堆棧，類注釋中也說明了這一點，堆棧的效率比隊列更高。
接下來我們來看下堆棧和隊列的具體實現。
3 非公平的堆棧
3.1 堆棧的結構
首先我們來介紹下堆棧的整體結構，如下：
從上圖中我們可以看到，我們有一個大的堆棧池，池的開口叫做堆棧頭，put 的時候，就往堆棧池中放數據。take 的時候，就從堆棧池中拿數據，兩者操作都是在堆棧頭上操作數據，從圖中可以看到，越靠近堆棧頭，數據越新，所以每次 take 的時候，都會拿到堆棧頭的最新數據，這就是我們說的後入先出，也就是非公平的。
圖中 SNode 就是源碼中棧元素的表示，我們看下源碼：
- volatile SNode next
棧的下一個，就是被當前棧壓在下面的棧元素 - volatile SNode match
節點匹配，用來判斷阻塞棧元素能被喚醒的時機 - 比如我們先執行 take，此時隊列中沒有數據，take 被阻塞了，棧元素為 SNode1
當有 put 操作時，會把當前 put 的棧元素賦值給 SNode1 的 match 屬性，並喚醒 take 操作
當 take 被喚醒，發現 SNode1 的 match 屬性有值時，就能拿到 put 進來的數據，從而返回 - volatile Thread waiter
棧元素的阻塞是通過線程阻塞來實現的，waiter 為阻塞的線程 - Object item
未投遞的消息，或者未消費的消息
3.2 入棧和出棧
- 入棧
使用 put 等方法，將數據放到堆棧池中 - 出棧
使用 take 等方法，把數據從堆棧池中拿出來
操作的對象都是堆棧頭，雖然兩者的一個是從堆棧頭拿數據，一個是放數據，但底層實現的方法卻是同一個，源碼如下：
transfer 方法思路比較複雜，因為 take 和 put 兩個方法都揉在了一起A
@SuppressWarnings("unchecked") E transfer(E e, boolean timed, long nanos) { SNode s = null; // constructed/reused as needed // e 為空: take 方法，非空: put 方法 int mode = (e == null) ? REQUEST : DATA; // 自旋 for (;;) { // 頭節點情況分類 // 1：為空，說明隊列中還沒有數據 // 2：非空，並且是 take 類型的，說明頭節點線程正等着拿數據 // 3：非空，並且是 put 類型的，說明頭節點線程正等着放數據 SNode h = head; // 棧頭為空，說明隊列中還沒有數據。 // 棧頭非空且棧頭的類型和本次操作一致 // 比如都是 put，那麼就把本次 put 操作放到該棧頭的前面即可，讓本次 put 能夠先執行 if (h == null || h.mode == mode) { // empty or same-mode // 設置了超時時間，並且 e 進棧或者出棧要超時了， // 就會丟棄本次操作，返回 null 值。 // 如果棧頭此時被取消了，丟棄棧頭，取下一個節點繼續消費 if (timed && nanos <= 0) { // 無法等待 // 棧頭操作被取消 if (h != null && h.isCancelled()) // 丟棄棧頭，把棧頭的後一個元素作為棧頭 casHead(h, h.next); // 將取消的節點彈棧 // 棧頭為空，直接返回 null else return null; // 沒有超時，直接把 e 作為新的棧頭 } else if (casHead(h, s = snode(s, e, h, mode))) { // e 等待出棧，一種是空隊列 take，一種是 put SNode m = awaitFulfill(s, timed, nanos); if (m == s) { // wait was cancelled clean(s); return null; } // 本來 s 是棧頭的，現在 s 不是棧頭了，s 後面又來了一個數，把新的數據作為棧頭 if ((h = head) != null && h.next == s) casHead(h, s.next); // help s's fulfiller return (E) ((mode == REQUEST) ? m.item : s.item); } // 棧頭正在等待其他線程 put 或 take // 比如棧頭正在阻塞，並且是 put 類型，而此次操作正好是 take 類型，走此處 } else if (!isFulfilling(h.mode)) { // try to fulfill // 棧頭已經被取消，把下一個元素作為棧頭 if (h.isCancelled()) // already cancelled casHead(h, h.next); // pop and retry // snode 方法第三個參數 h 代表棧頭，賦值給 s 的 next 屬性 else if (casHead(h, s=snode(s, e, h, FULFILLING|mode))) { for (;;) { // loop until matched or waiters disappear // m 就是棧頭，通過上面 snode 方法剛剛賦值 SNode m = s.next; // m is s's match if (m == null) { // all waiters are gone casHead(s, null); // pop fulfill node s = null; // use new node next time break; // restart main loop } SNode mn = m.next; // tryMatch 非常重要的方法，兩個作用： // 1 喚醒被阻塞的棧頭 m，2 把當前節點 s 賦值給 m 的 match 屬性 // 這樣棧頭 m 被喚醒時，就能從 m.match 中得到本次操作 s // 其中 s.item 記錄著本次的操作節點，也就是記錄本次操作的數據 if (m.tryMatch(s)) { casHead(s, mn); // pop both s and m return (E) ((mode == REQUEST) ? m.item : s.item); } else // lost match s.casNext(m, mn); // help unlink } } } else { // help a fulfiller SNode m = h.next; // m is h's match if (m == null) // waiter is gone casHead(h, null); // pop fulfilling node else { SNode mn = m.next; if (m.tryMatch(h)) // help match casHead(h, mn); // pop both h and m else // lost match h.casNext(m, mn); // help unlink } } } }
總結一下操作思路：
- 判斷是 put 方法還是 take 方法
- 判斷棧頭數據是否為空，如果為空或者棧頭的操作和本次操作一致，是的話走 3，否則走 5
- 判斷操作有無設置超時時間，如果設置了超時時間並且已經超時，返回 null，否則走 4
- 如果棧頭為空，把當前操作設置成棧頭，或者棧頭不為空，但棧頭的操作和本次操作相同，也把當前操作設置成棧頭，並看看其它線程能否滿足自己，不能滿足則阻塞自己。比如當前操作是 take，但隊列中沒有數據，則阻塞自己
- 如果棧頭已經是阻塞住的，需要別人喚醒的，判斷當前操作能否喚醒棧頭，可以喚醒走 6，否則走 4
- 把自己當作一個節點，賦值到棧頭的 match 屬性上，並喚醒棧頭節點
- 棧頭被喚醒後，拿到 match 屬性，就是把自己喚醒的節點的信息，返回。
在整個過程中，有一個節點阻塞的方法，源碼如下：
當一個 節點/線程 將要阻塞時，它會設置其 waiter 字段，然後在真正 park 之前至少再檢查一次狀態，從而涵蓋了競爭與實現者的關係，並注意到 waiter 非空，因此應將其喚醒。
當由出現在調用點位於堆棧頂部的節點調用時，對停放的調用之前會進行旋轉，以避免在生產者和消費者及時到達時阻塞。 這可能只足以在多處理器上發生。
從主循環返回的檢查順序反映了這樣一個事實，即優先級: 中斷 > 正常的返回 > 超時。 （因此，在超時時，在放棄之前要進行最後一次匹配檢查。）除了來自非定時SynchronousQueue的調用。{poll / offer}不會檢查中斷，根本不等待，因此陷入了轉移方法中 而不是調用awaitFulfill。
/** * 旋轉/阻止，直到節點s通過執行操作匹配。 * @param s 等待的節點 * @param timed true if timed wait * @param nanos 超時時間 * @return 匹配的節點, 或者是 s 如果被取消 */ SNode awaitFulfill(SNode s, boolean timed, long nanos) { // deadline 死亡時間，如果設置了超時時間的話，死亡時間等於當前時間 + 超時時間，否則就是 0 final long deadline = timed ? System.nanoTime() + nanos : 0L; Thread w = Thread.currentThread(); // 自旋的次數，如果設置了超時時間，會自旋 32 次，否則自旋 512 次。 // 比如本次操作是 take 操作，自旋次數後，仍無其他線程 put 數據 // 就會阻塞，有超時時間的，會阻塞固定的時間，否則一致阻塞下去 int spins = (shouldSpin(s) ? (timed ? maxTimedSpins : maxUntimedSpins) : 0); for (;;) { // 當前線程有無被打斷，如果過了超時時間，當前線程就會被打斷 if (w.isInterrupted()) s.tryCancel(); SNode m = s.match; if (m != null) return m; if (timed) { nanos = deadline - System.nanoTime(); // 超時了，取消當前線程的等待操作 if (nanos <= 0L) { s.tryCancel(); continue; } } // 自選次數減1 if (spins > 0) spins = shouldSpin(s) ? (spins-1) : 0; // 把當前線程設置成 waiter，主要是通過線程來完成阻塞和喚醒 else if (s.waiter == null) s.waiter = w; // establish waiter so can park next iter else if (!timed) // 通過 park 進行阻塞，這個我們在鎖章節中會說明 LockSupport.park(this); else if (nanos > spinForTimeoutThreshold) LockSupport.parkNanos(this, nanos); } }
可以發現其阻塞策略，並不是一上來就阻塞住，而是在自旋一定次數後，仍然沒有其它線程來滿足自己的要求時，才會真正的阻塞。
隊列的實現策略通常分為公平模式和非公平模式，本文我們重點介紹公平模式。
4 公平隊列
4.1元素組成
- volatile QNode next
當前元素的下一個元素 - volatile Object item // CAS』ed to or from null
當前元素的值，如果當前元素被阻塞住了，等其他線程來喚醒自己時，其他線程會把自己 set 到 item 裏面 - volatile Thread waiter // to control park/unpark
可以阻塞住的當前線程 - final boolean isData
true 是 put，false 是 take
公平隊列主要使用的是 TransferQueue 內部類的 transfer 方法，看源碼：
E transfer(E e, boolean timed, long nanos) { QNode s = null; // constructed/reused as needed // true ： put false ： get boolean isData = (e != null); for (;;) { // 隊列頭和尾的臨時變量,隊列是空的時候，t=h QNode t = tail; QNode h = head; // tail 和 head 沒有初始化時，無限循環 // 雖然這種 continue 非常耗cpu，但感覺不會碰到這種情況 // 因為 tail 和 head 在 TransferQueue 初始化的時候，就已經被賦值空節點了 if (t == null || h == null) continue; // 首尾節點相同，說明是空隊列 // 或者尾節點的操作和當前節點操作一致 if (h == t || t.isData == isData) { QNode tn = t.next; // 當 t 不是 tail 時，說明 tail 已經被修改過了 // 因為 tail 沒有被修改的情況下，t 和 tail 必然相等 // 因為前面剛剛執行賦值操作： t = tail if (t != tail) continue; // 隊尾後面的值還不為空，t 還不是隊尾，直接把 tn 賦值給 t，這是一步加強校驗。 if (tn != null) { advanceTail(t, tn); continue; } //超時直接返回 null if (timed && nanos <= 0) // can't wait return null; //構造node節點 if (s == null) s = new QNode(e, isData); //如果把 e 放到隊尾失敗，繼續遞歸放進去 if (!t.casNext(null, s)) // failed to link in continue; advanceTail(t, s); // swing tail and wait // 阻塞住自己 Object x = awaitFulfill(s, e, timed, nanos); if (x == s) { // wait was cancelled clean(t, s); return null; } if (!s.isOffList()) { // not already unlinked advanceHead(t, s); // unlink if head if (x != null) // and forget fields s.item = s; s.waiter = null; } return (x != null) ? (E)x : e; // 隊列不為空，並且當前操作和隊尾不一致 // 也就是說當前操作是隊尾是對應的操作 // 比如說隊尾是因為 take 被阻塞的，那麼當前操作必然是 put } else { // complementary-mode // 如果是第一次執行，此處的 m 代表就是 tail // 也就是這行代碼體現出隊列的公平，每次操作時，從頭開始按照順序進行操作 QNode m = h.next; // node to fulfill if (t != tail || m == null || h != head) continue; // inconsistent read Object x = m.item; if (isData == (x != null) || // m already fulfilled x == m || // m cancelled // m 代表棧頭 // 這裡把當前的操作值賦值給阻塞住的 m 的 item 屬性 // 這樣 m 被釋放時，就可得到此次操作的值 !m.casItem(x, e)) { // lost CAS advanceHead(h, m); // dequeue and retry continue; } // 當前操作放到隊頭 advanceHead(h, m); // successfully fulfilled // 釋放隊頭阻塞節點 LockSupport.unpark(m.waiter); return (x != null) ? (E)x : e; } } }
線程被阻塞住後，當前線程是如何把自己的數據傳給阻塞線程的。
假設線程 1 從隊列中 take 數據 ，被阻塞，變成阻塞線程 A 然後線程 2 開始往隊列中 put 數據 B，大致的流程如下：
- 線程 1 從隊列 take 數據，發現隊列內無數據，於是被阻塞，成為 A
- 線程 2 往隊尾 put 數據，會從隊尾往前找到第一個被阻塞的節點，假設此時能找到的就是節點 A，然後線程 B 把將 put 的數據放到節點 A 的 item 屬性裏面，並喚醒線程 1
- 線程 1 被喚醒後，就能從 A.item 裏面拿到線程 2 put 的數據了，線程 1 成功返回。
在這個過程中，公平主要體現在，每次 put 數據的時候，都 put 到隊尾上，而每次拿數據時，並不是直接從堆頭拿數據，而是從隊尾往前尋找第一個被阻塞的線程，這樣就會按照順序釋放被阻塞的線程。
4.2 圖解公平隊列模型
公平模式下，底層實現使用的是 TransferQueue 隊列，它有一個head和tail指針，用於指向當前正在等待匹配的線程節點。
初始化時，TransferQueue的狀態如下：
1.線程put1執行 put(1)操作，由於當前沒有配對的消費線程，所以put1線程入隊列，自旋一小會後睡眠等待，這時隊列狀態如下：
2.接着，線程put2執行了put(2)操作，跟前面一樣，put2線程入隊列，自旋一小會後睡眠等待，這時隊列狀態如下：
3.這時候，來了一個線程take1，執行了 take操作，由於tail指向put2線程，put2線程跟take1線程配對了(一put一take)，這時take1線程不需要入隊，但是請注意了，這時候，要喚醒的線程並不是put2，而是put1。
為何？ 大家應該知道我們現在講的是公平策略，所謂公平就是誰先入隊了，誰就優先被喚醒，我們的例子明顯是put1應該優先被喚醒。有的同學可能會有一個疑問，明明是take1線程跟put2線程匹配上了，結果是put1線程被喚醒消費，怎麼確保take1線程一定可以和次首節點(head.next)也是匹配的呢？其實大家可以拿個紙畫一畫，就會發現真的就是這樣的。
公平策略總結下來就是：隊尾匹配隊頭出隊。
執行後put1線程被喚醒，take1線程的 take()方法返回了1(put1線程的數據)，這樣就實現了線程間的一對一通信，這時候內部狀態如下：
4.最後，再來一個線程take2，執行take操作，這時候只有put2線程在等候，而且兩個線程匹配上了，線程put2被喚醒，take2線程take操作返回了2(線程put2的數據)，這時候隊列又回到了起點，如下所示：
以上便是公平模式下，SynchronousQueue的實現模型。總結下來就是：隊尾匹配隊頭出隊，先進先出，體現公平原則。
5 非公平模式
5.1 元素組成
- 棧頂
- volatile SNode next
棧中的下一個元素 - volatile Object item // data; or null for REQUESTs
當前元素的值，如果當前元素被阻塞住了，等其他線程來喚醒自己時，其他線程會把自己 set 到 item 裏面 - volatile Thread waiter
可以阻塞住的當前線程
5.2 圖解非公平模型
還是使用跟公平模式下一樣的操作流程，對比兩種策略下有何不同。
非公平模式底層的實現使用的是TransferStack，一個棧，實現中用head指針指向棧頂，接着我們看看它的實現模型:
1.線程put1執行 put(1)操作，由於當前沒有配對的消費線程，所以put1線程入棧，自旋一小會後睡眠等待，這時棧狀態如下
2.接着，線程put2再次執行了put(2)操作，跟前面一樣，put2線程入棧，自旋一小會後睡眠等待，這時棧狀態如下：
3.這時候，來了一個線程take1，執行了take操作，這時候發現棧頂為put2線程，匹配成功，但是實現會先把take1線程入棧，然後take1線程循環執行匹配put2線程邏輯，一旦發現沒有並發衝突，就會把棧頂指針直接指向 put1線程
4.最後，再來一個線程take2，執行take操作，這跟步驟3的邏輯基本是一致的，take2線程入棧，然後在循環中匹配put1線程，最終全部匹配完畢，棧變為空，恢復初始狀態，如下圖所示：
可以從上面流程看出，雖然put1線程先入棧了，但是卻是後匹配，這就是非公平的由來。
5 總結
SynchronousQueue 源碼比較複雜，建議大家進行源碼的 debug 來學習源碼，為大家準備了調試類：SynchronousQueueDemo，大家可以下載源碼自己調試一下，這樣學起來應該會更加輕鬆一點。
- SynchronousQueue內沒有容器為什麼能夠存儲一個元素？
內部沒有容器指的是沒有像數組那樣的內存空間存多個元素，但是是有單地址內存空間，用於交換數據
SynchronousQueue由於其獨有的線程一一配對通信機制，在大部分平常開發中，可能都不太會用到，但線程池技術中會有所使用，由於內部沒有使用AQS，而是直接使用CAS，所以代碼理解起來會比較困難，但這並不妨礙我們理解底層的實現模型，在理解了模型的基礎上，再翻閱源碼，就會有方向感，看起來也會比較容易！
