Java多线程
Java并发
JUC集合

Java多线程 39—— ConcurrentLinkedQueue详解

简介:ConcurrentLinkedQueue是线程安全的队列,它适用于高并发的场景。它是一个基于链接节点的无界线程安全队列,按照FIFO(先进先出)原则对元素进行排序。队列元素中不可以放置null元素(内部实现的特殊节点除外)。

1. ConcurrentLinkedQueue介绍

ConcurrentLinkedQueue是线程安全的队列,它适用于高并发的场景。它是一个基于链接节点的无界线程安全队列,按照FIFO(先进先出)原则对元素进行排序。队列元素中不可以放置null元素(内部实现的特殊节点除外)。

ConcurrentLinkedQueue的类图结构如下所示:

1.ConcurrentLinkedQueue类图结构.png

  1. ConcurrentLinkedQueue继承于AbstractQueue。
  2. ConcurrentLinkedQueue内部是通过链表来实现的,它同时包含链表的头节点head和尾节点tail。ConcurrentLinkedQueue按照FIFO(先进先出)原则对元素进行排序。元素都是从尾部插入到链表,从头部获取返回。
  3. ConcurrentLinkedQueue的链表Node中的next的类型是volatile,而且链表数据item的类型也是volatile。对一个volatile变量的读,总是能看到(任意线程)对这个volatile变量最后的写入。ConcurrentLinkedQueue就是通过volatile来实现多线程对竞争资源的互斥访问的。

ConcurrentLinkedQueue函数列表如下:

  • // 创建一个最初为空的ConcurrentLinkedQueue
  • ConcurrentLinkedQueue()
  • // 创建一个最初包含给定collection元素的ConcurrentLinkedQueue,按照此collection迭代器的遍历顺序来添加元素
  • ConcurrentLinkedQueue(Collection<? extends E> c)
  • // 将指定元素插入此队列的尾部
  • boolean add(E e)
  • // 如果此队列包含指定元素,则返回true
  • boolean contains(Object o)
  • // 如果此队列不包含任何元素,则返回true
  • boolean isEmpty()
  • // 返回在此队列元素上以恰当顺序进行迭代的迭代器
  • Iterator<E> iterator()
  • // 将指定元素插入此队列的尾部
  • boolean offer(E e)
  • // 获取但不移除此队列的头;如果此队列为空,则返回null
  • E peek()
  • // 获取并移除此队列的头,如果此队列为空,则返回null
  • E poll()
  • // 从队列中移除指定元素的单个实例(如果存在)
  • boolean remove(Object o)
  • // 返回此队列中的元素数量
  • int size()
  • // 返回以恰当顺序包含此队列所有元素的数组
  • Object[] toArray()
  • // 返回以恰当顺序包含此队列所有元素的数组;返回数组的运行时类型是指定数组的运行时类型
  • <T> T[] toArray(T[] a)

2. ConcurrentLinkedQueue源码解析

