List接口下的集合源码分析——LinkedList

源码版本JDK1.8

今天带来的是List的另一种实现——LinkedList，这是一种基于双向链表实现的列表。接下来让我们通过源码来分析一下它吧。

关于源码中的一些小改动

在JDK1.6及之前，LinkedList底层是一个双向循环链表，容器中的元素都是静态内部类Entry的对象，列表中必有一个空头结点；
在JDK1.7及之后，LinkedList底层是一个双向非循环链表，容器中的元素都是静态内部类Node的对象。

• 使用非循环链表后，可以少一个空的头结点，在头尾加入元素时可以少一些引用操作（对于循环链表来说，由于首尾相连，还是需要处理两头的前驱和后继引用。而非循环链表只需要处理一边first.previous/last.next，所以理论上非循环链表更高效。恰恰在两头(链头/链尾) 操作是最普遍的）
• 对于Entry改变成Node，本质上是没有差别的。可能大家对Entry的印象是Map中实现的一个内部类，用来存储键值对(key,valu)，而在LinkedList中是要存储(previous,item,next)，不便于凸显Entry存储键值对的特性吧，容易造成混淆。（这只是个人的猜测，若有不同见解可以交流）

补充：不论是Entry还是Node，都是外部类LinkedList实现的一个静态内部类，这么做是把一个类相关的类型放到内部，提高类的高内聚，而且通常情况下只有该外部类会调用其内部类，如果把Entry或者Node放到外部，明显就提高了耦合性，对于其他集合类型的内部实现来说都是不利的。
再有一个，内部类会随着外部类的加载而产生。
传送门：关于静态内部类

一、LinkedList概述

在源码中对LinkedList是这么描述的：

