【集合】LinkedList 源码分析

概述

LinkedList是一种可以在任何位置进行高效地插入和移除操作的有序序列，它是基于双向链表实现的。

继承关系

public class LinkedList<E>
    extends AbstractSequentialList<E>
    implements List<E>, Deque<E>, Cloneable, java.io.Serializable{
}

• 它是非同步的。
• 继承自AbstractSequentialList，可以被当作堆栈、队列或双端队列进行操作。
• 实现了List接口，能对它进行队列操作。
• 实现了Deque接口，能够被当作双端队列使用。
• 实现了Cloneable接口,覆盖了clone()方法，能被克隆。
• 实现了Serializable接口,支持序列化，能够通过序列化传输。

主要成员变量

/**
 * 实际元素个数
 */
transient int size = 0;

/**
 * 指向首节点
 */
transient Node<E> first;

/**
 * 指向最后一个节点
 */
transient Node<E> last;

构造函数

/**
 * 构建一个空列表
 */
public LinkedList() {
}

/**
 * 构建一个包含集合C的列表
 */
public LinkedList(Collection<? extends E> c) {
    // 调用无参构造
    this();
    // 添加集合中所有的元素
    addAll(c);
}

元素存储

/**
 * 在列表尾部插入元素
 */
public boolean add(E e) {
   linkLast(e);
   return true;
}

/**
 * 在指定索引位置之前插入元素
 */
public void add(int index, E element) {
   checkPositionIndex(index);

   if (index == size)
       linkLast(element);
   else
       linkBefore(element, node(index));
}

/**
 * 在列表首部插入节点e
 */
public void addFirst(E e) {
    linkFirst(e);
}

/**
 * 在列表尾部插入节点e
 */
public void addLast(E e) {
    linkLast(e);
}

/**
 * 将集合c中所有元素插入列表的尾部
 */
public boolean addAll(Collection<? extends E> c) {
   return addAll(size, c);
}

/**
 * 从指定的位置开始，将集合c中所有元素插入列表中
 */
public boolean addAll(int index, Collection<? extends E> c) {
   checkPositionIndex(index);

   Object[] a = c.toArray();
   int numNew = a.length;
   if (numNew == 0)
       return false;

   Node<E> pred, succ;
   if (index == size) {
       succ = null;
       pred = last;
   } else {
       succ = node(index);
       pred = succ.prev;
   }

   for (Object o : a) {
       @SuppressWarnings("unchecked") E e = (E) o;
       Node<E> newNode = new Node<>(pred, e, null);
       if (pred == null)
           first = newNode;
       else
           pred.next = newNode;
       pred = newNode;
   }

   if (succ == null) {
       last = pred;
   } else {
       pred.next = succ;
       succ.prev = pred;
   }

   size += numNew;
   modCount++;
   return true;
}

/**
 * 替换指定索引位置元素节点的元素值
 */
public E set(int index, E element) {
   checkElementIndex(index);
   Node<E> x = node(index);
   E oldVal = x.item;
   x.item = element;
   return oldVal;
}

/**
 * 将节点值为e的节点作为首节点
 */
private void linkFirst(E e) {
   final Node<E> f = first;
   final Node<E> newNode = new Node<>(null, e, f);
   first = newNode;
   if (f == null)
       last = newNode;
   else
       f.prev = newNode;
   size++;
   modCount++;
}

/**
 * 将节点值为e的节点作为最后一个节点
 */
void linkLast(E e) {
   final Node<E> l = last;
   final Node<E> newNode = new Node<>(l, e, null);
   last = newNode;
   if (l == null)
       first = newNode;
   else
       l.next = newNode;
   size++;
   modCount++;
}

/**
 * 在非空节点succ之前插入节点e
 */
void linkBefore(E e, Node<E> succ) {
   // assert succ != null;
   final Node<E> pred = succ.prev;
   final Node<E> newNode = new Node<>(pred, e, succ);
   succ.prev = newNode;
   if (pred == null)
       first = newNode;
   else
       pred.next = newNode;
   size++;
   modCount++;
}

读取元素

/**
 * 返回列表首节点元素值
 */
public E getFirst() {
   final Node<E> f = first;
   if (f == null)
       throw new NoSuchElementException();
   return f.item;
}

/**
 * 返回列表尾节点元素值
 */
public E getLast() {
   final Node<E> l = last;
   if (l == null)
       throw new NoSuchElementException();
   return l.item;
}

/**
 * 获取指定索引位置元素节点的元素值
 */
public E get(int index) {
    checkElementIndex(index);
    return node(index).item;
}

元素删除

/*
 * 删除元素为o的节点
 */
public boolean remove(Object o) {
    if (o == null) {
        for (Node<E> x = first; x != null; x = x.next) {
            if (x.item == null) {
                unlink(x);
                return true;
            }
        }
    } else {
        for (Node<E> x = first; x != null; x = x.next) {
            if (o.equals(x.item)) {
                unlink(x);
                return true;
            }
        }
    }
    return false;
}

/**
 * 删除首节点
 */
public E removeFirst() {
    final Node<E> f = first;
    if (f == null)
        throw new NoSuchElementException();
    return unlinkFirst(f);
}

/**
 * 删除最后一个节点
 */
public E removeLast() {
    final Node<E> l = last;
    if (l == null)
        throw new NoSuchElementException();
    return unlinkLast(l);
}

/**
 * 删除指定索引位置的元素值
 */
public E remove(int index) {
    checkElementIndex(index);
    return unlink(node(index));
}

/**
 * 删除列表中所有节点的元素
 */
public void clear() {
   // Clearing all of the links between nodes is "unnecessary", but:
   // - helps a generational GC if the discarded nodes inhabit
   //   more than one generation
   // - is sure to free memory even if there is a reachable Iterator
   for (Node<E> x = first; x != null; ) {
       Node<E> next = x.next;
       x.item = null;
       x.next = null;
       x.prev = null;
       x = next;
   }
   first = last = null;
   size = 0;
   modCount++;
}

/**
 * 释放非空的首节点
 */
private E unlinkFirst(Node<E> f) {
   // assert f == first && f != null;
   final E element = f.item;
   final Node<E> next = f.next;
   f.item = null;
   f.next = null; // help GC
   first = next;
   if (next == null)
       last = null;
   else
       next.prev = null;
   size--;
   modCount++;
   return element;
}

/**
 * 释放非空的尾节点
 */
private E unlinkLast(Node<E> l) {
   // assert l == last && l != null;
   final E element = l.item;
   final Node<E> prev = l.prev;
   l.item = null;
   l.prev = null; // help GC
   last = prev;
   if (prev == null)
       first = null;
   else
       prev.next = null;
   size--;
   modCount++;
   return element;
}

/**
 * 删除非空节点
 */
E unlink(Node<E> x) {
   // assert x != null;
   final E element = x.item;
   final Node<E> next = x.next;
   final Node<E> prev = x.prev;

   if (prev == null) {
       first = next;
   } else {
       prev.next = next;
       x.prev = null;
   }

   if (next == null) {
       last = prev;
   } else {
       next.prev = prev;
       x.next = null;
   }

   x.item = null;
   size--;
   modCount++;
   return element;
}