下面是ConcurrentLinkedQueue的源码解析,基于JDK 1.7.0_07:

  • package java.util.concurrent;
  • import java.util.AbstractQueue;
  • import java.util.ArrayList;
  • import java.util.Collection;
  • import java.util.Iterator;
  • import java.util.NoSuchElementException;
  • import java.util.Queue;
  • public class ConcurrentLinkedQueue<E> extends AbstractQueue<E>
  • implements Queue<E>, java.io.Serializable {
  • private static final long serialVersionUID = 196745693267521676L;
  • // 装载元素的节点
  • private static class Node<E> {
  • // 装载的元素
  • volatile E item;
  • // 后继节点
  • volatile Node<E> next;
  • /**
  • * Constructs a new node. Uses relaxed write because item can
  • * only be seen after publication via casNext.
  • *
  • * 构造方法,通过传入参数,使用Unsafe类设置item
  • */
  • Node(E item) {
  • UNSAFE.putObject(this, itemOffset, item);
  • }
  • // CAS方式修改item
  • boolean casItem(E cmp, E val) {
  • return UNSAFE.compareAndSwapObject(this, itemOffset, cmp, val);
  • }
  • // 设置节点为后继
  • void lazySetNext(Node<E> val) {
  • UNSAFE.putOrderedObject(this, nextOffset, val);
  • }
  • // 修改后继节点
  • boolean casNext(Node<E> cmp, Node<E> val) {
  • return UNSAFE.compareAndSwapObject(this, nextOffset, cmp, val);
  • }
  • // Unsafe mechanics
  • private static final sun.misc.Unsafe UNSAFE;
  • // 元素item偏移量
  • private static final long itemOffset;
  • // 后继节点next偏移量
  • private static final long nextOffset;
  • static {
  • try {
  • // Unsafe类
  • UNSAFE = sun.misc.Unsafe.getUnsafe();
  • Class k = Node.class;
  • itemOffset = UNSAFE.objectFieldOffset(k.getDeclaredField("item"));
  • nextOffset = UNSAFE.objectFieldOffset(k.getDeclaredField("next"));
  • } catch (Exception e) {
  • throw new Error(e);
  • }
  • }
  • }
  • /**
  • * A node from which the first live (non-deleted) node (if any)
  • * can be reached in O(1) time.
  • * Invariants:
  • * - all live nodes are reachable from head via succ()
  • * - head != null
  • * - (tmp = head).next != tmp || tmp != head
  • * Non-invariants:
  • * - head.item may or may not be null.
  • * - it is permitted for tail to lag behind head, that is, for tail
  • * to not be reachable from head!
  • *
  • * 头节点,即第一个有效的节点
  • */
  • private transient volatile Node<E> head;
  • /**
  • * A node from which the last node on list (that is, the unique
  • * node with node.next == null) can be reached in O(1) time.
  • * Invariants:
  • * - the last node is always reachable from tail via succ()
  • * - tail != null
  • * Non-invariants:
  • * - tail.item may or may not be null.
  • * - it is permitted for tail to lag behind head, that is, for tail
  • * to not be reachable from head!
  • * - tail.next may or may not be self-pointing to tail.
  • *
  • * 尾节点
  • */
  • private transient volatile Node<E> tail;
  • /**
  • * Creates a {@code ConcurrentLinkedQueue} that is initially empty.
  • *
  • * 构造方法
  • */
  • public ConcurrentLinkedQueue() {
  • // head和tail都初始化为一个item为null的Node节点
  • head = tail = new Node<E>(null);
  • }
  • /**
  • * Creates a {@code ConcurrentLinkedQueue}
  • * initially containing the elements of the given collection,
  • * added in traversal order of the collection's iterator.
  • *
  • * 给定一个Collection,创建一个ConcurrentLinkedQueue
  • * 将Collection中的元素添加到该ConcurrentLinkedQueue
  • *
  • * @param c the collection of elements to initially contain
  • * @throws NullPointerException if the specified collection or any
  • * of its elements are null
  • */
  • public ConcurrentLinkedQueue(Collection<? extends E> c) {
  • Node<E> h = null, t = null;
  • // 遍历Collection中的元素
  • for (E e : c) {
  • // 检查元素
  • checkNotNull(e);
  • // 根据元素构造一个节点
  • Node<E> newNode = new Node<E>(e);
  • // 当h为null时,表示此时ConcurrentLinkedQueue没有节点
  • if (h == null)
  • // 将h和t都指向新节点newNode
  • h = t = newNode;
  • else {
  • /**
  • * 当h不为null时,表示此时ConcurrentLinkedQueue已有节点
  • * 将newNode设置t的后继
  • */
  • t.lazySetNext(newNode);
  • // 将t指向新添加的节点newNode
  • t = newNode;
  • }
  • }
  • // 如果添加完h还为null,表示Collection是空的
  • if (h == null)
  • // 此时手动将h和t置为item为null的Node
  • h = t = new Node<E>(null);
  • // 将head指向h,tail指向t
  • head = h;
  • tail = t;
  • }
  • // Have to override just to update the javadoc
  • /**
  • * Inserts the specified element at the tail of this queue.
  • * As the queue is unbounded, this method will never throw
  • * {@link IllegalStateException} or return {@code false}.
  • *
  • * 添加元素,内部调用的offer()
  • *
  • * @return {@code true} (as specified by {@link Collection#add})
  • * @throws NullPointerException if the specified element is null
  • */
  • public boolean add(E e) {
  • return offer(e);
  • }
  • /**
  • * Try to CAS head to p. If successful, repoint old head to itself
  • * as sentinel for succ(), below.
  • *
  • * 更新head节点,设置成功后会将老的head节点的后继设置为自己
  • *
  • */
  • final void updateHead(Node<E> h, Node<E> p) {
  • // 检查h是否与p相同,不相同才设置h为p
  • if (h != p && casHead(h, p))
  • // 将h的后继设为自己
  • h.lazySetNext(h);
  • }
  • /**
  • * Returns the successor of p, or the head node if p.next has been
  • * linked to self, which will only be true if traversing with a
  • * stale pointer that is now off the list.
  • *
  • * 获取p的后继
  • * 当p的后继为自己,就返回head,否则返回p的后继
  • */
  • final Node<E> succ(Node<E> p) {
  • // 获取p的后继
  • Node<E> next = p.next;
  • // 检查p的后继是否是自己
  • return (p == next) ? head : next;
  • }
  • /**
  • * Inserts the specified element at the tail of this queue.
  • * As the queue is unbounded, this method will never return {@code false}.
  • *
  • * 在链表尾部添加元素
  • *
  • * @return {@code true} (as specified by {@link Queue#offer})
  • * @throws NullPointerException if the specified element is null
  • */
  • public boolean offer(E e) {
  • // 检查添加元素的有效性
  • checkNotNull(e);
  • // 根据添加元素创建一个新的Node节点newNode
  • final Node<E> newNode = new Node<E>(e);
  • // 使t指向尾节点,p指向t
  • for (Node<E> t = tail, p = t;;) {
  • // 获取p的后继为q
  • Node<E> q = p.next;
  • // 如果q为null
  • if (q == null) {
  • // p is last node
  • // 此时p是尾节点,直接将其后继设置为newNode
  • if (p.casNext(null, newNode)) {
  • // Successful CAS is the linearization point
  • // for e to become an element of this queue,
  • // and for newNode to become "live".
  • // 设置成功后检查p是否与t相等
  • if (p != t) // hop two nodes at a time
  • // 如果不等,就将tail设置为newNode
  • casTail(t, newNode); // Failure is OK.
  • // 返回true
  • return true;
  • }
  • // Lost CAS race to another thread; re-read next
  • }
  • else if (p == q)
  • // We have fallen off list. If tail is unchanged, it
  • // will also be off-list, in which case we need to
  • // jump to head, from which all live nodes are always
  • // reachable. Else the new tail is a better bet.
  • /**
  • * 此时代表p的next指向自己,即p其实是一个被移除的节点(可能是其他线程并发修改的)
  • * 因此尝试修改p的指向,如果tail修改了,就将p置为tail,否则将p置为head
  • * 然后重新开始下一个循环
  • */
  • p = (t != (t = tail)) ? t : head;
  • else
  • // Check for tail updates after two hops.
  • /**
  • * 如果q不等于null,且p不等于q,这时可能有其他的线程恰好抢先一步添加了一个节点
  • * 则判断p与t是否不同,即tail是否改变:
  • * 1. p与t相同,表示这是第一循环且t未改变,此时将q赋值给p,即后移;
  • * 2. p与t不同,但t未发生改变,说明p已经后移了,此时将q赋值给p,即继续后移;
  • * 3. p与t不同,且t发生了改变,即tail更新了,此时将p指向t(即新的tail,指向尾部是最优方式)
  • * 注意这里的t != (t = tail)的执行顺序:
  • * 1. 先取出左值t;
  • * 2,再执行右值的t = tail,此时t被设置为tail,但左值还是旧的t;
  • * 3,再比较左值旧的t和右值新的t。
  • * 然后重新开始下一个循环
  • */
  • p = (p != t && t != (t = tail)) ? t : q;
  • }
  • }
  • // 获取链表头元素
  • public E poll() {
  • restartFromHead:
  • for (;;) {
  • // h为head,p也为h,q为null
  • for (Node<E> h = head, p = h, q;;) {
  • // 获取p的item
  • E item = p.item;
  • // 判断p的item是否为null,如果不是就CAS方式设置为null
  • if (item != null && p.casItem(item, null)) {
  • // Successful CAS is the linearization point
  • // for item to be removed from this queue.
  • /**
  • * p的item不为null,且设置p的item为null成功
  • * 判断p是否还等于h
  • */
  • if (p != h) // hop two nodes at a time
  • /**
  • * 如果p不等于h
  • * 1. 如果p的后继为null,则将head修改为p
  • * 2. 如果p的后继不为null,则将head修改为p的后继
  • */
  • updateHead(h, ((q = p.next) != null) ? q : p);
  • // 返回item
  • return item;
  • } else if ((q = p.next) == null) {
  • /**
  • * 走到这里有两种情况:
  • * 1. p的item不为null,但设置p的item为null失败;
  • * 2. p的item为null
  • * 同时满足p的next为null,则更新head为p
  • * 如果条件满足,说明p已经是链表中最后一个节点了
  • */
  • updateHead(h, p);
  • // 返回null
  • return null;
  • } else if (p == q)
  • /**
  • * 走到这里有两种情况:
  • * 1. p的item不为null,但设置p的item为null失败;
  • * 2. p的item为null。
  • * 此时代表p的next指向自己,即p其实是一个被移除的节点(可能是其他线程并发修改的)
  • * 则continue重新开始外层循环
  • */
  • continue restartFromHead;
  • else
  • /**
  • * 走到这里有两种情况:
  • * 1. p的item不为null,但设置p的item为null失败,即有可能是其他线程抢先了;
  • * 2. p的item为null
  • * 同时满足p.next不为null,p不等于q,则将p置为q,即后移操作
  • */
  • p = q;
  • }
  • }
  • }
  • // 查看链表中第一个有效的节点
  • public E peek() {
  • restartFromHead:
  • for (;;) {
  • // 从head节点开始往后遍历,将p指向head
  • for (Node<E> h = head, p = h, q;;) {
  • // 获取p的item
  • E item = p.item;
  • /**
  • * 如果要满足if条件有两种情况:
  • * 1. p的item不为null;说明p是有效节点
  • * 2. p的item为null,但p.next也为null;说明p是最后一个节点,且p是无效节点
  • */
  • if (item != null || (q = p.next) == null) {
  • // 设置head为p,并将h(旧的head)的next指向自己
  • updateHead(h, p);
  • // 就返回p的item
  • return item;
  • }
  • /**
  • * 如果满足else if条件:
  • * p的item为null,且p的next指向了自己,说明p是一个无效节点
  • * 此时重新开始外层循环即可
  • */
  • else if (p == q)
  • continue restartFromHead;
  • else
  • /**
  • * 此时q为p的next,且满足:
  • * p的item为null,且q不为null,且p与q不相等
  • * 说明此时p是无效节点(因为item为null),因此将p往后移
  • */
  • p = q;
  • }
  • }
  • }
  • /**
  • * Returns the first live (non-deleted) node on list, or null if none.
  • * This is yet another variant of poll/peek; here returning the
  • * first node, not element. We could make peek() a wrapper around
  • * first(), but that would cost an extra volatile read of item,
  • * and the need to add a retry loop to deal with the possibility
  • * of losing a race to a concurrent poll().
  • *
  • * 返回链表中第一个有效的节点
  • */
  • Node<E> first() {
  • restartFromHead:
  • for (;;) {
  • // 从head节点开始往后遍历,将p指向head
  • for (Node<E> h = head, p = h, q;;) {
  • // 判断p指针位置节点的item是否为空
  • boolean hasItem = (p.item != null);
  • /**
  • * 如果要满足if条件有两种情况:
  • * 1. p的item不为null;说明p是有效节点
  • * 2. p的item为null,但p.next也为null;说明p是最后一个节点,且p是无效节点
  • */
  • if (hasItem || (q = p.next) == null) {
  • // 设置head为p,并将h(旧的head)的next指向自己
  • updateHead(h, p);
  • // 如果p的item不为null就返回p,否则返回null
  • return hasItem ? p : null;
  • }
  • /**
  • * 如果满足else if条件:
  • * p的item为null,且p的next指向了自己,说明p是一个无效节点
  • * 此时重新开始外层循环即可
  • */
  • else if (p == q)
  • continue restartFromHead;
  • else
  • /**
  • * 此时q为p的next,且满足:
  • * p的item为null,且q不为null,且p与q不相等
  • * 说明此时p是无效节点(因为item为null),因此将p往后移
  • */
  • p = q;
  • }
  • }
  • }
  • /**
  • * Returns {@code true} if this queue contains no elements.
  • *
  • * 判断ConcurrentLinkedQueue是否为空,底层直接使用first()是否为null来判断的
  • *
  • * @return {@code true} if this queue contains no elements
  • */
  • public boolean isEmpty() {
  • return first() == null;
  • }
  • /**
  • * Returns the number of elements in this queue. If this queue
  • * contains more than {@code Integer.MAX_VALUE} elements, returns
  • * {@code Integer.MAX_VALUE}.
  • *
  • * <p>Beware that, unlike in most collections, this method is
  • * <em>NOT</em> a constant-time operation. Because of the
  • * asynchronous nature of these queues, determining the current
  • * number of elements requires an O(n) traversal.
  • * Additionally, if elements are added or removed during execution
  • * of this method, the returned result may be inaccurate. Thus,
  • * this method is typically not very useful in concurrent
  • * applications.
  • *
  • * 获取ConcurrentLinkedQueue中元素的数量
  • *
  • * @return the number of elements in this queue
  • */
  • public int size() {
  • int count = 0;
  • // 从第一个有效的节点开始向后遍历
  • for (Node<E> p = first(); p != null; p = succ(p))
  • // 如果节点的item不为null,就使count自增
  • if (p.item != null)
  • // Collection.size() spec says to max out
  • /**
  • * 当count自增到Integer.MAX_VALUE,跳出循环
  • * 因此元素数量最多只会有Integer.MAX_VALUE个
  • */
  • if (++count == Integer.MAX_VALUE)
  • break;
  • return count;
  • }
  • /**
  • * Returns {@code true} if this queue contains the specified element.
  • * More formally, returns {@code true} if and only if this queue contains
  • * at least one element {@code e} such that {@code o.equals(e)}.
  • *
  • * 判断ConcurrentLinkedQueue是否包含指定元素
  • *
  • * @param o object to be checked for containment in this queue
  • * @return {@code true} if this queue contains the specified element
  • */
  • public boolean contains(Object o) {
  • // 如果o为null,直接返回false
  • if (o == null) return false;
  • // 从第一个有效的节点开始向后遍历
  • for (Node<E> p = first(); p != null; p = succ(p)) {
  • // 获取节点的item
  • E item = p.item;
  • // 将获取的item与传入的o进行比较,如果相等就直接返回true
  • if (item != null && o.equals(item))
  • return true;
  • }
  • // 运行到这里说明链表中没有指定元素
  • return false;
  • }
  • /**
  • * Removes a single instance of the specified element from this queue,
  • * if it is present. More formally, removes an element {@code e} such
  • * that {@code o.equals(e)}, if this queue contains one or more such
  • * elements.
  • * Returns {@code true} if this queue contained the specified element
  • * (or equivalently, if this queue changed as a result of the call).
  • *
  • * @param o element to be removed from this queue, if present
  • * @return {@code true} if this queue changed as a result of the call
  • */
  • public boolean remove(Object o) {
  • // 检查参数是否合法
  • if (o == null) return false;
  • // 用于记录前驱节点
  • Node<E> pred = null;
  • // 从第一个有效节点开始向后遍历,终止条件是遍历到的节点p为null,更新条件是获取p的后继节点
  • for (Node<E> p = first(); p != null; p = succ(p)) {
  • // 获取p的item
  • E item = p.item;
  • /**
  • * 如果p的item不为null,且传入的o与p的item相同
  • * 就尝试将p的item修改为null
  • */
  • if (item != null && o.equals(item) && p.casItem(item, null)) {
  • // 获取p的后继节点
  • Node<E> next = succ(p);
  • /**
  • * 如果pred不为null且p的后继不为null,
  • * 这里的pred有可能是p的前驱,但也有可能是null,
  • * 当pred不为null时,则pred是p的前驱,将其后继设置为p的后继就可以跳过p了
  • * 当pred为null时,说明p没有前驱,此时不用管p,因为已经将p的item设置为null了,在其他操作中p会被另行处理
  • */
  • if (pred != null && next != null)
  • // CAS方式将pred的后继从p设置为p的后继
  • pred.casNext(p, next);
  • // 返回true,代表移除成功
  • return true;
  • }
  • /**
  • * 走到这里有几种情况:
  • * 1. p的item为null;
  • * 2. p的item不为null,但与o不相同;
  • * 2. p的item不为null且与o相同,但CAS方式修改该item时失败,表示p的item可能被其他线程修改了。
  • * 此时将pred指向p,然后进行下一次循环
  • */
  • pred = p;
  • }
  • // 循环玩链表也没找到与o相同的item,直接返回false
  • return false;
  • }
  • /**
  • * Appends all of the elements in the specified collection to the end of
  • * this queue, in the order that they are returned by the specified
  • * collection's iterator. Attempts to {@code addAll} of a queue to
  • * itself result in {@code IllegalArgumentException}.
  • *
  • * 将集合c中的元素添加到ConcurrentLinkedQueue中
  • *
  • * @param c the elements to be inserted into this queue
  • * @return {@code true} if this queue changed as a result of the call
  • * @throws NullPointerException if the specified collection or any
  • * of its elements are null
  • * @throws IllegalArgumentException if the collection is this queue
  • */
  • public boolean addAll(Collection<? extends E> c) {
  • // 检查传入参数c是否与自己相同,如果相同则抛出异常
  • if (c == this)
  • // As historically specified in AbstractQueue#addAll
  • throw new IllegalArgumentException();
  • // Copy c into a private chain of Nodes
  • // 将集合c中的元素构成一个单独的Node链
  • Node<E> beginningOfTheEnd = null, last = null;
  • // 遍历集合
  • for (E e : c) {
  • // 检查元素
  • checkNotNull(e);
  • // 构建Node节点
  • Node<E> newNode = new Node<E>(e);
  • if (beginningOfTheEnd == null)
  • // if成立表示链为null,直接将beginningOfTheEnd和last指向新Node
  • beginningOfTheEnd = last = newNode;
  • else {
  • // 否则表示链中有Node,将新Node设置为last的后继,然后将last指向新Node
  • last.lazySetNext(newNode);
  • last = newNode;
  • }
  • }
  • // 如果beginningOfTheEnd为null,表示集合c没有元素,构成的链是空链,直接返回false即可
  • if (beginningOfTheEnd == null)
  • return false;
  • // Atomically append the chain at the tail of this collection
  • // 将上面有集合c构成的Node链连接到当前的ConcurrentLinkedQueue的Node链尾部
  • // 获取tail节点,并将p和t指向该tail节点
  • for (Node<E> t = tail, p = t;;) {
  • // 获取p的后继
  • Node<E> q = p.next;
  • if (q == null) {
  • // p is last node
  • // p的后继q为null,将beginningOfTheEnd设置为p的后继
  • if (p.casNext(null, beginningOfTheEnd)) {
  • // Successful CAS is the linearization point
  • // for all elements to be added to this queue.
  • // 如果p修改后继成功,就尝试修改tail为last
  • if (!casTail(t, last)) {
  • // Try a little harder to update tail,
  • // since we may be adding many elements.
  • /**
  • * 修改失败,重设t,然后判断last后面是否有新节点添加,
  • * 如果没有,重新尝试修改tial为last
  • */
  • t = tail;
  • if (last.next == null)
  • casTail(t, last);
  • }
  • // 返回true
  • return true;
  • }
  • // Lost CAS race to another thread; re-read next
  • }
  • else if (p == q)
  • // We have fallen off list. If tail is unchanged, it
  • // will also be off-list, in which case we need to
  • // jump to head, from which all live nodes are always
  • // reachable. Else the new tail is a better bet.
  • /**
  • * 此时代表p的next指向自己,即p其实是一个被移除的节点(可能是其他线程并发修改的)
  • * 因此尝试修改p的指向,如果tail修改了,就将p置为tail,否则将p置为head
  • * 然后重新开始下一个循环
  • */
  • p = (t != (t = tail)) ? t : head;
  • else
  • // Check for tail updates after two hops.
  • /**
  • * 如果q不等于null,且p不等于q,这时可能有其他的线程恰好抢先一步添加了一个节点
  • * 则判断p与t是否不同,即tail是否改变:
  • * 1. p与t相同,表示这是第一循环且t未改变,此时将q赋值给p,即后移;
  • * 2. p与t不同,但t未发生改变,说明p已经后移了,此时将q赋值给p,即继续后移;
  • * 3. p与t不同,且t发生了改变,即tail更新了,此时将p指向t(即新的tail,指向尾部是最优方式)
  • * 注意这里的t != (t = tail)的执行顺序:
  • * 1. 先取出左值t;
  • * 2,再执行右值的t = tail,此时t被设置为tail,但左值还是旧的t;
  • * 3,再比较左值旧的t和右值新的t。
  • * 然后重新开始下一个循环
  • */
  • p = (p != t && t != (t = tail)) ? t : q;
  • }
  • }
  • /**
  • * Returns an array containing all of the elements in this queue, in
  • * proper sequence.
  • *
  • * <p>The returned array will be "safe" in that no references to it are
  • * maintained by this queue. (In other words, this method must allocate
  • * a new array). The caller is thus free to modify the returned array.
  • *
  • * <p>This method acts as bridge between array-based and collection-based
  • * APIs.
  • *
  • * @return an array containing all of the elements in this queue
  • */
  • public Object[] toArray() {
  • // Use ArrayList to deal with resizing.
  • // 创建一个列表al
  • ArrayList<E> al = new ArrayList<E>();
  • // 从第一个节点开始向后遍历到最后一个节点
  • for (Node<E> p = first(); p != null; p = succ(p)) {
  • // 将有效元素添加到al中
  • E item = p.item;
  • if (item != null)
  • al.add(item);
  • }
  • // 将al转为元素类型为a数组元素类型的数组并返回
  • return al.toArray();
  • }
  • /**
  • * Returns an array containing all of the elements in this queue, in
  • * proper sequence; the runtime type of the returned array is that of
  • * the specified array. If the queue fits in the specified array, it
  • * is returned therein. Otherwise, a new array is allocated with the
  • * runtime type of the specified array and the size of this queue.
  • *
  • * <p>If this queue fits in the specified array with room to spare
  • * (i.e., the array has more elements than this queue), the element in
  • * the array immediately following the end of the queue is set to
  • * {@code null}.
  • *
  • * <p>Like the {@link #toArray()} method, this method acts as bridge between
  • * array-based and collection-based APIs. Further, this method allows
  • * precise control over the runtime type of the output array, and may,
  • * under certain circumstances, be used to save allocation costs.
  • *
  • * <p>Suppose {@code x} is a queue known to contain only strings.
  • * The following code can be used to dump the queue into a newly
  • * allocated array of {@code String}:
  • *
  • * <pre>
  • * String[] y = x.toArray(new String[0]);</pre>
  • *
  • * Note that {@code toArray(new Object[0])} is identical in function to
  • * {@code toArray()}.
  • *
  • * @param a the array into which the elements of the queue are to
  • * be stored, if it is big enough; otherwise, a new array of the
  • * same runtime type is allocated for this purpose
  • * @return an array containing all of the elements in this queue
  • * @throws ArrayStoreException if the runtime type of the specified array
  • * is not a supertype of the runtime type of every element in
  • * this queue
  • * @throws NullPointerException if the specified array is null
  • */
  • @SuppressWarnings("unchecked")
  • public <T> T[] toArray(T[] a) {
  • // try to use sent-in array
  • int k = 0;
  • Node<E> p;
  • // 从第一个节点开始向后遍历,条件为节点不为null且a数组未装满
  • for (p = first(); p != null && k < a.length; p = succ(p)) {
  • // 如果节点的元素不为null,将其添加到a中
  • E item = p.item;
  • if (item != null)
  • a[k++] = (T)item;
  • }
  • // 当链表遍历完,a还没装满的时候,将a剩余位置上都置为null,并返回a
  • if (p == null) {
  • if (k < a.length)
  • a[k] = null;
  • return a;
  • }
  • // If won't fit, use ArrayList version
  • /**
  • * 运行到这里,说明a装满了,但链表中还有没处理的节点
  • * 即链表中元素总数大于a的容量,因此创建一个新的列表al
  • * 从第一个节点开始向后遍历到最后一个节点
  • */
  • ArrayList<E> al = new ArrayList<E>();
  • for (Node<E> q = first(); q != null; q = succ(q)) {
  • // 将有效元素添加到al中
  • E item = q.item;
  • if (item != null)
  • al.add(item);
  • }
  • // 将al转为元素类型为a数组元素类型的数组并返回
  • return al.toArray(a);
  • }
  • /**
  • * Returns an iterator over the elements in this queue in proper sequence.
  • * The elements will be returned in order from first (head) to last (tail).
  • *
  • * <p>The returned iterator is a "weakly consistent" iterator that
  • * will never throw {@link java.util.ConcurrentModificationException
  • * ConcurrentModificationException}, and guarantees to traverse
  • * elements as they existed upon construction of the iterator, and
  • * may (but is not guaranteed to) reflect any modifications
  • * subsequent to construction.
  • *
  • * 获取迭代器
  • *
  • * @return an iterator over the elements in this queue in proper sequence
  • */
  • public Iterator<E> iterator() {
  • return new Itr();
  • }
  • private class Itr implements Iterator<E> {
  • /**
  • * Next node to return item for.
  • * 下一次将要返回的节点
  • */
  • private Node<E> nextNode;
  • /**
  • * nextItem holds on to item fields because once we claim
  • * that an element exists in hasNext(), we must return it in
  • * the following next() call even if it was in the process of
  • * being removed when hasNext() was called.
  • *
  • * 下一次将要返回的元素
  • */
  • private E nextItem;
  • /**
  • * Node of the last returned item, to support remove.
  • *
  • * 上次返回的节点
  • */
  • private Node<E> lastRet;
  • // 构造方法
  • Itr() {
  • // 直接调用advance()
  • advance();
  • }
  • /**
  • * Moves to next valid node and returns item to return for
  • * next(), or null if no such.
  • */
  • private E advance() {
  • // 使用lastRet记录nextNode
  • lastRet = nextNode;
  • // 使用x记录nextItem
  • E x = nextItem;
  • Node<E> pred, p;
  • /**
  • * 当nextNode为null,说明是从头开始,
  • * 将p置为第一个有效节点,pred置为null
  • */
  • if (nextNode == null) {
  • p = first();
  • pred = null;
  • } else {
  • // 否则将pred置为nextNode,p置为nextNode的后继节点
  • pred = nextNode;
  • p = succ(nextNode);
  • }
  • for (;;) {
  • // 如果p为null,说明链表为空
  • if (p == null) {
  • // 将nextNode和nextItem都置为null
  • nextNode = null;
  • nextItem = null;
  • // 返回x
  • return x;
  • }
  • // 到这里说明p不为null,取出p的item
  • E item = p.item;
  • if (item != null) {
  • /**
  • * 如果p的item不为null,说明p是有效节点
  • * 用nextNode记录p,nextItem记录p的item
  • */
  • nextNode = p;
  • nextItem = item;
  • // 返回之前nextItem保存的旧值x
  • return x;
  • } else {
  • // skip over nulls
  • // 否则说明p的item为null,则获取p的后继节点为next
  • Node<E> next = succ(p);
  • if (pred != null && next != null)
  • // 将pred的后继从p换成上面的获取的p的后继,即跳过p
  • pred.casNext(p, next);
  • // p置为p的next,然后进行下一次循环
  • p = next;
  • }
  • }
  • }
  • // 是否还有还下一个元素
  • public boolean hasNext() {
  • return nextNode != null;
  • }
  • // 返回下一个元素
  • public E next() {
  • // 判断nextNode是否为null,如果为null说明没有可返回的元素了
  • if (nextNode == null) throw new NoSuchElementException();
  • // 返回元素,并后移nextNode和nextItem
  • return advance();
  • }
  • // 移除当前元素
  • public void remove() {
  • Node<E> l = lastRet;
  • if (l == null) throw new IllegalStateException();
  • // rely on a future traversal to relink.
  • l.item = null;
  • lastRet = null;
  • }
  • }
  • /**
  • * Saves the state to a stream (that is, serializes it).
  • *
  • * 序列化写
  • *
  • * @serialData All of the elements (each an {@code E}) in
  • * the proper order, followed by a null
  • * @param s the stream
  • */
  • private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException {
  • // Write out any hidden stuff
  • // 调用默认的序列化写方法
  • s.defaultWriteObject();
  • // Write out all elements in the proper order.
  • // 从第一个有效节点开始向后遍历
  • for (Node<E> p = first(); p != null; p = succ(p)) {
  • // 将item不为null的元素都通过writeObject()写出
  • Object item = p.item;
  • if (item != null)
  • s.writeObject(item);
  • }
  • // Use trailing null as sentinel
  • // 最后写出一个null
  • s.writeObject(null);
  • }
  • /**
  • * Reconstitutes the instance from a stream (that is, deserializes it).
  • *
  • * 序列化读方法
  • *
  • * @param s the stream
  • */
  • private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, ClassNotFoundException {
  • // 调用默认的序列化读
  • s.defaultReadObject();
  • // Read in elements until trailing null sentinel found
  • // 两个引用
  • Node<E> h = null, t = null;
  • Object item;
  • // 循环通过readObject()序列化读方法读入元素,当读入元素不为空时进入循环体
  • while ((item = s.readObject()) != null) {
  • @SuppressWarnings("unchecked")
  • // 将读到的元素包装为一个Node节点
  • Node<E> newNode = new Node<E>((E) item);
  • // 当h为null时,表示此时ConcurrentLinkedQueue没有节点
  • if (h == null)
  • // 将h和t都指向新节点newNode
  • h = t = newNode;
  • else {
  • /**
  • * 当h不为null时,表示此时ConcurrentLinkedQueue已有节点
  • * 将newNode设置t的后继
  • */
  • t.lazySetNext(newNode);
  • t = newNode;
  • }
  • }
  • // 如果添加完h还为null,表示Collection是空的
  • if (h == null)
  • // 此时手动将h和t置为item为null的Node
  • h = t = new Node<E>(null);
  • // 将head指向h,tail指向t
  • head = h;
  • tail = t;
  • }
  • /**
  • * Throws NullPointerException if argument is null.
  • *
  • * 检查v是否为null,如果为null会抛出NullPointerException异常
  • *
  • * @param v the element
  • */
  • private static void checkNotNull(Object v) {
  • if (v == null)
  • throw new NullPointerException();
  • }
  • // CAS方式设置尾节点
  • private boolean casTail(Node<E> cmp, Node<E> val) {
  • return UNSAFE.compareAndSwapObject(this, tailOffset, cmp, val);
  • }
  • // CAS方式设置头节点
  • private boolean casHead(Node<E> cmp, Node<E> val) {
  • return UNSAFE.compareAndSwapObject(this, headOffset, cmp, val);
  • }
  • // Unsafe mechanics
  • private static final sun.misc.Unsafe UNSAFE;
  • private static final long headOffset;
  • private static final long tailOffset;
  • static {
  • try {
  • UNSAFE = sun.misc.Unsafe.getUnsafe();
  • Class k = ConcurrentLinkedQueue.class;
  • // 头节点偏移量
  • headOffset = UNSAFE.objectFieldOffset(k.getDeclaredField("head"));
  • // 尾节点偏移量
  • tailOffset = UNSAFE.objectFieldOffset(k.getDeclaredField("tail"));
  • } catch (Exception e) {
  • throw new Error(e);
  • }
  • }
  • }