• 双向链表实现 List和Deque接口。实现所有可选的列表操作，并允许所有元素null。
• 所有操作的执行方式与双向链表都是一样的。索引到列表中的操作将从开始或结束遍历列表，无论哪个更接近指定的索引。
• 此实现未同步。
  *此类的 iterator和listIterator方法返回的迭代器：如果在创建迭代器之后的任何时间对结构进行修改，除了通过迭代器自己的remove}或{@code add方法，迭代器将抛出一个ConcurrentModificationException。因此，面对并发修改，迭代器快速而干净地失败，而不是在将来的未确定时间冒任意的，非确定性行为的风险。

二、LinkedList的继承、实现关系

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

• 继承自AbstractSequentialList，而AbstractSequentialList父类为AbstractList，AbstractSequentialList 实现了get(int index)、set(int index, E element)、add(int index, E element) 和 remove(int index)这些骨干性函数。
• 实现List接口，能对它进行队列操作。
• 实现Deque接口，而Deque是Queue的子接口。Queue是一种队列形式，而Deque则是双向队列，它支持从两个端点方向检索和插入元素，因此Deque既可以支持LIFO形式也可以支持LIFO形式。Deque接口是一种比Stack和Vector更为丰富的抽象数据形式,因为它同时实现了以上两者。传送门：Deque双端队列
• 实现了Cloneable接口，即覆盖了函数clone()，能克隆。
• 实现java.io.Serializable接口，这意味着LinkedList支持序列化，能通过序列化去传输
  

三、LinkedList属性声明及构造函数

transient int size = 0;
transient Node<E> first;//指向第一个节点的指针
transient Node<E> last;//指向最后一个节点的指针

/构造一个空列表
public LinkedList() {
    }
//按照集合的迭代器返回的顺序构造包含指定集合的​​元素的列表
public LinkedList(Collection<? extends E> c) {
        this();
        addAll(c);
    }

—addAll()方法

public boolean addAll(Collection<? extends E> c) {
        return addAll(size, 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;
    }

带Collection值的构造方法的执行逻辑：
1）使用this（）调用默认的无参构造函数；
2）调用addAll（）方法，传入当前的节点个数size，此时size为0，并将collection对象传递进去；
3）检查index有没有数组越界的嫌疑；
4）将collection转换成数组对象a；
5）循环遍历a数组，然后将a数组里面的元素创建成拥有前后连接的节点，然后一个个按照顺序连起来；
6）修改当前的节点个数size的值；
7）操作次数modCount自增1。

四、LinkedList的方法

（一）添加元素

—在头部添加元素

//在此列表的开头插入指定的元素
public void addFirst(E e) {
        linkFirst(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++;
    }

linkFirst(E e)是一个私有方法，所以无法在外部程序中调用（当然，这是一般情况，你可以通过反射上面的还是能调用到的）。
linkFirst(E e)首先构造一个变量结点f = first，再 new一个newNode（为要添加进来的节点），其前驱引用previous为null，后继引用为f，再另头结点指向新的节点newNode。
判断，如果f == null，即列表为空，则头尾节点指向同一个节点newNode；如果不为空，原来头结点的前驱引用指向新节点newNode。
—在尾部添加元素

//将指定的元素追加到此列表的末尾
public void addLast(E e) {
        linkLast(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++;
    }

原理与在头部添加元素类似，可参照上面进行解读。
—在任意位置添加元素

// 在此列表中指定的位置插入指定的元素。将当前在该位置的元素(如果有)和任何后续元素向右移(将一个添加到它们的索引)
public void add(int index, E element) {
        checkPositionIndex(index);
        if (index == size)
            linkLast(element);
        else
            linkBefore(element, node(index));
    }
//在非空节点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++;
    }

从源码中看出，若索引index==size，便直接在尾部添加元素；若不是，则调用linkBefore(E e, Node succ)函数。
linkBefore(E e, Node succ)首先构造一个变量结点pred = succ.prev，再 new一个newNode（为要添加进来的节点），其前驱引用previous为pred ，后继引用为succ，再另结点succ的前驱指向新的节点newNode。
判断，如果pred == null，即列表为空，则头尾节点指向同一个节点newNode；如果不为空，原来pred结点的后继引用指向新节点newNode。

（二）查看元素

查看元素使用get方法。getFirst()、getLast()分别返回头结点和尾节点。下面主要看看返回指定索引的方法get(int index)。

//返回此列表中指定位置的元素
public E get(int index) {
        checkElementIndex(index);
        return node(index).item;
    }
private void checkElementIndex(int index) {
        if (!isElementIndex(index))
            throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
    }
 private boolean isElementIndex(int index) {
        return index >= 0 && index < size;
    }
//返回指定元素索引处的(非空)节点
Node<E> node(int index) {
        // assert isElementIndex(index);
        if (index < (size >> 1)) {
            Node<E> x = first;
            for (int i = 0; i < index; i++)
                x = x.next;
            return x;
        } else {
            Node<E> x = last;
            for (int i = size - 1; i > index; i--)
                x = x.prev;
            return x;
        }
    }

get(int index)首先判断给定索引是否存在，若存在执行node(index).item;其中item为元素的内容。
node(int index)方法返回的是一个节点Node，代码中使用了类似二分法的查找方法来遍历元素。若index < (size >> 1)，即索引在前半部分，则从前向后依次查找；否则索引就在后半部分，从后向前依次查找。
此段代码能够有效的提高遍历效率，也反映了双向链表的优点——双向链表增加了一点点的空间消耗（每个Node里面还要维护它的前置Node的引用），同时也增加了一定的编程复杂度，却大大提升了遍历效率（体现在可以双向遍历）。

（三）删除元素

removeFirst()，removeLast()分别用来删除头结点和尾结点，public E remove()方法删除的也是列表的第一个元素，但是列表为空时使用不会抛出异常（removeFirst()会抛出异常）。
和ArrayList一样，LinkedList支持按元素删除和按下标删除,下面我们主要介绍public E remove(int index)，public boolean remove(Object o)

//删除此列表中指定位置的元素。将任何后续元素向左移(从它们的索引中减去一个)。返回从列表中删除的元素
public E remove(int index) {
        checkElementIndex(index);
        return unlink(node(index));
    }
//取消链接非空节点x
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;
    }

按索引删除remove(int index)：
首先通过遍历node(index)得到指定索引的节点，后通过unlink()方法进行删除。
(1)x.prev = null;//前驱设置为null
(2)x.next = null;//后继设置为null
(3)x.item = null;//内容设置为null
至此节点x为空节点，最后交给虚拟机gc完成回收，删除操作结束。

//从列表中删除指定元素的第一次出现(如果存在)。如果此列表不包含元素,则不会更改。
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;
    }

按元素删除内容remove(Object o)：
不论元素内容为空还是不为空，均通过节点的遍历，依次查找，若找到与指定内容一致的节点则删除并返回。

注意：该方法从列表中删除第一次出现的指定元素。

LinkedList的方法比较简单，没有扩容环节，翻阅源码基本能懂，不存在什么大问题。由于LinkedList实现了Deque接口，该接口比List提供了更多的方法，包括 offer()，peek()，poll()等。

//检索,但不删除此列表的头(第一个元素)
public E peek() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
    }
