并发编程（十）—— Java 并发队列 BlockingQueu…

 1 // 构造时，我们可以指定公平模式还是非公平模式，本文主要讲解公平模式
 2 public SynchronousQueue(boolean fair) {
 3     transferer = fair ? new TransferQueue() : new TransferStack();
 4 }
 5 abstract static class Transferer {
 6     // 从方法名上大概就知道，这个方法用于转移元素，从生产者手上转到消费者手上
 7     // 也可以被动地，消费者调用这个方法来从生产者手上取元素
 8     // 第一个参数 e 如果不是 null，代表场景为：将元素从生产者转移给消费者
 9     // 如果是 null，代表消费者等待生产者提供元素，然后返回值就是相应的生产者提供的元素
10     // 第二个参数代表是否设置超时，如果设置超时，超时时间是第三个参数的值
11     // 返回值如果是 null，代表超时，或者中断。具体是哪个，可以通过检测中断状态得到。
12     abstract Object transfer(Object e, boolean timed, long nanos);
13 }
14 
15 TransferQueue() {
16     //初始化时，head和tail都是空节点
17     QNode h = new QNode(null, false); // initialize to dummy node.
18     head = h;
19     tail = h;
20 }

 1 // 写入值
 2 public void put(E o) throws InterruptedException {
 3     if (o == null) throw new NullPointerException();
 4     if (transferer.transfer(o, false, 0) == null) { // 1
 5         Thread.interrupted();
 6         throw new InterruptedException();
 7     }
 8 }
 9 // 读取值并移除
10 public E take() throws InterruptedException {
11     Object e = transferer.transfer(null, false, 0); // 2
12     if (e != null)
13         return (E)e;
14     Thread.interrupted();
15     throw new InterruptedException();
16 }

 1 static final class QNode {
 2     volatile QNode next;          // 可以看出来，等待队列是单向链表
 3     volatile Object item;         // CAS'ed to or from null
 4     volatile Thread waiter;       // 将线程对象保存在这里，用于挂起和唤醒
 5     final boolean isData;         // 用于判断是写线程节点(isData == true)，还是读线程节点
 6 
 7     QNode(Object item, boolean isData) {
 8         this.item = item;
 9         this.isData = isData;
10     }
11   ......

 1 /**
 2  * Puts or takes an item.
 3  */
 4 Object transfer(Object e, boolean timed, long nanos) {
 5 
 6     QNode s = null; // constructed/reused as needed
 7     boolean isData = (e != null);
 8 
 9     for (;;) {
10         QNode t = tail;
11         QNode h = head;
12         if (t == null || h == null)         // saw uninitialized value
13             //说明还没有初始化，则跳出继续循环，直至初始化完成
14             continue;                       // spin
15 
16         // 走到这里，说明已经初始化完成，但是初始化时head = h;tail = h;head和tail都是相同的空节点
17         // 如果h == t为false，则判断t.isData == isData，判断队尾节点和当前节点类型是否一致
18         // 队列空，或队列中节点类型和当前节点一致，
19         // 即我们说的第一种情况，将节点入队即可。读者要想着这块 if 里面方法其实就是入队
20         if (h == t || t.isData == isData) { // empty or same-mode
21             QNode tn = t.next;
22             // t != tail 说明刚刚有节点入队，continue 即可
23             if (t != tail)                  // inconsistent read
24                 continue;
25             // 有其他节点入队，但是 tail 还是指向原来的，此时设置 tail 即可
26             if (tn != null) {               // lagging tail
27                 // 这个方法就是：如果 tail 此时为 t 的话，设置为 tn
28                 advanceTail(t, tn);
29                 continue;
30             }
31             // 
32             if (timed && nanos <= 0)        // can't wait
33                 return null;
34             // s == null，则创建一个新节点
35             if (s == null)
36                 s = new QNode(e, isData);
37             // 将当前节点，插入到 tail 的后面
38             if (!t.casNext(null, s))        // failed to link in
39                 continue;
40 
41             // 将当前节点设置为新的 tail
42             advanceTail(t, s);              // swing tail and wait
43             // 看到这里，请读者先往下滑到这个方法，看完了以后再回来这里，思路也就不会断了
44             Object x = awaitFulfill(s, e, timed, nanos);
45             // 到这里，说明之前入队的线程被唤醒了，准备往下执行
46             // 若返回的x == s表示，当前线程已经超时或者中断，不然的话s == null或者是匹配的节点
47             if (x == s) {                   // wait was cancelled
48                 clean(t, s);
49                 return null;
50             }
51             // 若s节点被设置为取消
52             if (!s.isOffList()) {           // not already unlinked
53                 advanceHead(t, s);          // unlink if head
54                 if (x != null)              // and forget fields
55                     s.item = s;
56                 s.waiter = null;
57             }
58             return (x != null) ? x : e;
59 
60         // 这里的 else 分支就是上面说的第二种情况，有相应的读或写相匹配的情况
61         } else {                            // complementary-mode
62             QNode m = h.next;               // node to fulfill
63             // 不一致读，表明有其他线程修改了队列
64             if (t != tail || m == null || h != head)
65                 continue;                   // inconsistent read
66 
67             Object x = m.item;
68             if (isData == (x != null) ||    // m already fulfilled
69                 x == m ||                   // m cancelled
70                 !m.casItem(x, e)) {         // lost CAS
71                 advanceHead(h, m);          // dequeue and retry
72                 continue;
73             }
74 
75             advanceHead(h, m);              // successfully fulfilled
76             LockSupport.unpark(m.waiter);
77             return (x != null) ? x : e;
78         }
79     }
80 }
81 
82 void advanceTail(QNode t, QNode nt) {
83     if (tail == t)
84         UNSAFE.compareAndSwapObject(this, tailOffset, t, nt);
85 }

 1 // 自旋或阻塞，直到满足条件，这个方法返回
 2 Object awaitFulfill(QNode s, Object e, boolean timed, long nanos) {
 3 
 4     long lastTime = timed ? System.nanoTime() : 0;
 5     Thread w = Thread.currentThread();
 6     // 判断需要自旋的次数，
 7     int spins = ((head.next == s) ?
 8                  (timed ? maxTimedSpins : maxUntimedSpins) : 0);
 9     for (;;) {
10         // 如果被中断了，那么取消这个节点
11         if (w.isInterrupted())
12             // 就是将当前节点 s 中的 item 属性设置为 this
13             s.tryCancel(e);
14         Object x = s.item;
15         // 这里是这个方法的唯一的出口
16         if (x != e)
17             return x;
18         // 如果需要，检测是否超时
19         if (timed) {
20             long now = System.nanoTime();
21             nanos -= now - lastTime;
22             lastTime = now;
23             if (nanos <= 0) {
24                 s.tryCancel(e);
25                 continue;
26             }
27         }
28         if (spins > 0)
29             --spins;
30         // 如果自旋达到了最大的次数，那么检测
31         else if (s.waiter == null)
32             s.waiter = w;
33         // 如果自旋到了最大的次数，或者没有设置超时，那么线程挂起，等待唤醒
34         else if (!timed)
35             //挂起当前线程
36             LockSupport.park(this);
37         else if (nanos > spinForTimeoutThreshold)
38             LockSupport.parkNanos(this, nanos);
39     }
40 }
41 
42  void tryCancel(Object cmp) {
43      //将节点item设置为自己，代表此节点取消排队
44      UNSAFE.compareAndSwapObject(this, itemOffset, cmp, this);
45  }