ConcurrentLinkedQueue的实现中,关于添加和获取等相关操作的代码的逻辑是比较复杂的,因为涉及多个线程并发的情况,单独阅读源码比较难以理解,下面着重通过案例流程演示来讲解offer(E)poll()两个方法。

2.1. offer(E)方法

offer(E)是ConcurrentLinkedQueue主要的添加方法,另外的添加方法如add(E)其实内部调用的也是offer(E),该方法的源码如下:

  • /**
  • * Inserts the specified element at the tail of this queue.
  • * As the queue is unbounded, this method will never return {@code false}.
  • *
  • * 在链表尾部添加元素
  • *
  • * @return {@code true} (as specified by {@link Queue#offer})
  • * @throws NullPointerException if the specified element is null
  • */
  • public boolean offer(E e) {
  • // 检查添加元素的有效性
  • checkNotNull(e);
  • // 根据添加元素创建一个新的Node节点newNode
  • final Node<E> newNode = new Node<E>(e);
  • // 使t指向尾节点,p指向t
  • for (Node<E> t = tail, p = t;;) {
  • // 获取p的后继为q
  • Node<E> q = p.next;
  • // 如果q为null
  • if (q == null) {
  • // p is last node
  • // 此时p是尾节点,直接将其后继设置为newNode
  • if (p.casNext(null, newNode)) {
  • // Successful CAS is the linearization point
  • // for e to become an element of this queue,
  • // and for newNode to become "live".
  • // 设置成功后检查p是否与t相等
  • if (p != t) // hop two nodes at a time
  • // 如果不等,就将tail设置为newNode
  • casTail(t, newNode); // Failure is OK.
  • // 返回true
  • return true;
  • }
  • // Lost CAS race to another thread; re-read next
  • }
  • else if (p == q)
  • // We have fallen off list. If tail is unchanged, it
  • // will also be off-list, in which case we need to
  • // jump to head, from which all live nodes are always
  • // reachable. Else the new tail is a better bet.
  • /**
  • * 此时代表p的next指向自己,即p其实是一个被移除的节点(可能是其他线程并发修改的)
  • * 因此尝试修改p的指向,如果tail修改了,就将p置为tail,否则将p置为head
  • * 然后重新开始下一个循环
  • */
  • p = (t != (t = tail)) ? t : head;
  • else
  • // Check for tail updates after two hops.
  • /**
  • * 如果q不等于null,且p不等于q,这时可能有其他的线程恰好抢先一步添加了一个节点
  • * 则判断p与t是否不同,即tail是否改变:
  • * 1. p与t相同,表示这是第一循环且t未改变,此时将q赋值给p,即后移;
  • * 2. p与t不同,但t未发生改变,说明p已经后移了,此时将q赋值给p,即继续后移;
  • * 3. p与t不同,且t发生了改变,即tail更新了,此时将p指向t(即新的tail,指向尾部是最优方式)
  • * 注意这里的t != (t = tail)的执行顺序:
  • * 1. 先取出左值t;
  • * 2,再执行右值的t = tail,此时t被设置为tail,但左值还是旧的t;
  • * 3,再比较左值旧的t和右值新的t。
  • * 然后重新开始下一个循环
  • */
  • p = (p != t && t != (t = tail)) ? t : q;
  • }
  • }