//检索并删除此列表的头(第一个元素)
public E poll() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }
//检索但不删除此列表的第一个元素,如果此列表为空,则返回null
public E peekFirst() {
        final Node<E> f = first;
        return (f == null) ? null : f.item;
     }
//检索但不删除此列表的最后一个元素,如果此列表为空,则返回null
public E peekLast() {
        final Node<E> l = last;
        return (l == null) ? null : l.item;
    }
//检索并删除此列表的第一个元素,如果此列表为空,则返回null
public E pollFirst() {
        final Node<E> f = first;
        return (f == null) ? null : unlinkFirst(f);
    }
//检索并删除此列表的最后一个元素,如果此列表为空,则返回null
public E pollLast() {
        final Node<E> l = last;
        return (l == null) ? null : unlinkLast(l);
    }
//将指定的元素添加为此列表的尾部(最后一个元素)
public boolean offer(E e) {
        return add(e);
    }
//在此列表的前面插入指定的元素
public boolean offerFirst(E e) {
        addFirst(e);
        return true;
    }
//在此列表的结尾插入指定的元素
public boolean offerLast(E e) {
        addLast(e);
        return true;
    }
//将元素推送到此列表所表示的堆栈。换句话说,将元素插入此列表的前面,此方法等效于addFirst
public void push(E e) {
        addFirst(e);
    }
//此列表所表示的堆栈中弹出一个元素。换句话说,删除并返回此列表的第一个元素,此方法等效于removeFirst()
public E pop() {
        return removeFirst();
    }

五、ArrayList与LinkedList的区别

（一）从插入、删除元素分析

对于两者的插入、删除操作不能片面的盖棺定论，应视情况而定，下面以插入操作做分析（删除操作的分析类似）
顺序插入：
* ArrayList在不扩容的情况下顺序插入速度较快，因为在构造ArrayList之前已经分配好空间，顺序插入元素只是往指定内存空间补个元素；在需要扩容的情况下，ArrayList的顺序插入则显得比较慢，因为底层需要执行copy操作，既耗时又耗空间。
* LinkedList顺序添加元素会教慢点，因为每添加一个元素都要新new一个节点对象，并且还有执行其他的引用赋值操作。

中间插入：
* ArrayList在执行中间插入的过程中耗时的是索引后面的元素copy移动，若果插入的位置越靠前则越慢，反之越快。
* LinkedList在任何位置插入的效率基本上是一致的，耗时的部分主要是定位索引（寻址），赋值部分只需修改引用。

综合以上所述：
（1）LinkedList做插入、删除的时候，慢在寻址，快在只需要改变前后Node的引用地址。
（2）ArrayList做插入、删除的时候，慢在数组元素的批量copy，快在寻址。

所以，如果待插入、删除的元素是在数据结构的前半段尤其是非常靠前的位置的时候，LinkedList的效率将大大快过ArrayList，因为ArrayList将批量copy大量的元素；越往后，对于LinkedList来说，因为它是双向链表，所以在第2个元素后面插入一个数据和在倒数第2个元素后面插入一个元素在效率上基本没有差别，但是ArrayList由于要批量copy的元素越来越少，操作速度必然追上乃至超过LinkedList。

（二）从遍历列表分析

未完待续。。。