offer(E)方法的整体结构比较简单,但实现逻辑并不简单;最开始检查了传入的元素e的合法性,通过后根据e创建一个新的Node节点,接下来的内容是一个for循环,用于向链表尾部添加节点。下面是单线程添加多个元素的流程示意图:

2.ConcurrentLinkedQueue添加操作(单线程环境).png

从添加过程的演示可知,添加的过程就是向后查找最后一个节点,找到了就在该节点后面尝试添加新节点;添加过程中,tail指针的更新可能会滞后的,会存在新节点已经顺利添加到链表尾部了,但是tail指针并没有更新,依旧指向原来的旧节点。

单线程的添加过程其实是比较简单的,只要根据源码一步步模拟推进就可以得到相应的流程。但是在多线程并发添加的环境下,情况就会稍微复杂;下面是多线程添加多个元素的流程示意图:

3.ConcurrentLinkedQueue添加操作(多线程环境).png

多线程并发添加的过程中的无非多了多个线程对链表尾节点的后继进行更新的竞争,当出现竞争情况时,由于更新操作使用的是CAS方式,因此竞争失败的线程将更新自己的一些指针变量,然后在下一次循环再次尝试竞争并添加。

上述的多线程添加是其中的一种情况,下面我们考虑另一种情况,流程示意图如下:

4.ConcurrentLinkedQueue添加操作(多线程环境)另一种情况.png

这种并发情况下,最后更新的tail节点没有出现滞后情况,而前一种并发情况中,tail节点的更新其实出现了滞后。

其实在上面的三种流程演示中,并没有出现else if (p == q)这个分支的情况,从这个分支的判断条件就知道,p == q单纯在添加情况下是不会出现的,因为在同一个线程中,q总是p的后继节点,因此不可能出现p == q成立;这种情况只有在添加和获取并发操作的情况下出现,p == q意味着pnext指向了自己;这种情况会在后面的poll()操作中出现。

2.2. poll()方法

poll()方法是ConcurrentLinkedQueue的获取方法,用于从链表头获取一个节点,该方法的源码如下:

  • // 获取链表头元素
  • public E poll() {
  • restartFromHead:
  • for (;;) {
  • // h为head,p也为h,q为null
  • for (Node<E> h = head, p = h, q;;) {
  • // 获取p的item
  • E item = p.item;
  • // 判断p的item是否为null,如果不是就CAS方式设置为null
  • if (item != null && p.casItem(item, null)) {
  • // Successful CAS is the linearization point
  • // for item to be removed from this queue.
  • /**
  • * p的item不为null,且设置p的item为null成功
  • * 判断p是否还等于h
  • */
  • if (p != h) // hop two nodes at a time
  • /**
  • * 如果p不等于h
  • * 1. 如果p的后继为null,则将head修改为p
  • * 2. 如果p的后继不为null,则将head修改为p的后继
  • */
  • updateHead(h, ((q = p.next) != null) ? q : p);
  • // 返回item
  • return item;
  • } else if ((q = p.next) == null) {
  • /**
  • * 走到这里有两种情况:
  • * 1. p的item不为null,但设置p的item为null失败;
  • * 2. p的item为null
  • * 同时满足p的next为null,则更新head为p
  • * 如果条件满足,说明p已经是链表中最后一个节点了
  • */
  • updateHead(h, p);
  • // 返回null
  • return null;
  • } else if (p == q)
  • /**
  • * 走到这里有两种情况:
  • * 1. p的item不为null,但设置p的item为null失败;
  • * 2. p的item为null。
  • * 此时代表p的next指向自己,即p其实是一个被移除的节点(可能是其他线程并发修改的)
  • * 则continue重新开始外层循环
  • */
  • continue restartFromHead;
  • else
  • /**
  • * 走到这里有两种情况:
  • * 1. p的item不为null,但设置p的item为null失败,即有可能是其他线程抢先了;
  • * 2. p的item为null
  • * 同时满足p.next不为null,p不等于q,则将p置为q,即后移操作
  • */
  • p = q;
  • }
  • }
  • }

poll()方法的过程相较于offer(E)方法来说要更复杂一点,因为它涉及无效节点和head节点的维护,相关方法是updateHead(Node<E>, Node<E>),源码如下:

  • /**
  • * Try to CAS head to p. If successful, repoint old head to itself
  • * as sentinel for succ(), below.
  • *
  • * 更新head节点,设置成功后会将老的head节点的后继设置为自己
  • *
  • */
  • final void updateHead(Node<E> h, Node<E> p) {
  • // 检查h是否与p相同,不相同才设置h为p
  • if (h != p && casHead(h, p))
  • // 将h的后继设为自己
  • h.lazySetNext(h);
  • }

offer(E)方法一样,我们先演示单线程情况下poll()方法的运行流程:

5.ConcurrentLinkedQueue获取操作(单线程环境).png

单线程环境下获取操作的整体流程其实是相对简单的,无非就从链表头开始寻找第一个有效的节点,取出其item值,如果符合条件就尝试更新head节点,最后将获取的item值返回即可。多线程环境下,则会出现多种情况,下面是多线程环境下的添加操作:

6.ConcurrentLinkedQueue获取操作(多线程环境).png

多线程环境下涉及多个线程并发以CAS方式修改同一个节点的item,以及CAS方式更新head指针的指向,因此存在多种判断情况,但大体上的流程依旧是寻找第一个有效的节点,取出其item值,如果符合条件就尝试更新head节点,最后将获取的item值返回。

下面我们还需要讨论一种并发情况,即poll()操作和offer(E)操作并发执行,下面是流程示意图:

7.ConcurrentLinkedQueue添加操作下的并发获取(多线程环境).png

poll()操作和offer(E)操作并发执行的情况下,是会出现p == p,即pp.next相等的情况的,这是由于在poll()过程中会将无效节点的next指向自己。在offer(E)方法中针对这种情况对p指针进行了更新,以保证对尾节点的有效定位。

3. ConcurrentLinkedQueue示例

下面提供一个简单的ConcurrentLinkedQueue的示例:

  • package com.coderap.collection;
  • import java.util.Iterator;
  • import java.util.LinkedList;
  • import java.util.Queue;
  • import java.util.concurrent.ConcurrentLinkedQueue;
  • public class ConcurrentLinkedQueueTest {
  • // 循环次数
  • private final static int loopCount = 8;
  • // 操作的linkedList和concurrentLinkedQueue
  • private final static LinkedList<String> linkedList = new LinkedList<>();
  • private final static ConcurrentLinkedQueue<String> concurrentLinkedQueue = new ConcurrentLinkedQueue<>();
  • public static void main(String[] args) {
  • new Thread(new ConcurrentLinkedQueueTest.AddOperateThread(concurrentLinkedQueue, loopCount), "T-1").start();
  • new Thread(new ConcurrentLinkedQueueTest.PollOperateThread(concurrentLinkedQueue, loopCount), "T-2").start();
  • // new Thread(new ConcurrentLinkedQueueTest.AddOperateThread(linkedList, loopCount), "T-3").start();
  • // new Thread(new ConcurrentLinkedQueueTest.PollOperateThread(linkedList, loopCount), "T-4").start();
  • }
  • // 遍历方法
  • private static void iterate(Queue queue) {
  • StringBuilder stringBuilder = new StringBuilder();
  • Iterator iterator = queue.iterator();
  • while (iterator.hasNext()) {
  • stringBuilder.append(iterator.next());
  • stringBuilder.append(", ");
  • }
  • // 删除最后多余的字符
  • stringBuilder.delete(stringBuilder.length() - 2, stringBuilder.length() - 1);
  • // 打印
  • System.out.println(Thread.currentThread().getName() + " iterate: " + stringBuilder.toString());
  • }
  • private static class AddOperateThread implements Runnable {
  • private Queue queue;
  • private int loopCount;
  • public AddOperateThread(Queue queue, int loopCount) {
  • this.queue = queue;
  • this.loopCount = loopCount;
  • }
  • @Override
  • public void run() {
  • // 循环添加并遍历打印
  • while (loopCount > 0) {
  • queue.add(Thread.currentThread().getName() + " - " + loopCount);
  • iterate(queue);
  • loopCount--;
  • }
  • }
  • }
  • private static class PollOperateThread implements Runnable {
  • private Queue queue;
  • private int loopCount;
  • public PollOperateThread(Queue queue, int loopCount) {
  • this.queue = queue;
  • this.loopCount = loopCount;
  • }
  • @Override
  • public void run() {
  • // 循环添加并遍历打印
  • while (loopCount > 0) {
  • Object poll = queue.poll();
  • System.out.println(Thread.currentThread().getName() + " poll: " + poll);
  • loopCount--;
  • }
  • }
  • }
  • }

某一次运行结果如下:

  • T-1 iterate: T-1 - 8
  • T-1 iterate: T-1 - 8, T-1 - 7
  • T-1 iterate: T-1 - 8, T-1 - 7, T-1 - 6
  • T-1 iterate: T-1 - 8, T-1 - 7, T-1 - 6, T-1 - 5
  • T-1 iterate: T-1 - 7, T-1 - 6, T-1 - 5, T-1 - 4
  • T-2 poll: T-1 - 8
  • T-1 iterate: T-1 - 7, T-1 - 6, T-1 - 5, T-1 - 4, T-1 - 3
  • T-2 poll: T-1 - 7
  • T-1 iterate: T-1 - 6, T-1 - 5, T-1 - 4, T-1 - 3, T-1 - 2
  • T-2 poll: T-1 - 6
  • T-2 poll: T-1 - 5
  • T-1 iterate: T-1 - 5, T-1 - 4, T-1 - 3, T-1 - 2, T-1 - 1
  • T-2 poll: T-1 - 4
  • T-2 poll: T-1 - 3
  • T-2 poll: T-1 - 2
  • T-2 poll: T-1 - 1